Public Member Functions | Protected Member Functions | Private Member Functions | Friends | List of all members
tinyxml2::XMLComment Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLComment:
Inheritance graph
[legend]

Public Member Functions

virtual bool Accept (XMLVisitor *visitor) const
 
virtual XMLNodeShallowClone (XMLDocument *document) const
 
virtual bool ShallowEqual (const XMLNode *compare) const
 
virtual XMLCommentToComment ()
 Safely cast to a Comment, or null. More...
 
virtual const XMLCommentToComment () const
 
- Public Member Functions inherited from tinyxml2::XMLNode
XMLNodeDeepClone (XMLDocument *target) const
 
void DeleteChild (XMLNode *node)
 
void DeleteChildren ()
 
const XMLNodeFirstChild () const
 Get the first child node, or null if none exists. More...
 
XMLNodeFirstChild ()
 
const XMLElementFirstChildElement (const char *name=0) const
 
XMLElementFirstChildElement (const char *name=0)
 
const XMLDocumentGetDocument () const
 Get the XMLDocument that owns this XMLNode. More...
 
XMLDocumentGetDocument ()
 Get the XMLDocument that owns this XMLNode. More...
 
int GetLineNum () const
 Gets the line number the node is in, if the document was parsed from a file. More...
 
void * GetUserData () const
 
XMLNodeInsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
 
XMLNodeInsertEndChild (XMLNode *addThis)
 
XMLNodeInsertFirstChild (XMLNode *addThis)
 
const XMLNodeLastChild () const
 Get the last child node, or null if none exists. More...
 
XMLNodeLastChild ()
 
const XMLElementLastChildElement (const char *name=0) const
 
XMLElementLastChildElement (const char *name=0)
 
XMLNodeLinkEndChild (XMLNode *addThis)
 
const XMLNodeNextSibling () const
 Get the next (right) sibling node of this node. More...
 
XMLNodeNextSibling ()
 
const XMLElementNextSiblingElement (const char *name=0) const
 Get the next (right) sibling element of this node, with an optionally supplied name. More...
 
XMLElementNextSiblingElement (const char *name=0)
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
const XMLNodeParent () const
 Get the parent of this node on the DOM. More...
 
XMLNodeParent ()
 
const XMLNodePreviousSibling () const
 Get the previous (left) sibling node of this node. More...
 
XMLNodePreviousSibling ()
 
const XMLElementPreviousSiblingElement (const char *name=0) const
 Get the previous (left) sibling element of this node, with an optionally supplied name. More...
 
XMLElementPreviousSiblingElement (const char *name=0)
 
void SetUserData (void *userData)
 
void SetValue (const char *val, bool staticMem=false)
 
virtual XMLDeclarationToDeclaration ()
 Safely cast to a Declaration, or null. More...
 
virtual const XMLDeclarationToDeclaration () const
 
virtual XMLDocumentToDocument ()
 Safely cast to a Document, or null. More...
 
virtual const XMLDocumentToDocument () const
 
virtual XMLElementToElement ()
 Safely cast to an Element, or null. More...
 
virtual const XMLElementToElement () const
 
virtual XMLTextToText ()
 Safely cast to Text, or null. More...
 
virtual const XMLTextToText () const
 
virtual XMLUnknownToUnknown ()
 Safely cast to an Unknown, or null. More...
 
virtual const XMLUnknownToUnknown () const
 
const char * Value () const
 

Protected Member Functions

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

Private Member Functions

XMLCommentoperator= (const XMLComment &)
 
 XMLComment (const XMLComment &)
 

Friends

class XMLDocument
 

Additional Inherited Members

- Protected Attributes inherited from tinyxml2::XMLNode
XMLDocument_document
 
XMLNode_firstChild
 
XMLNode_lastChild
 
XMLNode_next
 
XMLNode_parent
 
int _parseLineNum
 
XMLNode_prev
 
void * _userData
 
StrPair _value
 

Detailed Description

An XML Comment.

Definition at line 1017 of file tinyxml2.h.

Constructor & Destructor Documentation

tinyxml2::XMLComment::XMLComment ( XMLDocument doc)
protected

Definition at line 1192 of file tinyxml2.cpp.

tinyxml2::XMLComment::~XMLComment ( )
protectedvirtual

Definition at line 1197 of file tinyxml2.cpp.

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

Member Function Documentation

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 1231 of file tinyxml2.cpp.

XMLComment& tinyxml2::XMLComment::operator= ( const XMLComment )
private
char * tinyxml2::XMLComment::ParseDeep ( char *  p,
StrPair parentEndTag,
int *  curLineNumPtr 
)
protectedvirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1202 of file tinyxml2.cpp.

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 1213 of file tinyxml2.cpp.

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 1223 of file tinyxml2.cpp.

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

Safely cast to a Comment, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 1021 of file tinyxml2.h.

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

Reimplemented from tinyxml2::XMLNode.

Definition at line 1024 of file tinyxml2.h.

Friends And Related Function Documentation

friend class XMLDocument
friend

Definition at line 1019 of file tinyxml2.h.


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


behaviortree_cpp
Author(s): Michele Colledanchise, Davide Faconti
autogenerated on Sat Feb 2 2019 04:01:55