Virtual Belgium  2.0
A micro-simulation platform for the Belgian population
 All Classes Namespaces Files Functions Variables Typedefs Enumerator Friends Macros Pages
tinyxml2::XMLComment Class Reference

#include <tinyxml2.hpp>

Public Member Functions

virtual XMLComment * ToComment ()
 Safely cast to a Comment, or null. More...
 
virtual const XMLComment * ToComment () const
 
virtual bool accept (XMLVisitor *visitor) const
 
char * parseDeep (char *, StrPair *endTag)
 
virtual XMLNode * shallowClone (XMLDocument *document) const
 
virtual bool shallowEqual (const XMLNode *compare) const
 
- Public Member Functions inherited from tinyxml2::XMLNode
const XMLDocument * GetDocument () const
 Get the XMLDocument that owns this XMLNode. More...
 
XMLDocument * GetDocument ()
 Get the XMLDocument that owns this XMLNode. More...
 
virtual XMLElement * ToElement ()
 Safely cast to an Element, or null. More...
 
virtual XMLText * ToText ()
 Safely cast to Text, or null. More...
 
virtual XMLDocument * ToDocument ()
 Safely cast to a Document, or null. More...
 
virtual XMLDeclaration * ToDeclaration ()
 Safely cast to a Declaration, or null. More...
 
virtual XMLUnknown * ToUnknown ()
 Safely cast to an Unknown, or null. More...
 
virtual const XMLElement * ToElement () const
 
virtual const XMLText * ToText () const
 
virtual const XMLDocument * ToDocument () const
 
virtual const XMLDeclaration * ToDeclaration () const
 
virtual const XMLUnknown * ToUnknown () const
 
const char * Value () const
 
void setValue (const char *val, bool staticMem=false)
 
const XMLNode * Parent () const
 Get the parent of this node on the DOM. More...
 
XMLNode * Parent ()
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
const XMLNode * FirstChild () const
 Get the first child node, or null if none exists. More...
 
XMLNode * FirstChild ()
 
const XMLElement * firstChildElement (const char *value=0) const
 
XMLElement * FirstChildElement (const char *_value=0)
 
const XMLNode * LastChild () const
 Get the last child node, or null if none exists. More...
 
XMLNode * LastChild ()
 
const XMLElement * lastChildElement (const char *value=0) const
 
XMLElement * LastChildElement (const char *_value=0)
 
const XMLNode * PreviousSibling () const
 Get the previous (left) sibling node of this node. More...
 
XMLNode * PreviousSibling ()
 
const XMLElement * previousSiblingElement (const char *value=0) const
 Get the previous (left) sibling element of this node, with an opitionally supplied name. More...
 
XMLElement * PreviousSiblingElement (const char *_value=0)
 
const XMLNode * NextSibling () const
 Get the next (right) sibling node of this node. More...
 
XMLNode * NextSibling ()
 
const XMLElement * nextSiblingElement (const char *value=0) const
 Get the next (right) sibling element of this node, with an opitionally supplied name. More...
 
XMLElement * NextSiblingElement (const char *_value=0)
 
XMLNode * insertEndChild (XMLNode *addThis)
 
XMLNode * LinkEndChild (XMLNode *addThis)
 
XMLNode * insertFirstChild (XMLNode *addThis)
 
XMLNode * insertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 
void deleteChildren ()
 
void deleteChild (XMLNode *node)
 

Protected Member Functions

 XMLComment (XMLDocument *doc)
 
virtual ~XMLComment ()
 
 XMLComment (const XMLComment &)
 
XMLComment & operator= (const XMLComment &)
 
- Protected Member Functions inherited from tinyxml2::XMLNode
 XMLNode (XMLDocument *)
 
virtual ~XMLNode ()
 
 XMLNode (const XMLNode &)
 
XMLNode & operator= (const XMLNode &)
 

Friends

class XMLDocument
 

Additional Inherited Members

- Protected Attributes inherited from tinyxml2::XMLNode
XMLDocument * document
 
XMLNode * parent
 
StrPair value
 
XMLNode * firstChild
 
XMLNode * lastChild
 
XMLNode * prev
 
XMLNode * next
 

Detailed Description

An XML Comment.

Constructor & Destructor Documentation

XMLComment::XMLComment ( XMLDocument *  doc)
protected
XMLComment::~XMLComment ( )
protectedvirtual
tinyxml2::XMLComment::XMLComment ( const XMLComment &  )
protected

Member Function Documentation

bool XMLComment::accept ( XMLVisitor *  visitor) const
virtual

Accept a hierarchical visit of the nodes in the TinyXML DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the TiXmlVisitor interface.

This is essentially a SAX interface for TinyXML. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML is unchanged by using this interface versus any other.)

The interface has been based on ideas from:

Which are both good references for "visiting".

An example of using Accept():

    TiXmlPrinter printer;
    tinyxmlDoc.Accept( &printer );
    const char* xmlcstr = printer.CStr();

Implements tinyxml2::XMLNode.

XMLComment& tinyxml2::XMLComment::operator= ( const XMLComment &  )
protected
char * XMLComment::parseDeep ( char *  p,
StrPair *  endTag 
)
virtual

Reimplemented from tinyxml2::XMLNode.

XMLNode * XMLComment::shallowClone ( XMLDocument *  document) const
virtual

Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())

Note: if called on a XMLDocument, this will return null.

Implements tinyxml2::XMLNode.

bool XMLComment::shallowEqual ( const XMLNode *  compare) const
virtual

Test if 2 nodes are the same, but don't test children. The 2 nodes do not need to be in the same Document.

Note: if called on a XMLDocument, this will return false.

Implements tinyxml2::XMLNode.

virtual XMLComment* tinyxml2::XMLComment::ToComment ( )
inlinevirtual

Safely cast to a Comment, or null.

Reimplemented from tinyxml2::XMLNode.

virtual const XMLComment* tinyxml2::XMLComment::ToComment ( ) const
inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Friends And Related Function Documentation

friend class XMLDocument
friend

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