Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends
RTT::marsh::TiXmlNode Class Reference

#include <tinyxml.h>

Inheritance diagram for RTT::marsh::TiXmlNode:
Inheritance graph
[legend]

List of all members.

Public Types

enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}

Public Member Functions

void Clear ()
 Delete all the children of this node. Does not affect 'this'.
virtual TiXmlNode * Clone () const =0
const TiXmlNode * FirstChild () const
 The first child of this node. Will be null if there are no children.
TiXmlNode * FirstChild ()
const TiXmlNode * FirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found.
TiXmlNode * FirstChild (const char *value)
 The first child of this node with the matching 'value'. Will be null if none found.
const TiXmlElement * FirstChildElement () const
 Convenience function to get through elements.
TiXmlElement * FirstChildElement ()
const TiXmlElement * FirstChildElement (const char *value) const
 Convenience function to get through elements.
TiXmlElement * FirstChildElement (const char *value)
const TiXmlDocument * GetDocument () const
TiXmlDocument * GetDocument ()
TiXmlNode * InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNode * InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNode * InsertEndChild (const TiXmlNode &addThis)
const TiXmlNode * IterateChildren (const TiXmlNode *previous) const
TiXmlNode * IterateChildren (TiXmlNode *previous)
const TiXmlNode * IterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
TiXmlNode * IterateChildren (const char *value, TiXmlNode *previous)
const TiXmlNode * LastChild () const
TiXmlNode * LastChild ()
 The last child of this node. Will be null if there are no children.
const TiXmlNode * LastChild (const char *value) const
TiXmlNode * LastChild (const char *value)
 The last child of this node matching 'value'. Will be null if there are no children.
TiXmlNode * LinkEndChild (TiXmlNode *addThis)
const TiXmlNode * NextSibling () const
 Navigate to a sibling node.
TiXmlNode * NextSibling ()
const TiXmlNode * NextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlNode * NextSibling (const char *)
const TiXmlElement * NextSiblingElement () const
TiXmlElement * NextSiblingElement ()
const TiXmlElement * NextSiblingElement (const char *) const
TiXmlElement * NextSiblingElement (const char *)
bool NoChildren () const
 Returns true if this node has no children.
TiXmlNode * Parent ()
 One step up the DOM.
const TiXmlNode * Parent () const
const TiXmlNode * PreviousSibling () const
 Navigate to a sibling node.
TiXmlNode * PreviousSibling ()
const TiXmlNode * PreviousSibling (const char *) const
 Navigate to a sibling node.
TiXmlNode * PreviousSibling (const char *)
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
TiXmlNode * ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
void SetValue (const char *_value)
virtual const TiXmlComment * ToComment () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlComment * ToComment ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlDeclaration * ToDeclaration () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlDeclaration * ToDeclaration ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlDocument * ToDocument () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlDocument * ToDocument ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlElement * ToElement () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlElement * ToElement ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlText * ToText () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlText * ToText ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlUnknown * ToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlUnknown * ToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type.
int Type () const
const char * Value () const
virtual ~TiXmlNode ()

Protected Member Functions

void CopyTo (TiXmlNode *target) const
TiXmlNode * Identify (const char *start, TiXmlEncoding encoding)
 TiXmlNode (NodeType _type)

Protected Attributes

TiXmlNode * firstChild
TiXmlNode * lastChild
TiXmlNode * next
TiXmlNode * parent
TiXmlNode * prev
NodeType type
TIXML_STRING value

Private Member Functions

void operator= (const TiXmlNode &base)
 TiXmlNode (const TiXmlNode &)

Friends

TIXML_OSTREAM & operator<< (TIXML_OSTREAM &out, const TiXmlNode &base)
class TiXmlDocument
class TiXmlElement

Detailed Description

The parent class for everything in the Document Object Model. (Except for attributes). Nodes have siblings, a parent, and children. A node can be in a document, or stand on its own. The type of a TiXmlNode can be queried, and it can be cast to its more defined type.

Definition at line 425 of file tinyxml.h.

Member Enumeration Documentation

enum RTT::marsh::TiXmlNode::NodeType

The types of XML nodes supported by TinyXml. (All the unsupported types are picked up by UNKNOWN.)

Enumerator:
DOCUMENT 
ELEMENT 
COMMENT 
UNKNOWN 
TEXT 
DECLARATION 
TYPECOUNT 

Definition at line 467 of file tinyxml.h.

Constructor & Destructor Documentation

RTT::marsh::TiXmlNode::~TiXmlNode ( ) [virtual]

Definition at line 195 of file tinyxml.cpp.

RTT::marsh::TiXmlNode::TiXmlNode ( NodeType  _type) [protected]

Definition at line 184 of file tinyxml.cpp.

RTT::marsh::TiXmlNode::TiXmlNode ( const TiXmlNode &  ) [private]

Member Function Documentation

void RTT::marsh::TiXmlNode::Clear ( )

Delete all the children of this node. Does not affect 'this'.

Definition at line 216 of file tinyxml.cpp.

virtual TiXmlNode* RTT::marsh::TiXmlNode::Clone ( ) const [pure virtual]

Create an exact duplicate of this node and return it. The memory must be deleted by the caller.

Implemented in RTT::marsh::TiXmlDocument, RTT::marsh::TiXmlUnknown, RTT::marsh::TiXmlDeclaration, RTT::marsh::TiXmlText, RTT::marsh::TiXmlComment, and RTT::marsh::TiXmlElement.

void RTT::marsh::TiXmlNode::CopyTo ( TiXmlNode *  target) const [protected]

Definition at line 209 of file tinyxml.cpp.

const TiXmlNode* RTT::marsh::TiXmlNode::FirstChild ( ) const [inline]

The first child of this node. Will be null if there are no children.

Definition at line 525 of file tinyxml.h.

TiXmlNode* RTT::marsh::TiXmlNode::FirstChild ( ) [inline]

Definition at line 526 of file tinyxml.h.

const TiXmlNode * RTT::marsh::TiXmlNode::FirstChild ( const char *  value) const

The first child of this node with the matching 'value'. Will be null if none found.

Definition at line 365 of file tinyxml.cpp.

TiXmlNode * RTT::marsh::TiXmlNode::FirstChild ( const char *  value)

The first child of this node with the matching 'value'. Will be null if none found.

Definition at line 377 of file tinyxml.cpp.

const TiXmlElement * RTT::marsh::TiXmlNode::FirstChildElement ( ) const

Convenience function to get through elements.

Definition at line 518 of file tinyxml.cpp.

TiXmlElement * RTT::marsh::TiXmlNode::FirstChildElement ( )

Definition at line 532 of file tinyxml.cpp.

const TiXmlElement * RTT::marsh::TiXmlNode::FirstChildElement ( const char *  value) const

Convenience function to get through elements.

Definition at line 546 of file tinyxml.cpp.

TiXmlElement * RTT::marsh::TiXmlNode::FirstChildElement ( const char *  value)

Definition at line 560 of file tinyxml.cpp.

const TiXmlDocument * RTT::marsh::TiXmlNode::GetDocument ( ) const

Return a pointer to the Document this node lives in. Returns null if not in a document.

Definition at line 631 of file tinyxml.cpp.

TiXmlDocument * RTT::marsh::TiXmlNode::GetDocument ( )

Definition at line 643 of file tinyxml.cpp.

TiXmlNode * RTT::marsh::TiXmlNode::Identify ( const char *  start,
TiXmlEncoding  encoding 
) [protected]

Definition at line 843 of file tinyxmlparser.cpp.

TiXmlNode * RTT::marsh::TiXmlNode::InsertAfterChild ( TiXmlNode *  afterThis,
const TiXmlNode &  addThis 
)

Add a new node related to this. Adds a child after the specified child. Returns a pointer to the new object or NULL if an error occured.

Definition at line 289 of file tinyxml.cpp.

TiXmlNode * RTT::marsh::TiXmlNode::InsertBeforeChild ( TiXmlNode *  beforeThis,
const TiXmlNode &  addThis 
)

Add a new node related to this. Adds a child before the specified child. Returns a pointer to the new object or NULL if an error occured.

Definition at line 263 of file tinyxml.cpp.

TiXmlNode * RTT::marsh::TiXmlNode::InsertEndChild ( const TiXmlNode &  addThis)

Add a new node related to this. Adds a child past the LastChild. Returns a pointer to the new object or NULL if an error occured.

Definition at line 253 of file tinyxml.cpp.

const TiXmlNode * RTT::marsh::TiXmlNode::IterateChildren ( const TiXmlNode *  previous) const

An alternate way to walk the children of a node. One way to iterate over nodes is: 

			for( child = parent->FirstChild(); child; child = child->NextSibling() )

IterateChildren does the same thing with the syntax: 

			child = 0;
			while( child = parent->IterateChildren( child ) )

IterateChildren takes the previous child as input and finds the next one. If the previous child is null, it returns the first. IterateChildren will return null when done.

Definition at line 411 of file tinyxml.cpp.

TiXmlNode * RTT::marsh::TiXmlNode::IterateChildren ( TiXmlNode *  previous)

Definition at line 424 of file tinyxml.cpp.

const TiXmlNode * RTT::marsh::TiXmlNode::IterateChildren ( const char *  value,
const TiXmlNode *  previous 
) const

This flavor of IterateChildren searches for children with a particular 'value'.

Definition at line 437 of file tinyxml.cpp.

TiXmlNode * RTT::marsh::TiXmlNode::IterateChildren ( const char *  value,
TiXmlNode *  previous 
)

Definition at line 450 of file tinyxml.cpp.

const TiXmlNode* RTT::marsh::TiXmlNode::LastChild ( ) const [inline]

Definition at line 530 of file tinyxml.h.

TiXmlNode* RTT::marsh::TiXmlNode::LastChild ( ) [inline]

The last child of this node. Will be null if there are no children.

Definition at line 531 of file tinyxml.h.

const TiXmlNode * RTT::marsh::TiXmlNode::LastChild ( const char *  value) const

Definition at line 389 of file tinyxml.cpp.

TiXmlNode * RTT::marsh::TiXmlNode::LastChild ( const char *  value)

The last child of this node matching 'value'. Will be null if there are no children.

Definition at line 400 of file tinyxml.cpp.

TiXmlNode * RTT::marsh::TiXmlNode::LinkEndChild ( TiXmlNode *  addThis)

Add a new node related to this. Adds a child past the LastChild.

NOTE: the node to be added is passed by pointer, and will be henceforth owned (and deleted) by tinyXml. This method is efficient and avoids an extra copy, but should be used with care as it uses a different memory model than the other insert functions.

See also:
InsertEndChild

Definition at line 233 of file tinyxml.cpp.

const TiXmlNode* RTT::marsh::TiXmlNode::NextSibling ( ) const [inline]

Navigate to a sibling node.

Definition at line 621 of file tinyxml.h.

TiXmlNode* RTT::marsh::TiXmlNode::NextSibling ( ) [inline]

Definition at line 622 of file tinyxml.h.

const TiXmlNode * RTT::marsh::TiXmlNode::NextSibling ( const char *  _value) const

Navigate to a sibling node with the given 'value'.

Definition at line 463 of file tinyxml.cpp.

TiXmlNode * RTT::marsh::TiXmlNode::NextSibling ( const char *  _value)

Definition at line 474 of file tinyxml.cpp.

const TiXmlElement * RTT::marsh::TiXmlNode::NextSiblingElement ( ) const

Convenience function to get through elements. Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

Definition at line 574 of file tinyxml.cpp.

TiXmlElement * RTT::marsh::TiXmlNode::NextSiblingElement ( )

Definition at line 588 of file tinyxml.cpp.

const TiXmlElement * RTT::marsh::TiXmlNode::NextSiblingElement ( const char *  _value) const

Convenience function to get through elements. Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

Definition at line 602 of file tinyxml.cpp.

TiXmlElement * RTT::marsh::TiXmlNode::NextSiblingElement ( const char *  _value)

Definition at line 616 of file tinyxml.cpp.

bool RTT::marsh::TiXmlNode::NoChildren ( ) const [inline]

Returns true if this node has no children.

Definition at line 673 of file tinyxml.h.

void RTT::marsh::TiXmlNode::operator= ( const TiXmlNode &  base) [private]
TiXmlNode* RTT::marsh::TiXmlNode::Parent ( ) [inline]

One step up the DOM.

Definition at line 522 of file tinyxml.h.

const TiXmlNode* RTT::marsh::TiXmlNode::Parent ( ) const [inline]

Definition at line 523 of file tinyxml.h.

const TiXmlNode* RTT::marsh::TiXmlNode::PreviousSibling ( ) const [inline]

Navigate to a sibling node.

Definition at line 606 of file tinyxml.h.

TiXmlNode* RTT::marsh::TiXmlNode::PreviousSibling ( ) [inline]

Definition at line 607 of file tinyxml.h.

const TiXmlNode * RTT::marsh::TiXmlNode::PreviousSibling ( const char *  _value) const

Navigate to a sibling node.

Definition at line 485 of file tinyxml.cpp.

TiXmlNode * RTT::marsh::TiXmlNode::PreviousSibling ( const char *  _value)

Definition at line 496 of file tinyxml.cpp.

bool RTT::marsh::TiXmlNode::RemoveChild ( TiXmlNode *  removeThis)

Delete a child of this node.

Definition at line 343 of file tinyxml.cpp.

TiXmlNode * RTT::marsh::TiXmlNode::ReplaceChild ( TiXmlNode *  replaceThis,
const TiXmlNode &  withThis 
)

Replace a child of this node. Returns a pointer to the new object or NULL if an error occured.

Definition at line 315 of file tinyxml.cpp.

void RTT::marsh::TiXmlNode::SetValue ( const char *  _value) [inline]

Changes the value of the node. Defined as: 

		Document:	filename of the xml file
		Element:	name of the element
		Comment:	the comment text
		Unknown:	the tag contents
		Text:		the text string

Definition at line 511 of file tinyxml.h.

virtual const TiXmlComment* RTT::marsh::TiXmlNode::ToComment ( ) const [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in RTT::marsh::TiXmlComment.

Definition at line 677 of file tinyxml.h.

virtual TiXmlComment* RTT::marsh::TiXmlNode::ToComment ( ) [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in RTT::marsh::TiXmlComment.

Definition at line 684 of file tinyxml.h.

virtual const TiXmlDeclaration* RTT::marsh::TiXmlNode::ToDeclaration ( ) const [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in RTT::marsh::TiXmlDeclaration.

Definition at line 680 of file tinyxml.h.

virtual TiXmlDeclaration* RTT::marsh::TiXmlNode::ToDeclaration ( ) [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in RTT::marsh::TiXmlDeclaration.

Definition at line 687 of file tinyxml.h.

virtual const TiXmlDocument* RTT::marsh::TiXmlNode::ToDocument ( ) const [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in RTT::marsh::TiXmlDocument.

Definition at line 675 of file tinyxml.h.

virtual TiXmlDocument* RTT::marsh::TiXmlNode::ToDocument ( ) [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in RTT::marsh::TiXmlDocument.

Definition at line 682 of file tinyxml.h.

virtual const TiXmlElement* RTT::marsh::TiXmlNode::ToElement ( ) const [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in RTT::marsh::TiXmlElement.

Definition at line 676 of file tinyxml.h.

virtual TiXmlElement* RTT::marsh::TiXmlNode::ToElement ( ) [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in RTT::marsh::TiXmlElement.

Definition at line 683 of file tinyxml.h.

virtual const TiXmlText* RTT::marsh::TiXmlNode::ToText ( ) const [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in RTT::marsh::TiXmlText.

Definition at line 679 of file tinyxml.h.

virtual TiXmlText* RTT::marsh::TiXmlNode::ToText ( ) [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in RTT::marsh::TiXmlText.

Definition at line 686 of file tinyxml.h.

virtual const TiXmlUnknown* RTT::marsh::TiXmlNode::ToUnknown ( ) const [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in RTT::marsh::TiXmlUnknown.

Definition at line 678 of file tinyxml.h.

virtual TiXmlUnknown* RTT::marsh::TiXmlNode::ToUnknown ( ) [inline, virtual]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in RTT::marsh::TiXmlUnknown.

Definition at line 685 of file tinyxml.h.

int RTT::marsh::TiXmlNode::Type ( ) const [inline]

Query the type (as an enumerated value, above) of this node. The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.

Definition at line 664 of file tinyxml.h.

const char* RTT::marsh::TiXmlNode::Value ( ) const [inline]

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

		Document:	filename of the xml file
		Element:	name of the element
		Comment:	the comment text
		Unknown:	the tag contents
		Text:		the text string

The subclasses will wrap this function.

Definition at line 492 of file tinyxml.h.

Friends And Related Function Documentation

TIXML_OSTREAM& operator<< ( TIXML_OSTREAM &  out,
const TiXmlNode &  base 
) [friend]

Definition at line 1698 of file tinyxml.cpp.

friend class TiXmlDocument [friend]

Reimplemented from RTT::marsh::TiXmlBase.

Definition at line 427 of file tinyxml.h.

friend class TiXmlElement [friend]

Reimplemented from RTT::marsh::TiXmlBase.

Reimplemented in RTT::marsh::TiXmlText.

Definition at line 428 of file tinyxml.h.

Member Data Documentation

TiXmlNode* RTT::marsh::TiXmlNode::firstChild [protected]

Definition at line 712 of file tinyxml.h.

TiXmlNode* RTT::marsh::TiXmlNode::lastChild [protected]

Definition at line 713 of file tinyxml.h.

TiXmlNode* RTT::marsh::TiXmlNode::next [protected]

Definition at line 718 of file tinyxml.h.

TiXmlNode* RTT::marsh::TiXmlNode::parent [protected]

Definition at line 709 of file tinyxml.h.

TiXmlNode* RTT::marsh::TiXmlNode::prev [protected]

Definition at line 717 of file tinyxml.h.

NodeType RTT::marsh::TiXmlNode::type [protected]

Definition at line 710 of file tinyxml.h.

TIXML_STRING RTT::marsh::TiXmlNode::value [protected]

Definition at line 715 of file tinyxml.h.

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

rtt
Author(s): RTT Developers
autogenerated on Wed Aug 26 2015 16:16:25