carputils.cml.cmltree.CMLDictBranch Class Reference

Class defining a dict-branch object. More...

Inheritance diagram for carputils.cml.cmltree.CMLDictBranch:

Public Member Functions
def	__init__ (self, parent, key)
	Method to initialize a CMLDictBranch object. More...
def	add_child (self, node)
	Add child node. More...
def	serialize (self)
	Serialize node and all child nodes. More...
def	objectify (self)
	Objectify node and all child nodes. More...
Public Member Functions inherited from carputils.cml.cmltree.CMLNode
def	__init__ (self, parent, key)
	Method to initialize a CMLNode object. More...
def	add_child (self, node)
	Add child node. More...
def	serialize (self)
	Serialize node and all child nodes. More...
def	objectify (self)
	Objectify node and all child nodes. More...

Static Public Member Functions
def	from_node (node)
	Method to create a CMLDictBranch object. More...

Public Attributes
	children
	list to hold the children More...
Public Attributes inherited from carputils.cml.cmltree.CMLNode
	parent
	parent node More...
	level
	level of the node More...
	index
	index of the node in the parent's child collection More...
	key
	key of the node (string or None) More...

Additional Inherited Members
Properties inherited from carputils.cml.cmltree.CMLNode
	has_key = property
	Check if the CML-Node has a valid key. More...

Detailed Description

Class defining a dict-branch object.

CMLDictBranch are nodes which can hold several CMLNodes as children.

Constructor & Destructor Documentation

__init__()

def carputils.cml.cmltree.CMLDictBranch.__init__	(		self,
			parent,
			key
	)

Method to initialize a CMLDictBranch object.

Parameters

parent	Parent node
key	Key string or None

Member Function Documentation

add_child()

def carputils.cml.cmltree.CMLDictBranch.add_child	(		self,
			node
	)

Add child node.

Parameters

node	child node

Exceptions

AttributeError	if node is not an instance of CMLNode
AttributeError

from_node()

def carputils.cml.cmltree.CMLDictBranch.from_node (   node )

static

Method to create a CMLDictBranch object.

A CMLDictBranch object is created from a CMLNode object.

Parameters

node	Placeholder node

Exceptions

AttributeError

if node is not an instance of CMLNode

Returns

The CMLDictBranch object created

objectify()

def carputils.cml.cmltree.CMLDictBranch.objectify

(

self

)

Objectify node and all child nodes.

Returns

If the key of the node is None, a CMLNamespace with all child nodes as attributes is returned, else a list containing the key and the CMLNamespace with all child nodes as attributes is returned

serialize()

def carputils.cml.cmltree.CMLDictBranch.serialize

(

self

)

Serialize node and all child nodes.

Returns

If the key of the node is None, a dictionary of all serialized child nodes as value is returned, else a list containing the key and the dictionary of all serialized child nodes as value is returned

Member Data Documentation

children

carputils.cml.cmltree.CMLDictBranch.children

list to hold the children

---

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

• carputils/cml/cmltree.py