Public Member Functions | Public Attributes | Private Attributes
pymavlink.generator.lib.genxmlif.xmlifApi.XmlTreeWrapper Class Reference

List of all members.

Public Member Functions

def __init__
def __str__
def cloneTree
def createElement
def getRootNode
def getTree
def printTree
def setExternalCacheUsage
def unlink
def useCaching

Public Attributes


Private Attributes


Detailed Description

XML tree wrapper API.

Contains a DOM tree or an elementtree (depending on used XML parser)

Definition at line 152 of file

Constructor & Destructor Documentation

def pymavlink.generator.lib.genxmlif.xmlifApi.XmlTreeWrapper.__init__ (   self,
Constructor of wrapper class XmlTreeWrapper.

Input parameter:
    'xmlIf':      used XML interface class
    'tree':       DOM tree or elementtree which is wrapped by this object
    'useCaching': 1 if caching shall be used inside genxmlif, otherwise 0

Definition at line 158 of file

Member Function Documentation

Return the string representation of the contained XML tree.

Definition at line 253 of file

Creates a copy of a whole XML DOM tree.

Definition at line 186 of file

def pymavlink.generator.lib.genxmlif.xmlifApi.XmlTreeWrapper.createElement (   self,
  attributeDict = None,
  curNs = [] 
Create an ElementWrapper object.

Input parameter:
    tupleOrLocalName: tag name of element node to be created 
              (tuple of namespace and localName or only localName if no namespace is used)
    attributeDict:    attributes for this elements
    curNs:            namespaces for scope of this element
Returns an ElementWrapper object containing the created element node.

Definition at line 171 of file

Retrieve the wrapper object of the root element of the contained XML tree.

Returns the ElementWrapper object of the root element.

Definition at line 197 of file

Retrieve the contained XML tree.

Returns the contained XML tree object (internal DOM tree wrapper or elementtree).

Definition at line 205 of file

def pymavlink.generator.lib.genxmlif.xmlifApi.XmlTreeWrapper.printTree (   self,
  prettyPrint = 0,
  printElementValue = 1,
  encoding = None 
Return the string representation of the contained XML tree.

Input parameter:
    'prettyPrint':        aligns the columns of the attributes of childNodes
    'printElementValue':  controls if the lement values are printed or not.
Returns a string with the string representation of the whole XML tree.

Definition at line 213 of file

Set external cache usage for the whole tree
   unlink commands are ignored if used by an external cache

   Input parameter:
       used:       0 or 1 (used by external cache)

Definition at line 235 of file

Break circular references of the complete XML tree.

To be called if the XML tree is not longer used => garbage collection!

Definition at line 245 of file

Return 1 if caching should be used for the contained XML tree.

Definition at line 230 of file

Member Data Documentation

Definition at line 164 of file

Definition at line 164 of file

Definition at line 164 of file

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

Author(s): Lorenz Meier
autogenerated on Sun May 22 2016 04:05:44