data_structures.Parameter Class Reference

One function Parameter. More...

Public Member Functions
def	__init__
	Initialize self from the XML in parameter_element.
def	__format__
	Return a formated string for self using fmt for format control.

Detailed Description

One function Parameter.

This class corresponds to a one function parameter. It corrsponds to the following XML:

   <Parameter Name="..." Type="..." Brief="..."> 

Constructor & Destructor Documentation

def data_structures.Parameter.__init__	(		self,
			parameter_element,
			style
	)

Initialize self from the XML in parameter_element.

Parameters

self	Parameter to initialize
parameter_element	ET.Element to extract XML from
style	Style object that specifies how to format generate code.

This method will initialize self from the XML in parameter_element.

Member Function Documentation

def data_structures.Parameter.__format__	(		self,
			fmt
	)

Return a formated string for self using fmt for format control.

Parameters

self	Parameter to format
fmt	str that contains format control information

This method will format self using fmt for format control. fmt must be one of the following:

• 't' return the type of self
• 'n' return the name of self
• 'c' return the C/C++ type of self (i.e. "Type Name")

---

The documentation for this class was generated from the following file:

• data_structures.py