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

XML interface base class All not implemented methods have to be overloaded by the derived class!! More...

List of all members.

Public Member Functions

def __init__
def createXmlTree
def getXmlIfType
def parse
def parseString
def setElementWrapperClass
def setTreeWrapperClass

Public Attributes

 elementWrapperClass
 processXInclude
 treeWrapperClass
 useCaching
 verbose

Detailed Description

XML interface base class All not implemented methods have to be overloaded by the derived class!!

XML interface base class.

All not implemented methods have to be overloaded by the derived class!!

Definition at line 58 of file xmlifApi.py.


Constructor & Destructor Documentation

def pymavlink.generator.lib.genxmlif.xmlifApi.XmlInterfaceBase.__init__ (   self,
  verbose,
  useCaching,
  processXInclude 
)
Constructor of class XmlInterfaceBase.

Input parameter:
    'verbose':         0 or 1: controls verbose print output for module genxmlif
    'useCaching':      0 or 1: controls usage of caching for module genxmlif
    'processXInclude': 0 or 1: controls XInclude processing during parsing

Definition at line 64 of file xmlifApi.py.


Member Function Documentation

def pymavlink.generator.lib.genxmlif.xmlifApi.XmlInterfaceBase.createXmlTree (   self,
  namespace,
  xmlRootTagName,
  attributeDict = {},
  publicId = None,
  systemId = None 
)
Create a new XML TreeWrapper object (wrapper for DOM document or elementtree).

Input parameter:
    'namespace':      not yet handled (for future use)
    'xmlRootTagName': specifies the tag name of the root element
    'attributeDict':  contains the attributes of the root node (optional)
    'publicId':       forwarded to contained DOM tree (unused for elementtree)
    'systemId':       forwarded to contained DOM tree (unused for elementtree)
Returns the created XML tree wrapper object.
Method has to be implemented by derived classes!

Definition at line 82 of file xmlifApi.py.

Retrieve the type of the XML interface.

Definition at line 143 of file xmlifApi.py.

def pymavlink.generator.lib.genxmlif.xmlifApi.XmlInterfaceBase.parse (   self,
  filePath,
  baseUrl = "",
  ownerDoc = None 
)
Call the XML parser for 'file'.

Input parameter:
    'filePath': a file path or an URI
    'baseUrl':  if specified, it is used e.g. as base path for schema files referenced inside the XML file.
    'ownerDoc': only used in case of 4DOM (forwarded to 4DOM parser). 
Returns the respective XML tree wrapper object for the parsed XML file.
Method has to be implemented by derived classes!

Definition at line 98 of file xmlifApi.py.

def pymavlink.generator.lib.genxmlif.xmlifApi.XmlInterfaceBase.parseString (   self,
  text,
  baseUrl = "",
  ownerDoc = None 
)
Call the XML parser for 'text'.

Input parameter:
    'text':     contains the XML string to be parsed
    'baseUrl':  if specified, it is used e.g. as base path for schema files referenced inside the XML string.
    'ownerDoc': only used in case of 4DOM (forwarded to 4DOM parser). 
Returns the respective XML tree wrapper object for the parsed XML 'text' string.
Method has to be implemented by derived classes!

Definition at line 112 of file xmlifApi.py.

Set the element wrapper classes which shall be used by this interface.

Input parameter:
    elementWrapperClass:  element wrapper class

Definition at line 134 of file xmlifApi.py.

Set the tree wrapper class which shall be used by this interface.

Input parameter:
    treeWrapperClass:     tree wrapper class

Definition at line 125 of file xmlifApi.py.


Member Data Documentation

Definition at line 138 of file xmlifApi.py.

Definition at line 70 of file xmlifApi.py.

Definition at line 129 of file xmlifApi.py.

Definition at line 70 of file xmlifApi.py.

Definition at line 70 of file xmlifApi.py.


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


mavlink
Author(s): Lorenz Meier
autogenerated on Wed Sep 9 2015 18:06:18