snippets.generators.cppgen.enum.Enum Class Reference

List of all members.

Public Member Functions
def	__init__
def	__str__
def	from_xml
def	gen_code
Public Attributes
	ename
	evalue
Static Private Attributes
string	_XMLTAG = 'enum'

---

Detailed Description

Represents the C++ data enumeration in the object form.

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

Definition at line 38 of file cppgen/enum.py.

---

Constructor & Destructor Documentation

def snippets.generators.cppgen.enum.Enum.__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
    
Instance attributes:
ename -- name of the enumerator
evalue -- value of the enumerator

Definition at line 47 of file cppgen/enum.py.

---

Member Function Documentation

def snippets.generators.cppgen.enum.Enum.__str__

(

self

)

Overriden string specifier returns the C++ code snippet 
without indentation.

Definition at line 90 of file cppgen/enum.py.

def snippets.generators.cppgen.enum.Enum.from_xml	(		self,
			xmlnode
	)

Extracts the enum attributes from the XML node.

xmlnode -- the XML node with the member definition

Definition at line 63 of file cppgen/enum.py.

def snippets.generators.cppgen.enum.Enum.gen_code	(		self,
			bindent = '',
			indent = '  '
	)

Generates the full member definition C++ code and
returns it as a string

bindent -- the current indent in the document
indent -- the usual minimum indentation

Definition at line 79 of file cppgen/enum.py.

---

Member Data Documentation

string snippets::generators::cppgen::enum.Enum::_XMLTAG = 'enum' [static, private]

Definition at line 45 of file cppgen/enum.py.

snippets::generators::cppgen::enum.Enum::ename

Definition at line 56 of file cppgen/enum.py.

snippets::generators::cppgen::enum.Enum::evalue

Definition at line 56 of file cppgen/enum.py.

---

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

• cppgen/enum.py