The parent class for everything in the Document Object Model. More...

#include <tinyxml.h>

Inheritance diagram for gear::TiXmlNode:

Public Types
enum	NodeType { DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, DECLARATION, TYPECOUNT }
	The types of XML nodes supported by TinyXml. More...

Public Types inherited from gear::TiXmlBase
enum	{ TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY, TIXML_ERROR_PARSING_ELEMENT, TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES, TIXML_ERROR_PARSING_EMPTY, TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT, TIXML_ERROR_PARSING_DECLARATION, TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_STRING_COUNT }

Public Member Functions
const char *	Value () const
	The meaning of 'value' changes for the specific type of TiXmlNode. More...

void	SetValue (const char *_value)
	Changes the value of the node. More...

void	SetValue (const std::string &_value)
	STL std::string form.

void	Clear ()
	Delete all the children of this node. Does not affect 'this'.

TiXmlNode *	Parent ()
	One step up the DOM.

const TiXmlNode *	Parent () const

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 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.

const TiXmlNode *	FirstChild (const std::string &_value) const
	STL std::string form.

TiXmlNode *	FirstChild (const std::string &_value)
	STL std::string form.

const TiXmlNode *	LastChild (const std::string &_value) const
	STL std::string form.

TiXmlNode *	LastChild (const std::string &_value)
	STL std::string form.

const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const
	An alternate way to walk the children of a node. More...

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 *	IterateChildren (const std::string &_value, const TiXmlNode *previous) const
	STL std::string form.

TiXmlNode *	IterateChildren (const std::string &_value, TiXmlNode *previous)
	STL std::string form.

TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)
	Add a new node related to this. More...

TiXmlNode *	LinkEndChild (TiXmlNode *addThis)
	Add a new node related to this. More...

TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
	Add a new node related to this. More...

TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
	Add a new node related to this. More...

TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
	Replace a child of this node. More...

bool	RemoveChild (TiXmlNode *removeThis)
	Delete a child of this node.

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 *)

const TiXmlNode *	PreviousSibling (const std::string &_value) const
	STL std::string form.

TiXmlNode *	PreviousSibling (const std::string &_value)
	STL std::string form.

const TiXmlNode *	NextSibling (const std::string &_value) const
	STL std::string form.

TiXmlNode *	NextSibling (const std::string &_value)
	STL std::string form.

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
	Convenience function to get through elements. More...

TiXmlElement *	NextSiblingElement ()

const TiXmlElement *	NextSiblingElement (const char *) const
	Convenience function to get through elements. More...

TiXmlElement *	NextSiblingElement (const char *)

const TiXmlElement *	NextSiblingElement (const std::string &_value) const
	STL std::string form.

TiXmlElement *	NextSiblingElement (const std::string &_value)
	STL std::string form.

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 TiXmlElement *	FirstChildElement (const std::string &_value) const
	STL std::string form.

TiXmlElement *	FirstChildElement (const std::string &_value)
	STL std::string form.

virtual int	Type () const
	Query the type (as an enumerated value, above) of this node. More...

const TiXmlDocument *	GetDocument () const
	Return a pointer to the Document this node lives in. More...

TiXmlDocument *	GetDocument ()

bool	NoChildren () const
	Returns true if this node has no children.

const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null not of the requested type.

const TiXmlElement *	ToElement () const
	Cast to a more defined type. Will return null not of the requested type.

const TiXmlComment *	ToComment () const
	Cast to a more defined type. Will return null not of the requested type.

const TiXmlUnknown *	ToUnknown () const
	Cast to a more defined type. Will return null not of the requested type.

const TiXmlText *	ToText () const
	Cast to a more defined type. Will return null not of the requested type.

const TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null not of the requested type.

TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null not of the requested type.

TiXmlElement *	ToElement ()
	Cast to a more defined type. Will return null not of the requested type.

TiXmlComment *	ToComment ()
	Cast to a more defined type. Will return null not of the requested type.

TiXmlUnknown *	ToUnknown ()
	Cast to a more defined type. Will return null not of the requested type.

TiXmlText *	ToText ()
	Cast to a more defined type. Will return null not of the requested type.

TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null not of the requested type.

virtual TiXmlNode *	Clone () const =0
	Create an exact duplicate of this node and return it. More...

Public Member Functions inherited from gear::TiXmlBase
virtual void	Print (FILE *cfile, int depth) const =0
	All TinyXml classes can print themselves to a filestream. More...

int	Row () const
	Return the position, in the original source file, of this node or attribute. More...

int	Column () const
	See Row()

void	SetUserData (void *user)

void *	GetUserData ()

virtual const char *	Parse (const char p, TiXmlParsingData data, TiXmlEncoding encoding)=0

Protected Member Functions
	TiXmlNode (NodeType _type)

void	CopyTo (TiXmlNode *target) const

virtual void	StreamIn (TIXML_ISTREAM in, TIXML_STRING tag)=0

TiXmlNode *	Identify (const char *start, TiXmlEncoding encoding)

const TIXML_STRING &	SValue () const

Protected Member Functions inherited from gear::TiXmlBase
virtual void	StreamOut (TIXML_OSTREAM *) const =0

Protected Attributes
TiXmlNode *	parent {}

NodeType	type {}

TiXmlNode *	firstChild {}

TiXmlNode *	lastChild {}

TIXML_STRING	value {}

TiXmlNode *	prev {}

TiXmlNode *	next {}

Protected Attributes inherited from gear::TiXmlBase
TiXmlCursor	location {}

void *	userData
	Field containing a generic user pointer.

Friends
class	TiXmlDocument

class	TiXmlElement

std::istream &	operator>> (std::istream &in, TiXmlNode &base)
	An input stream operator, for every class. More...

std::ostream &	operator<< (std::ostream &out, const TiXmlNode &base)
	An output stream operator, for every class. More...

std::string &	operator<< (std::string &out, const TiXmlNode &base)
	Appends the XML node or attribute to a std::string.

Additional Inherited Members
Static Public Member Functions inherited from gear::TiXmlBase
static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not. More...

static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting.

Static Public Attributes inherited from gear::TiXmlBase
static const int	utf8ByteTable [256]

Static Protected Member Functions inherited from gear::TiXmlBase
static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)

static bool	IsWhiteSpace (char c)

static bool	StreamWhiteSpace (TIXML_ISTREAM in, TIXML_STRING tag)

static bool	StreamTo (TIXML_ISTREAM in, int character, TIXML_STRING tag)

static const char *	ReadName (const char p, TIXML_STRING name, TiXmlEncoding encoding)

static const char *	ReadText (const char in, TIXML_STRING text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)

static const char *	GetEntity (const char in, char value, int *length, TiXmlEncoding encoding)

static const char *	GetChar (const char p, char _value, int *length, TiXmlEncoding encoding)

static void	PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)

static void	PutString (const TIXML_STRING &str, TIXML_STRING *out)

static bool	StringEqual (const char p, const char endTag, bool ignoreCase, TiXmlEncoding encoding)

static int	IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)

static int	IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)

static int	ToLower (int v, TiXmlEncoding encoding)

static void	ConvertUTF32ToUTF8 (unsigned long input, char output, int length)

Static Protected Attributes inherited from gear::TiXmlBase
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

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 370 of file tinyxml.h.

Member Enumeration Documentation

enum gear::TiXmlNode::NodeType

The types of XML nodes supported by TinyXml.

(All the unsupported types are picked up by UNKNOWN.)

Definition at line 412 of file tinyxml.h.

Member Function Documentation

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

Referenced by InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and ReplaceChild().

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

Return a pointer to the Document this node lives in.

Returns null if not in a document.

Definition at line 595 of file tinyxml.cc.

References ToDocument().

Referenced by gear::TiXmlElement::SetAttribute().

TiXmlNode * gear::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 254 of file tinyxml.cc.

References Clone().

TiXmlNode * gear::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 228 of file tinyxml.cc.

References Clone().

TiXmlNode * gear::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 218 of file tinyxml.cc.

References Clone(), and LinkEndChild().

Referenced by gear::GearXML::createXMLFile(), gear::GearParametersXML::getXMLForParameters(), gear::TrackerPlanesParametersXML::toXML(), gear::ZPlanarParametersXML::toXML(), gear::SiPlanesParametersXML::toXML(), gear::FTDParametersXML::toXML(), gear::RectangularPadRowLayoutXML::toXML(), gear::TPCModuleXML::toXML(), gear::TPCParametersXML::toXML(), gear::CalorimeterParametersXML::toXML(), and gear::VersatileDiskRowLayoutXML::toXML().

const TiXmlNode * gear::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 376 of file tinyxml.cc.

References FirstChild(), and NextSibling().

Referenced by gear::GearXML::createGearMgr(), gear::TrackerPlanesParametersXML::fromXML(), gear::ZPlanarParametersXML::fromXML(), gear::SiPlanesParametersXML::fromXML(), gear::FTDParametersXML::fromXML(), gear::RectangularPadRowLayoutXML::fromXML(), gear::TPCParametersXML::fromXML(), gear::CalorimeterParametersXML::fromXML(), gear::VersatileDiskRowLayoutXML::fromXML(), and gear::GearParametersXML::setParametersFromXML().

TiXmlNode * gear::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 201 of file tinyxml.cc.

Referenced by InsertEndChild(), and gear::TiXmlDocument::Parse().

const TiXmlElement * gear::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 538 of file tinyxml.cc.

References NextSibling(), and ToElement().

Referenced by gear::TiXmlHandle::ChildElement().

const TiXmlElement * gear::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 566 of file tinyxml.cc.

References NextSibling(), and ToElement().

TiXmlNode * gear::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 280 of file tinyxml.cc.

References Clone().

void gear::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 448 of file tinyxml.h.

Referenced by gear::GearXML::createXMLFile(), and gear::TiXmlText::TiXmlText().

virtual int gear::TiXmlNode::Type ( ) const

inlinevirtual

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 605 of file tinyxml.h.

const char* gear::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 437 of file tinyxml.h.

Referenced by gear::TiXmlElement::Clone(), gear::TPCParametersXML::fromXML(), gear::CalorimeterParametersXML::fromXML(), gear::getChildElementValue(), gear::getXMLAttribute(), and gear::GearParametersXML::setParametersFromXML().

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	out,
		const TiXmlNode &	base
	)

friend

An output stream operator, for every class.

Note that this outputs without any newlines or formatting, as opposed to Print(), which includes tabs and new lines.

The operator<< and operator>> are not completely symmetric. Writing a node to a stream is very well defined. You'll get a nice stream of output, without any extra whitespace or newlines.

But reading is not as well defined. (As it always is.) If you create a TiXmlElement (for example) and read that from an input stream, the text needs to define an element or junk will result. This is true of all input streams, but it's worth keeping in mind.

A TiXmlDocument will read nodes until it reads a root element, and all the children of that root element.

std::istream& operator>>	(	std::istream &	in,
		TiXmlNode &	base
	)

friend

An input stream operator, for every class.

Tolerant of newlines and formatting, but doesn't expect them.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Friends And Related Function Documentation