snippets.generators.elements.variable.Variable Class Reference

List of all members.

Public Member Functions
def	__init__
def	from_xml
Public Attributes
	bits
	cond
	default
	max
	min
	name
	quant
	type
Static Private Attributes
string	_XMLTAG = 'var'

---

Detailed Description

Represents the C++ data member/variable in the object form.

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

Definition at line 38 of file elements/variable.py.

---

Constructor & Destructor Documentation

def snippets.generators.elements.variable.Variable.__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 variable
type    -- type name of the variable
Optional attributes:
bits - number of bits that should be reserved for the variable
min - minimal value of the variable
max - maximal value of the variable
quant - the quantization of the variable
cond - conditional serialization (will be serialized only when the value is True)
default - the default value of the variable

Definition at line 47 of file elements/variable.py.

---

Member Function Documentation

def snippets.generators.elements.variable.Variable.from_xml	(		self,
			xmlnode
	)

Extracts the variable attributes from the XML node.

xmlnode -- the XML node with the member definition

Definition at line 76 of file elements/variable.py.

---

Member Data Documentation

string snippets::generators::elements::variable.Variable::_XMLTAG = 'var' [static, private]

Definition at line 45 of file elements/variable.py.

snippets::generators::elements::variable.Variable::bits

Definition at line 63 of file elements/variable.py.

snippets::generators::elements::variable.Variable::cond

Definition at line 63 of file elements/variable.py.

snippets::generators::elements::variable.Variable::default

Definition at line 63 of file elements/variable.py.

snippets::generators::elements::variable.Variable::max

Definition at line 63 of file elements/variable.py.

snippets::generators::elements::variable.Variable::min

Definition at line 63 of file elements/variable.py.

snippets::generators::elements::variable.Variable::name

Definition at line 63 of file elements/variable.py.

snippets::generators::elements::variable.Variable::quant

Definition at line 63 of file elements/variable.py.

snippets::generators::elements::variable.Variable::type

Definition at line 63 of file elements/variable.py.

---

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

• elements/variable.py