#include <tinyxml2.h>

Inheritance 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

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 optionally 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 optionally 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 ()

Protected Member Functions inherited from tinyxml2::XMLNode
	XMLNode (XMLDocument *)

virtual	~XMLNode ()

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

XMLNode *	_firstChild

XMLNode *	_lastChild

XMLNode *	_prev

XMLNode *	_next

Detailed Description

An XML Comment.

Definition at line 970 of file tinyxml2.h.

Constructor & Destructor Documentation

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

protected

Definition at line 977 of file tinyxml2.cpp.

tinyxml2::XMLComment::~XMLComment ( )

protectedvirtual

Definition at line 982 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 1017 of file tinyxml2.cpp.

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

private

char * tinyxml2::XMLComment::ParseDeep	(	char *	p,
		StrPair *	endTag
	)

virtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 987 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 999 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 1009 of file tinyxml2.cpp.

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

inlinevirtual

Safely cast to a Comment, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 974 of file tinyxml2.h.

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

inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 977 of file tinyxml2.h.

Friends And Related Function Documentation

friend class XMLDocument

friend

Definition at line 972 of file tinyxml2.h.

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

src/lib/Parameters/tinyxml2.h
src/lib/Parameters/tinyxml2.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation