XMLOBJECT Class Reference

Base interface class for objects represented as XML. More...

#include <mi32/xmlobject.h>

List of all members.

Public Member Functions

 XMLOBJECT ()
virtual ~XMLOBJECT ()=0
ERRVALUE XmlGet (XMLDOC &doc, const char *rootTagName=0) const
ERRVALUE XmlGet (XMLNODE *nodeParent, XMLNODE *&nodeObject, const char *nodeTagName=0) const
ERRVALUE XmlGet (XMLNODE *nodeParent, const char *nodeTagName=0) const
ERRVALUE XmlSet (const XMLNODE *nodeObject)

Private Member Functions

virtual ERRVALUE v_XmlGet (XMLNODE *nodeObject) const =0
virtual const char * v_XmlGetTagName () const =0
virtual ERRVALUE v_XmlSet (const XMLNODE *nodeObject)=0

Detailed Description

Base interface class for objects represented as XML.


Constructor & Destructor Documentation

XMLOBJECT::XMLOBJECT (  ) 
virtual XMLOBJECT::~XMLOBJECT (  )  [pure virtual]

Member Function Documentation

virtual ERRVALUE XMLOBJECT::v_XmlGet ( XMLNODE nodeObject  )  const [private, pure virtual]

Get contents into XMLNODE.

Parameters:
nodeObject Node associated with object
virtual const char* XMLOBJECT::v_XmlGetTagName (  )  const [private, pure virtual]

Get XML tagname to use if not otherwise specified.

virtual ERRVALUE XMLOBJECT::v_XmlSet ( const XMLNODE nodeObject  )  [private, pure virtual]

Set contents from XMLNODE.

Parameters:
nodeObject Node associated with object
ERRVALUE XMLOBJECT::XmlGet ( XMLDOC doc,
const char *  rootTagName = 0 
) const

Get contents into XMLDOC.

Parameters:
rootTagName Root node tagname, 0 to use value from v_XmlGetTagName
ERRVALUE XMLOBJECT::XmlGet ( XMLNODE nodeParent,
XMLNODE *&  nodeObject,
const char *  nodeTagName = 0 
) const

Get contents into new child XMLNODE.

Parameters:
nodeParent Parent node
nodeObject New child node associated with object returned
nodeTagName Child node tagname, 0 to use value from v_XmlGetTagName
ERRVALUE XMLOBJECT::XmlGet ( XMLNODE nodeParent,
const char *  nodeTagName = 0 
) const

Get contents into new child XMLNODE.

Parameters:
nodeParent Parent node
nodeTagName Child node tagname, 0 to use value from v_XmlGetTagName
ERRVALUE XMLOBJECT::XmlSet ( const XMLNODE nodeObject  ) 

Set contents from XMLNODE.

Parameters:
nodeObject Node associated with object, to set contents from

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

Generated on Sun Oct 7 21:34:02 2012 for TNTsdk 2012 by  doxygen 1.6.1