snippets.generators.elements.function.Function Class Reference

List of all members.

Public Member Functions
def	__init__
def	from_xml
Public Attributes
	args
	body
	inline
	name
	qual
	ret
	static
Static Private Attributes
string	_XMLTAG = 'fun'

---

Detailed Description

Represents the C++ function in the object form.

Class attributes:
_XMLTAG -- constant string with the xml tag description

Definition at line 39 of file elements/function.py.

---

Constructor & Destructor Documentation

def snippets.generators.elements.function.Function.__init__	(		self,
			xmlnode = None
	)

Populates the variable from a XML node info.
When the XML node is not defined, does nothing.

xmlnode -- the XML node with the member definition
    
Required attributes:
name -- name of the function
Optional attributes:
ret -- the return type
inline -- flag if the function is to be inlined
qual -- the qualifer of the functon

Definition at line 48 of file elements/function.py.

---

Member Function Documentation

def snippets.generators.elements.function.Function.from_xml	(		self,
			xmlnode
	)

Extracts the variable attributes from the XML node.

xmlnode -- the XML node with the member definition

Definition at line 73 of file elements/function.py.

---

Member Data Documentation

string snippets::generators::elements::function.Function::_XMLTAG = 'fun' [static, private]

Definition at line 46 of file elements/function.py.

snippets::generators::elements::function.Function::args

Definition at line 60 of file elements/function.py.

snippets::generators::elements::function.Function::body

Definition at line 60 of file elements/function.py.

snippets::generators::elements::function.Function::inline

Definition at line 60 of file elements/function.py.

snippets::generators::elements::function.Function::name

Definition at line 60 of file elements/function.py.

snippets::generators::elements::function.Function::qual

Definition at line 60 of file elements/function.py.

snippets::generators::elements::function.Function::ret

Definition at line 60 of file elements/function.py.

snippets::generators::elements::function.Function::static

Definition at line 60 of file elements/function.py.

---

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

• elements/function.py