Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | Friends | List of all members
tinyxml2::XMLNode Class Referenceabstract

#include <tinyxml2.h>

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

Public Member Functions

virtual bool Accept (XMLVisitor *visitor) const =0
 
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 XMLNodeShallowClone (XMLDocument *document) const =0
 
virtual bool ShallowEqual (const XMLNode *compare) const =0
 
virtual XMLCommentToComment ()
 Safely cast to a Comment, or null. More...
 
virtual const XMLCommentToComment () const
 
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

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

Protected Attributes

XMLDocument_document
 
XMLNode_firstChild
 
XMLNode_lastChild
 
XMLNode_next
 
XMLNode_parent
 
int _parseLineNum
 
XMLNode_prev
 
void * _userData
 
StrPair _value
 

Private Member Functions

void InsertChildPreamble (XMLNode *insertThis) const
 
XMLNodeoperator= (const XMLNode &)
 
const XMLElementToElementWithName (const char *name) const
 
void Unlink (XMLNode *child)
 
 XMLNode (const XMLNode &)
 

Static Private Member Functions

static void DeleteNode (XMLNode *node)
 

Private Attributes

MemPool_memPool
 

Friends

class XMLDocument
 
class XMLElement
 

Detailed Description

XMLNode is a base class for every object that is in the XML Document Object Model (DOM), except XMLAttributes. Nodes have siblings, a parent, and children which can be navigated. A node is always in a XMLDocument. The type of a XMLNode can be queried, and it can be cast to its more defined type.

A XMLDocument allocates memory for all its Nodes. When the XMLDocument gets deleted, all its Nodes will also be deleted.

    A Document can contain:     Element (container or leaf)
                                                Comment (leaf)
                                                Unknown (leaf)
                                                Declaration( leaf )

    An Element can contain:     Element (container or leaf)
                                                Text    (leaf)
                                                Attributes (not on tree)
                                                Comment (leaf)
                                                Unknown (leaf)

Definition at line 660 of file tinyxml2.h.

Constructor & Destructor Documentation

tinyxml2::XMLNode::XMLNode ( XMLDocument doc)
protected

Definition at line 742 of file tinyxml2.cpp.

tinyxml2::XMLNode::~XMLNode ( )
protectedvirtual

Definition at line 755 of file tinyxml2.cpp.

tinyxml2::XMLNode::XMLNode ( const XMLNode )
private

Member Function Documentation

virtual bool tinyxml2::XMLNode::Accept ( XMLVisitor visitor) const
pure 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();

Implemented in tinyxml2::XMLDocument, tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, and tinyxml2::XMLText.

XMLNode * tinyxml2::XMLNode::DeepClone ( XMLDocument target) const

Make a copy of this node and all its children.

If the 'target' is null, then the nodes will be allocated in the current document. If 'target' is specified, the memory will be allocated is the specified XMLDocument.

    NOTE: This is probably not the correct tool to 
    copy a document, since XMLDocuments can have multiple
    top level XMLNodes. You probably want to use

XMLDocument::DeepCopy()

Definition at line 781 of file tinyxml2.cpp.

void tinyxml2::XMLNode::DeleteChild ( XMLNode node)

Delete a child of this node.

Definition at line 828 of file tinyxml2.cpp.

void tinyxml2::XMLNode::DeleteChildren ( )

Delete all the children of this node.

Definition at line 794 of file tinyxml2.cpp.

void tinyxml2::XMLNode::DeleteNode ( XMLNode node)
staticprivate

Definition at line 1092 of file tinyxml2.cpp.

const XMLNode* tinyxml2::XMLNode::FirstChild ( ) const
inline

Get the first child node, or null if none exists.

Definition at line 755 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::FirstChild ( )
inline

Definition at line 759 of file tinyxml2.h.

const XMLElement * tinyxml2::XMLNode::FirstChildElement ( const char *  name = 0) const

Get the first child element, or optionally the first child element with the specified name.

Definition at line 940 of file tinyxml2.cpp.

XMLElement* tinyxml2::XMLNode::FirstChildElement ( const char *  name = 0)
inline

Definition at line 768 of file tinyxml2.h.

const XMLDocument* tinyxml2::XMLNode::GetDocument ( ) const
inline

Get the XMLDocument that owns this XMLNode.

Definition at line 667 of file tinyxml2.h.

XMLDocument* tinyxml2::XMLNode::GetDocument ( )
inline

Get the XMLDocument that owns this XMLNode.

Definition at line 672 of file tinyxml2.h.

int tinyxml2::XMLNode::GetLineNum ( ) const
inline

Gets the line number the node is in, if the document was parsed from a file.

Definition at line 738 of file tinyxml2.h.

void* tinyxml2::XMLNode::GetUserData ( ) const
inline

Get user data set into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.

Definition at line 932 of file tinyxml2.h.

XMLNode * tinyxml2::XMLNode::InsertAfterChild ( XMLNode afterThis,
XMLNode addThis 
)

Add a node after the specified child node. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the afterThis node is not a child of this node, or if the node does not belong to the same document.

Definition at line 902 of file tinyxml2.cpp.

void tinyxml2::XMLNode::InsertChildPreamble ( XMLNode insertThis) const
private

Definition at line 1107 of file tinyxml2.cpp.

XMLNode * tinyxml2::XMLNode::InsertEndChild ( XMLNode addThis)

Add a child node as the last (right) child. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the node does not belong to the same document.

Definition at line 841 of file tinyxml2.cpp.

XMLNode * tinyxml2::XMLNode::InsertFirstChild ( XMLNode addThis)

Add a child node as the first (left) child. If the child node is already part of the document, it is moved from its old location to the new location. Returns the addThis argument or 0 if the node does not belong to the same document.

Definition at line 871 of file tinyxml2.cpp.

const XMLNode* tinyxml2::XMLNode::LastChild ( ) const
inline

Get the last child node, or null if none exists.

Definition at line 773 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::LastChild ( )
inline

Definition at line 777 of file tinyxml2.h.

const XMLElement * tinyxml2::XMLNode::LastChildElement ( const char *  name = 0) const

Get the last child element or optionally the last child element with the specified name.

Definition at line 952 of file tinyxml2.cpp.

XMLElement* tinyxml2::XMLNode::LastChildElement ( const char *  name = 0)
inline

Definition at line 786 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::LinkEndChild ( XMLNode addThis)
inline

Definition at line 831 of file tinyxml2.h.

const XMLNode* tinyxml2::XMLNode::NextSibling ( ) const
inline

Get the next (right) sibling node of this node.

Definition at line 807 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::NextSibling ( )
inline

Definition at line 811 of file tinyxml2.h.

const XMLElement * tinyxml2::XMLNode::NextSiblingElement ( const char *  name = 0) const

Get the next (right) sibling element of this node, with an optionally supplied name.

Definition at line 964 of file tinyxml2.cpp.

XMLElement* tinyxml2::XMLNode::NextSiblingElement ( const char *  name = 0)
inline

Definition at line 818 of file tinyxml2.h.

bool tinyxml2::XMLNode::NoChildren ( ) const
inline

Returns true if this node has no children.

Definition at line 750 of file tinyxml2.h.

XMLNode& tinyxml2::XMLNode::operator= ( const XMLNode )
private
const XMLNode* tinyxml2::XMLNode::Parent ( ) const
inline

Get the parent of this node on the DOM.

Definition at line 741 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::Parent ( )
inline

Definition at line 745 of file tinyxml2.h.

char * tinyxml2::XMLNode::ParseDeep ( char *  p,
StrPair parentEndTag,
int *  curLineNumPtr 
)
protectedvirtual
const XMLNode* tinyxml2::XMLNode::PreviousSibling ( ) const
inline

Get the previous (left) sibling node of this node.

Definition at line 791 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::PreviousSibling ( )
inline

Definition at line 795 of file tinyxml2.h.

const XMLElement * tinyxml2::XMLNode::PreviousSiblingElement ( const char *  name = 0) const

Get the previous (left) sibling element of this node, with an optionally supplied name.

Definition at line 976 of file tinyxml2.cpp.

XMLElement* tinyxml2::XMLNode::PreviousSiblingElement ( const char *  name = 0)
inline

Definition at line 802 of file tinyxml2.h.

void tinyxml2::XMLNode::SetUserData ( void *  userData)
inline

Set user data into the XMLNode. TinyXML-2 in no way processes or interprets user data. It is initially 0.

Definition at line 925 of file tinyxml2.h.

void tinyxml2::XMLNode::SetValue ( const char *  val,
bool  staticMem = false 
)

Set the Value of an XML node.

See also
Value()

Definition at line 771 of file tinyxml2.cpp.

virtual XMLNode* tinyxml2::XMLNode::ShallowClone ( XMLDocument document) const
pure 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.

Implemented in tinyxml2::XMLDocument, tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, and tinyxml2::XMLText.

virtual bool tinyxml2::XMLNode::ShallowEqual ( const XMLNode compare) const
pure 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.

Implemented in tinyxml2::XMLDocument, tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, and tinyxml2::XMLText.

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

Safely cast to a Comment, or null.

Reimplemented in tinyxml2::XMLComment.

Definition at line 686 of file tinyxml2.h.

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

Reimplemented in tinyxml2::XMLComment.

Definition at line 708 of file tinyxml2.h.

virtual XMLDeclaration* tinyxml2::XMLNode::ToDeclaration ( )
inlinevirtual

Safely cast to a Declaration, or null.

Reimplemented in tinyxml2::XMLDeclaration.

Definition at line 694 of file tinyxml2.h.

virtual const XMLDeclaration* tinyxml2::XMLNode::ToDeclaration ( ) const
inlinevirtual

Reimplemented in tinyxml2::XMLDeclaration.

Definition at line 714 of file tinyxml2.h.

virtual XMLDocument* tinyxml2::XMLNode::ToDocument ( )
inlinevirtual

Safely cast to a Document, or null.

Reimplemented in tinyxml2::XMLDocument.

Definition at line 690 of file tinyxml2.h.

virtual const XMLDocument* tinyxml2::XMLNode::ToDocument ( ) const
inlinevirtual

Reimplemented in tinyxml2::XMLDocument.

Definition at line 711 of file tinyxml2.h.

virtual XMLElement* tinyxml2::XMLNode::ToElement ( )
inlinevirtual

Safely cast to an Element, or null.

Reimplemented in tinyxml2::XMLElement.

Definition at line 678 of file tinyxml2.h.

virtual const XMLElement* tinyxml2::XMLNode::ToElement ( ) const
inlinevirtual

Reimplemented in tinyxml2::XMLElement.

Definition at line 702 of file tinyxml2.h.

const XMLElement * tinyxml2::XMLNode::ToElementWithName ( const char *  name) const
private

Definition at line 1121 of file tinyxml2.cpp.

virtual XMLText* tinyxml2::XMLNode::ToText ( )
inlinevirtual

Safely cast to Text, or null.

Reimplemented in tinyxml2::XMLText.

Definition at line 682 of file tinyxml2.h.

virtual const XMLText* tinyxml2::XMLNode::ToText ( ) const
inlinevirtual

Reimplemented in tinyxml2::XMLText.

Definition at line 705 of file tinyxml2.h.

virtual XMLUnknown* tinyxml2::XMLNode::ToUnknown ( )
inlinevirtual

Safely cast to an Unknown, or null.

Reimplemented in tinyxml2::XMLUnknown.

Definition at line 698 of file tinyxml2.h.

virtual const XMLUnknown* tinyxml2::XMLNode::ToUnknown ( ) const
inlinevirtual

Reimplemented in tinyxml2::XMLUnknown.

Definition at line 717 of file tinyxml2.h.

void tinyxml2::XMLNode::Unlink ( XMLNode child)
private

Definition at line 804 of file tinyxml2.cpp.

const char * tinyxml2::XMLNode::Value ( ) const

The meaning of 'value' changes for the specific type.

Document:       empty (NULL is returned, not an empty string)
Element:        name of the element
Comment:        the comment text
Unknown:        the tag contents
Text:           the text string

Definition at line 763 of file tinyxml2.cpp.

Friends And Related Function Documentation

friend class XMLDocument
friend

Definition at line 662 of file tinyxml2.h.

friend class XMLElement
friend

Definition at line 663 of file tinyxml2.h.

Member Data Documentation

XMLDocument* tinyxml2::XMLNode::_document
protected

Definition at line 940 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_firstChild
protected

Definition at line 945 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_lastChild
protected

Definition at line 946 of file tinyxml2.h.

MemPool* tinyxml2::XMLNode::_memPool
private

Definition at line 954 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_next
protected

Definition at line 949 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_parent
protected

Definition at line 941 of file tinyxml2.h.

int tinyxml2::XMLNode::_parseLineNum
protected

Definition at line 943 of file tinyxml2.h.

XMLNode* tinyxml2::XMLNode::_prev
protected

Definition at line 948 of file tinyxml2.h.

void* tinyxml2::XMLNode::_userData
protected

Definition at line 951 of file tinyxml2.h.

StrPair tinyxml2::XMLNode::_value
mutableprotected

Definition at line 942 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 Sun Feb 3 2019 03:14:33