NumeRe v1.1.4
NumeRe: Framework für Numerische Rechnungen
tinyxml2::XMLComment Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLComment:
Collaboration diagram for tinyxml2::XMLComment:

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
 
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 XMLComment * ToComment ()
 Safely cast to a Comment, 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 XMLComment * ToComment () 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)
 
int GetLineNum () const
 Gets the line number the node is in, if the document was parsed from a file. More...
 
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 *name=0) const
 
XMLElement * FirstChildElement (const char *name=0)
 
const XMLNode * LastChild () const
 Get the last child node, or null if none exists. More...
 
XMLNode * LastChild ()
 
const XMLElement * LastChildElement (const char *name=0) const
 
XMLElement * LastChildElement (const char *name=0)
 
const XMLNode * PreviousSibling () const
 Get the previous (left) sibling node of this node. More...
 
XMLNode * PreviousSibling ()
 
const XMLElement * PreviousSiblingElement (const char *name=0) const
 Get the previous (left) sibling element of this node, with an optionally supplied name. More...
 
XMLElement * PreviousSiblingElement (const char *name=0)
 
const XMLNode * NextSibling () const
 Get the next (right) sibling node of this node. More...
 
XMLNode * NextSibling ()
 
const XMLElement * NextSiblingElement (const char *name=0) const
 Get the next (right) sibling element of this node, with an optionally supplied name. More...
 
XMLElement * NextSiblingElement (const char *name=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)
 
virtual XMLNode * ShallowClone (XMLDocument *document) const =0
 
XMLNode * DeepClone (XMLDocument *target) const
 
virtual bool ShallowEqual (const XMLNode *compare) const =0
 
virtual bool Accept (XMLVisitor *visitor) const =0
 
void SetUserData (void *userData)
 
void * GetUserData () const
 

Protected Member Functions

 XMLComment (XMLDocument *doc)
 
virtual ~XMLComment ()
 
char * ParseDeep (char *p, StrPair *parentEndTag, int *curLineNumPtr)
 
- Protected Member Functions inherited from tinyxml2::XMLNode
 XMLNode (XMLDocument *)
 
virtual ~XMLNode ()
 
virtual char * ParseDeep (char *p, StrPair *parentEndTag, int *curLineNumPtr)
 

Private Member Functions

 XMLComment (const XMLComment &)
 
XMLComment & operator= (const XMLComment &)
 

Friends

class XMLDocument
 

Additional Inherited Members

- Protected Attributes inherited from tinyxml2::XMLNode
XMLDocument * _document
 
XMLNode * _parent
 
StrPair _value
 
int _parseLineNum
 
XMLNode * _firstChild
 
XMLNode * _lastChild
 
XMLNode * _prev
 
XMLNode * _next
 
void * _userData
 

Detailed Description

An XML Comment.

Definition at line 1031 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLComment() [1/2]

tinyxml2::XMLComment::XMLComment ( XMLDocument *  doc)
explicitprotected

Definition at line 1256 of file tinyxml2.cpp.

◆ ~XMLComment()

tinyxml2::XMLComment::~XMLComment ( )
protectedvirtual

Definition at line 1261 of file tinyxml2.cpp.

◆ XMLComment() [2/2]

tinyxml2::XMLComment::XMLComment ( const XMLComment &  )
private

Member Function Documentation

◆ Accept()

bool tinyxml2::XMLComment::Accept ( XMLVisitor *  visitor) const
virtual

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

This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML-2 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():

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

Implements tinyxml2::XMLNode.

Definition at line 1295 of file tinyxml2.cpp.

References TIXMLASSERT, and tinyxml2::XMLVisitor::Visit().

Here is the call graph for this function:

◆ operator=()

XMLComment & tinyxml2::XMLComment::operator= ( const XMLComment &  )
private

◆ ParseDeep()

char * tinyxml2::XMLComment::ParseDeep ( char *  p,
StrPair *  parentEndTag,
int *  curLineNumPtr 
)
protectedvirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1266 of file tinyxml2.cpp.

References tinyxml2::XMLNode::_document, tinyxml2::XMLNode::_parseLineNum, tinyxml2::XMLNode::_value, tinyxml2::StrPair::COMMENT, tinyxml2::StrPair::ParseText(), tinyxml2::XMLDocument::SetError(), and tinyxml2::XML_ERROR_PARSING_COMMENT.

Here is the call graph for this function:

◆ ShallowClone()

XMLNode * tinyxml2::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.

Definition at line 1277 of file tinyxml2.cpp.

References tinyxml2::XMLNode::_document, tinyxml2::XMLDocument::NewComment(), and tinyxml2::XMLNode::Value().

Here is the call graph for this function:

◆ ShallowEqual()

bool tinyxml2::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.

Definition at line 1287 of file tinyxml2.cpp.

References compare(), tinyxml2::XMLUtil::StringEqual(), TIXMLASSERT, and tinyxml2::XMLNode::Value().

Here is the call graph for this function:

◆ ToComment() [1/2]

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

Safely cast to a Comment, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 1035 of file tinyxml2.h.

◆ ToComment() [2/2]

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

Reimplemented from tinyxml2::XMLNode.

Definition at line 1038 of file tinyxml2.h.

Friends And Related Function Documentation

◆ XMLDocument

friend class XMLDocument
friend

Definition at line 1033 of file tinyxml2.h.


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