#include <tinyxml.h>

Inheritance diagram for rospack_tinyxml::TiXmlNode:

Public Types
enum	NodeType { DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, DECLARATION, TYPECOUNT }
Public Member Functions
virtual bool	Accept (TiXmlVisitor *visitor) const =0
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
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 (const 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, const 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 *_next)
const TiXmlElement *	NextSiblingElement () const
TiXmlElement *	NextSiblingElement ()
const TiXmlElement *	NextSiblingElement (const char *) const
TiXmlElement *	NextSiblingElement (const char *_next)
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 *_prev)
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
const TIXML_STRING &	ValueTStr () 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
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 438 of file tinyxml.h.

Member Enumeration Documentation

enum rospack_tinyxml::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 477 of file tinyxml.h.

Constructor & Destructor Documentation

rospack_tinyxml::TiXmlNode::~TiXmlNode ( ) [virtual]

Definition at line 147 of file tinyxml.cpp.

rospack_tinyxml::TiXmlNode::TiXmlNode ( NodeType _type ) [protected]

Definition at line 136 of file tinyxml.cpp.

rospack_tinyxml::TiXmlNode::TiXmlNode ( const TiXmlNode & ) [private]

Member Function Documentation

virtual bool rospack_tinyxml::TiXmlNode::Accept ( TiXmlVisitor * visitor ) const [pure virtual]

Accept a hierchical visit the nodes in the TinyXML DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the TiXmlVisitor interface.

This is essentially a SAX interface for TinyXML. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML 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():

		TiXmlPrinter printer;
		tinyxmlDoc.Accept( &printer );
		const char* xmlcstr = printer.CStr();

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

void rospack_tinyxml::TiXmlNode::Clear ( )

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

Definition at line 168 of file tinyxml.cpp.

virtual TiXmlNode* rospack_tinyxml::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 rospack_tinyxml::TiXmlDocument, rospack_tinyxml::TiXmlUnknown, rospack_tinyxml::TiXmlDeclaration, rospack_tinyxml::TiXmlText, rospack_tinyxml::TiXmlComment, and rospack_tinyxml::TiXmlElement.

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

Definition at line 161 of file tinyxml.cpp.

const TiXmlNode* rospack_tinyxml::TiXmlNode::FirstChild ( ) const [inline]

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

Definition at line 537 of file tinyxml.h.

TiXmlNode* rospack_tinyxml::TiXmlNode::FirstChild ( ) [inline]

Definition at line 538 of file tinyxml.h.

const TiXmlNode * rospack_tinyxml::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 341 of file tinyxml.cpp.

TiXmlNode* rospack_tinyxml::TiXmlNode::FirstChild ( const char * _value ) [inline]

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

Definition at line 541 of file tinyxml.h.

const TiXmlElement * rospack_tinyxml::TiXmlNode::FirstChildElement ( ) const

Convenience function to get through elements.

Definition at line 432 of file tinyxml.cpp.

TiXmlElement* rospack_tinyxml::TiXmlNode::FirstChildElement ( ) [inline]

Definition at line 680 of file tinyxml.h.

const TiXmlElement * rospack_tinyxml::TiXmlNode::FirstChildElement ( const char * _value ) const

Convenience function to get through elements.

Definition at line 447 of file tinyxml.cpp.

TiXmlElement* rospack_tinyxml::TiXmlNode::FirstChildElement ( const char * _value ) [inline]

Definition at line 686 of file tinyxml.h.

const TiXmlDocument * rospack_tinyxml::TiXmlNode::GetDocument ( ) const

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

Definition at line 492 of file tinyxml.cpp.

TiXmlDocument* rospack_tinyxml::TiXmlNode::GetDocument ( ) [inline]

Definition at line 705 of file tinyxml.h.

TiXmlNode * rospack_tinyxml::TiXmlNode::Identify	(	const char *	start,
		TiXmlEncoding	encoding
	)		`[protected]`

Definition at line 820 of file tinyxmlparser.cpp.

TiXmlNode * rospack_tinyxml::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 259 of file tinyxml.cpp.

TiXmlNode * rospack_tinyxml::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 227 of file tinyxml.cpp.

TiXmlNode * rospack_tinyxml::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 212 of file tinyxml.cpp.

const TiXmlNode * rospack_tinyxml::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 365 of file tinyxml.cpp.

TiXmlNode* rospack_tinyxml::TiXmlNode::IterateChildren ( const TiXmlNode * previous ) [inline]

Definition at line 578 of file tinyxml.h.

const TiXmlNode * rospack_tinyxml::TiXmlNode::IterateChildren	(	const char *	value,
		const TiXmlNode *	previous
	)		const

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

Definition at line 379 of file tinyxml.cpp.

TiXmlNode* rospack_tinyxml::TiXmlNode::IterateChildren	(	const char *	_value,
		const TiXmlNode *	previous
	)		`[inline]`

Definition at line 584 of file tinyxml.h.

const TiXmlNode* rospack_tinyxml::TiXmlNode::LastChild ( ) const [inline]

Definition at line 546 of file tinyxml.h.

TiXmlNode* rospack_tinyxml::TiXmlNode::LastChild ( ) [inline]

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

Definition at line 547 of file tinyxml.h.

const TiXmlNode * rospack_tinyxml::TiXmlNode::LastChild ( const char * value ) const

Definition at line 353 of file tinyxml.cpp.

TiXmlNode* rospack_tinyxml::TiXmlNode::LastChild ( const char * _value ) [inline]

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

Definition at line 550 of file tinyxml.h.

TiXmlNode * rospack_tinyxml::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 185 of file tinyxml.cpp.

const TiXmlNode* rospack_tinyxml::TiXmlNode::NextSibling ( ) const [inline]

Navigate to a sibling node.

Definition at line 646 of file tinyxml.h.

TiXmlNode* rospack_tinyxml::TiXmlNode::NextSibling ( ) [inline]

Definition at line 647 of file tinyxml.h.

const TiXmlNode * rospack_tinyxml::TiXmlNode::NextSibling ( const char * _value ) const

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

Definition at line 393 of file tinyxml.cpp.

TiXmlNode* rospack_tinyxml::TiXmlNode::NextSibling ( const char * _next ) [inline]

Definition at line 651 of file tinyxml.h.

const TiXmlElement * rospack_tinyxml::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 462 of file tinyxml.cpp.

TiXmlElement* rospack_tinyxml::TiXmlNode::NextSiblingElement ( ) [inline]

Definition at line 660 of file tinyxml.h.

const TiXmlElement * rospack_tinyxml::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 477 of file tinyxml.cpp.

TiXmlElement* rospack_tinyxml::TiXmlNode::NextSiblingElement ( const char * _next ) [inline]

Definition at line 669 of file tinyxml.h.

bool rospack_tinyxml::TiXmlNode::NoChildren ( ) const [inline]

Returns true if this node has no children.

Definition at line 710 of file tinyxml.h.

void rospack_tinyxml::TiXmlNode::operator= ( const TiXmlNode & base ) [private]

TiXmlNode* rospack_tinyxml::TiXmlNode::Parent ( ) [inline]

One step up the DOM.

Definition at line 534 of file tinyxml.h.

const TiXmlNode* rospack_tinyxml::TiXmlNode::Parent ( ) const [inline]

Definition at line 535 of file tinyxml.h.

const TiXmlNode* rospack_tinyxml::TiXmlNode::PreviousSibling ( ) const [inline]

Navigate to a sibling node.

Definition at line 629 of file tinyxml.h.

TiXmlNode* rospack_tinyxml::TiXmlNode::PreviousSibling ( ) [inline]

Definition at line 630 of file tinyxml.h.

const TiXmlNode * rospack_tinyxml::TiXmlNode::PreviousSibling ( const char * _value ) const

Navigate to a sibling node.

Definition at line 405 of file tinyxml.cpp.

TiXmlNode* rospack_tinyxml::TiXmlNode::PreviousSibling ( const char * _prev ) [inline]

Definition at line 634 of file tinyxml.h.

bool rospack_tinyxml::TiXmlNode::RemoveChild ( TiXmlNode * removeThis )

Delete a child of this node.

Definition at line 319 of file tinyxml.cpp.

TiXmlNode * rospack_tinyxml::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 291 of file tinyxml.cpp.

void rospack_tinyxml::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 523 of file tinyxml.h.

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