Public Member Functions | Protected Member Functions | Private Member Functions | Friends
tinyxml2::XMLComment Class Reference

#include <tinyxml2.h>

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

List of all members.

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.
virtual const XMLCommentToComment () const

Protected Member Functions

char * ParseDeep (char *p, StrPair *parentEndTag, int *curLineNumPtr)
 XMLComment (XMLDocument *doc)
virtual ~XMLComment ()

Private Member Functions

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

Friends

class XMLDocument

Detailed Description

An XML Comment.

Definition at line 1017 of file tinyxml2.h.


Constructor & Destructor Documentation

Definition at line 1192 of file tinyxml2.cpp.

tinyxml2::XMLComment::~XMLComment ( ) [protected, virtual]

Definition at line 1197 of file tinyxml2.cpp.


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 
) [protected, virtual]

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 ( ) [inline, virtual]

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 [inline, virtual]

Reimplemented from tinyxml2::XMLNode.

Definition at line 1024 of file tinyxml2.h.


Friends And Related Function Documentation

friend class XMLDocument [friend]

Reimplemented from tinyxml2::XMLNode.

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 03:50:11