TiXmlNode Class Reference

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

#include <tinyxml.h>

Inheritance diagram for TiXmlNode:

Inheritance graph
[legend]
Collaboration diagram for TiXmlNode:

Collaboration graph
[legend]

Public Types

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

Public Member Functions

virtual ~TiXmlNode ()
const char * Value () const
 The meaning of 'value' changes for the specific type of TiXmlNode.
void SetValue (const char *_value)
 Changes the value of the node.
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 () const
 One step up the DOM.
TiXmlNode * FirstChild () const
 The first child of this node. Will be null if there are no children.
TiXmlNode * FirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found.
TiXmlNode * LastChild () const
TiXmlNode * LastChild (const char *value) const
 The last child of this node. Will be null if there are no children.
TiXmlNode * FirstChild (const std::string &value) const
 The last child of this node matching 'value'. Will be null if there are no children.
TiXmlNode * LastChild (const std::string &value) const
 STL std::string form.
TiXmlNode * IterateChildren (TiXmlNode *previous) const
 An alternate way to walk the children of a node.
TiXmlNode * IterateChildren (const char *value, TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
TiXmlNode * IterateChildren (const std::string &value, TiXmlNode *previous) const
 STL std::string form.
TiXmlNode * InsertEndChild (const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNode * InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNode * InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNode * ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 Replace a child of this node.
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
TiXmlNode * PreviousSibling () const
 Navigate to a sibling node.
TiXmlNode * PreviousSibling (const char *) const
 Navigate to a sibling node.
TiXmlNode * PreviousSibling (const std::string &value) const
 STL std::string form.
TiXmlNode * NextSibling (const std::string &value) const
 STL std::string form.
TiXmlNode * NextSibling () const
 Navigate to a sibling node.
TiXmlNode * NextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlElement * NextSiblingElement () const
 Convenience function to get through elements.
TiXmlElement * NextSiblingElement (const char *) const
 Convenience function to get through elements.
TiXmlElement * NextSiblingElement (const std::string &value) const
 STL std::string form.
TiXmlElement * FirstChildElement () const
 Convenience function to get through elements.
TiXmlElement * FirstChildElement (const char *value) const
 Convenience function to get through elements.
TiXmlElement * FirstChildElement (const std::string &value) const
 STL std::string form.
virtual int Type () const
 Query the type (as an enumerated value, above) of this node.
TiXmlDocument * GetDocument () const
 Return a pointer to the Document this node lives in.
bool NoChildren () const
 Returns true if this node has no children.
TiXmlDocument * ToDocument () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlElement * ToElement () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlComment * ToComment () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlUnknown * ToUnknown () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlText * ToText () const
 Cast to a more defined type. Will return null not of the requested type.
TiXmlDeclaration * ToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type.
virtual TiXmlNode * Clone () const =0
void SetUserData (void *user)
void * GetUserData ()

Protected Member Functions

 TiXmlNode (NodeType type)
virtual void StreamIn (TIXML_ISTREAM *in, TIXML_STRING *tag)=0
TiXmlNode * LinkEndChild (TiXmlNode *addThis)
TiXmlNode * Identify (const char *start)
void CopyToClone (TiXmlNode *target) const
TIXML_STRING SValue () const

Protected Attributes

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

Friends

class TiXmlDocument
class TiXmlElement
std::istream & operator>> (std::istream &in, TiXmlNode &base)
 An input stream operator, for every class.
std::ostream & operator<< (std::ostream &out, const TiXmlNode &base)
 An output stream operator, for every class.

Detailed Description

The parent class for everything in the Document Object Model.

(Except for attributes, which are contained in elements.) 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 262 of file tinyxml.h.

Member Enumeration Documentation

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

Constructor & Destructor Documentation

TiXmlNode::~TiXmlNode (  )  [virtual]

Definition at line 143 of file tinyxml.cpp.

References firstChild, and next.

TiXmlNode::TiXmlNode ( NodeType  type  )  [protected]

Definition at line 131 of file tinyxml.cpp.

References firstChild, lastChild, next, parent, prev, type, and userData.

Member Function Documentation

void TiXmlNode::Clear (  ) 

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

Definition at line 157 of file tinyxml.cpp.

References firstChild, lastChild, and next.

Referenced by TiXmlDocument::LoadFile().

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

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

Referenced by TiXmlDocument::Clone(), TiXmlElement::Clone(), InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and ReplaceChild().

void TiXmlNode::CopyToClone ( TiXmlNode *  target  )  const [inline, protected]

Definition at line 490 of file tinyxml.h.

References SetValue(), userData, and value.

Referenced by TiXmlUnknown::Clone(), TiXmlDeclaration::Clone(), TiXmlText::Clone(), TiXmlComment::Clone(), TiXmlDocument::Clone(), and TiXmlElement::Clone().

TiXmlNode* TiXmlNode::FirstChild ( const std::string &  value  )  const [inline]

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

STL std::string form.

Definition at line 359 of file tinyxml.h.

References FirstChild().

Referenced by FirstChild().

TiXmlNode * 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 303 of file tinyxml.cpp.

References firstChild, next, SValue(), and TIXML_STRING.

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

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

Definition at line 352 of file tinyxml.h.

References firstChild.

Referenced by FirstChildElement(), IterateChildren(), TiXmlDocument::Print(), and TiXmlDocument::StreamOut().

TiXmlElement* TiXmlNode::FirstChildElement ( const std::string &  value  )  const [inline]

STL std::string form.

Definition at line 451 of file tinyxml.h.

References FirstChildElement().

Referenced by FirstChildElement().

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

Convenience function to get through elements.

Definition at line 398 of file tinyxml.cpp.

References FirstChild(), NextSibling(), and ToElement().

TiXmlElement * TiXmlNode::FirstChildElement (  )  const

Convenience function to get through elements.

Definition at line 384 of file tinyxml.cpp.

References FirstChild(), NextSibling(), and ToElement().

Referenced by Ogre::DotSceneLoader::processCamera(), Ogre::DotSceneLoader::processEntity(), Ogre::DotSceneLoader::processEnvironment(), Ogre::DotSceneLoader::processFog(), Ogre::DotSceneLoader::processLight(), Ogre::DotSceneLoader::processLookTarget(), Ogre::DotSceneLoader::processNode(), Ogre::DotSceneLoader::processNodes(), Ogre::DotSceneLoader::processPlane(), Ogre::DotSceneLoader::processScene(), Ogre::DotSceneLoader::processSkyBox(), Ogre::DotSceneLoader::processSkyDome(), Ogre::DotSceneLoader::processTrackTarget(), and TiXmlDocument::RootElement().

TiXmlDocument * TiXmlNode::GetDocument (  )  const

Return a pointer to the Document this node lives in.

Returns null if not in a document.

Definition at line 443 of file tinyxml.cpp.

References parent, and ToDocument().

Referenced by Identify(), TiXmlDeclaration::Parse(), TiXmlComment::Parse(), TiXmlUnknown::Parse(), TiXmlElement::Parse(), TiXmlElement::ReadValue(), and TiXmlElement::SetAttribute().

void* TiXmlNode::GetUserData (  )  [inline]

Definition at line 475 of file tinyxml.h.

References userData.

TiXmlNode * TiXmlNode::Identify ( const char *  start  )  [protected]

Definition at line 384 of file tinyxmlparser.cpp.

References GetDocument(), parent, TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlBase::StringEqual(), TiXmlBase::TIXML_ERROR_OUT_OF_MEMORY, TIXML_LOG, and TiXmlElement.

Referenced by TiXmlDocument::Parse(), TiXmlElement::ReadValue(), TiXmlElement::StreamIn(), and TiXmlDocument::StreamIn().

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

References Clone(), lastChild, next, parent, and prev.

TiXmlNode * 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 201 of file tinyxml.cpp.

References Clone(), firstChild, next, parent, and prev.

TiXmlNode * 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 191 of file tinyxml.cpp.

References Clone(), and LinkEndChild().

TiXmlNode* TiXmlNode::IterateChildren ( const std::string &  value,
TiXmlNode *  previous 
) const [inline]

STL std::string form.

Definition at line 385 of file tinyxml.h.

References IterateChildren().

Referenced by IterateChildren().

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

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

Definition at line 338 of file tinyxml.cpp.

References FirstChild(), NextSibling(), and parent.

TiXmlNode * TiXmlNode::IterateChildren ( 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 325 of file tinyxml.cpp.

References FirstChild(), NextSibling(), and parent.

TiXmlNode* TiXmlNode::LastChild ( const std::string &  value  )  const [inline]

STL std::string form.

Definition at line 360 of file tinyxml.h.

References LastChild().

Referenced by LastChild().

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

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

Definition at line 314 of file tinyxml.cpp.

References lastChild, prev, SValue(), and TIXML_STRING.

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

Definition at line 355 of file tinyxml.h.

References lastChild.

TiXmlNode * TiXmlNode::LinkEndChild ( TiXmlNode *  addThis  )  [protected]

Definition at line 174 of file tinyxml.cpp.

References firstChild, lastChild, next, parent, and prev.

Referenced by TiXmlDocument::Clone(), TiXmlElement::Clone(), InsertEndChild(), TiXmlDocument::Parse(), and TiXmlElement::ReadValue().

TiXmlNode * TiXmlNode::NextSibling ( const char *  value  )  const

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

Definition at line 351 of file tinyxml.cpp.

References next, SValue(), and TIXML_STRING.

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

Navigate to a sibling node.

Definition at line 423 of file tinyxml.h.

References next.

Referenced by NextSiblingElement().

TiXmlNode* TiXmlNode::NextSibling ( const std::string &  value  )  const [inline]

STL std::string form.

Definition at line 419 of file tinyxml.h.

References NextSibling().

Referenced by TiXmlDocument::Clone(), TiXmlElement::Clone(), FirstChildElement(), IterateChildren(), NextSibling(), NextSiblingElement(), TiXmlDocument::Print(), TiXmlElement::Print(), TiXmlDocument::StreamOut(), and TiXmlElement::StreamOut().

TiXmlElement* TiXmlNode::NextSiblingElement ( const std::string &  value  )  const [inline]

STL std::string form.

Definition at line 441 of file tinyxml.h.

References NextSiblingElement().

Referenced by NextSiblingElement().

TiXmlElement * 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 427 of file tinyxml.cpp.

References NextSibling(), and ToElement().

TiXmlElement * 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 413 of file tinyxml.cpp.

References NextSibling(), and ToElement().

Referenced by Ogre::DotSceneLoader::processNode(), and Ogre::DotSceneLoader::processNodes().

bool TiXmlNode::NoChildren (  )  const [inline]

Returns true if this node has no children.

Definition at line 463 of file tinyxml.h.

References firstChild.

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

One step up the DOM.

Definition at line 350 of file tinyxml.h.

References parent.

TiXmlNode* TiXmlNode::PreviousSibling ( const std::string &  value  )  const [inline]

STL std::string form.

Definition at line 418 of file tinyxml.h.

References PreviousSibling().

Referenced by PreviousSibling().

TiXmlNode * TiXmlNode::PreviousSibling ( const char *  value  )  const

Navigate to a sibling node.

Definition at line 363 of file tinyxml.cpp.

References prev, SValue(), and TIXML_STRING.

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

Navigate to a sibling node.

Definition at line 412 of file tinyxml.h.

References prev.

bool TiXmlNode::RemoveChild ( TiXmlNode *  removeThis  ) 

Delete a child of this node.

Definition at line 281 of file tinyxml.cpp.

References firstChild, lastChild, next, parent, and prev.

TiXmlNode * 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 253 of file tinyxml.cpp.

References Clone(), firstChild, lastChild, next, parent, and prev.

void TiXmlNode::SetUserData ( void *  user  )  [inline]

Definition at line 474 of file tinyxml.h.

References userData.

void TiXmlNode::SetValue ( const std::string &  value  )  [inline]

STL std::string form.

Definition at line 340 of file tinyxml.h.

References SetValue(), and value.

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

References value.

Referenced by CopyToClone(), SetValue(), and TiXmlText::TiXmlText().

virtual void TiXmlNode::StreamIn ( TIXML_ISTREAM *  in,
TIXML_STRING *  tag 
) [protected, pure virtual]

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

Referenced by operator>>(), TiXmlElement::StreamIn(), and TiXmlDocument::StreamIn().

TIXML_STRING TiXmlNode::SValue (  )  const [inline, protected]

Definition at line 494 of file tinyxml.h.

References value.

Referenced by FirstChild(), LastChild(), NextSibling(), and PreviousSibling().

TiXmlComment* TiXmlNode::ToComment (  )  const [inline]

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

Definition at line 467 of file tinyxml.h.

References COMMENT, and type.

TiXmlDeclaration* TiXmlNode::ToDeclaration (  )  const [inline]

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

Definition at line 470 of file tinyxml.h.

References DECLARATION, and type.

TiXmlDocument* TiXmlNode::ToDocument (  )  const [inline]

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

Definition at line 465 of file tinyxml.h.

References DOCUMENT, and type.

Referenced by GetDocument().

TiXmlElement* TiXmlNode::ToElement (  )  const [inline]

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

Definition at line 466 of file tinyxml.h.

References ELEMENT, and type.

Referenced by FirstChildElement(), NextSiblingElement(), TiXmlDocument::StreamIn(), and TiXmlDocument::StreamOut().

TiXmlText* TiXmlNode::ToText (  )  const [inline]

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

Definition at line 469 of file tinyxml.h.

References TEXT, and type.

Referenced by TiXmlElement::Print().

TiXmlUnknown* TiXmlNode::ToUnknown (  )  const [inline]

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

Definition at line 468 of file tinyxml.h.

References type, and UNKNOWN.

virtual int TiXmlNode::Type (  )  const [inline, virtual]

Query the type (as an enumerated value, above) of this node.

Definition at line 455 of file tinyxml.h.

References type.

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

References value.

Referenced by TiXmlElement::Clone(), and Ogre::DotSceneLoader::parseDotScene().

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.

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.

friend class TiXmlDocument [friend]

Reimplemented from TiXmlBase.

Definition at line 264 of file tinyxml.h.

friend class TiXmlElement [friend]

Reimplemented from TiXmlBase.

Reimplemented in TiXmlText.

Definition at line 265 of file tinyxml.h.

Referenced by Identify().

Field Documentation

TiXmlNode* TiXmlNode::firstChild [protected]

Definition at line 499 of file tinyxml.h.

Referenced by Clear(), TiXmlDocument::Clone(), TiXmlElement::Clone(), FirstChild(), InsertBeforeChild(), LinkEndChild(), NoChildren(), TiXmlElement::Print(), RemoveChild(), ReplaceChild(), TiXmlElement::StreamOut(), TiXmlElement::TiXmlElement(), TiXmlNode(), and ~TiXmlNode().

TiXmlNode* TiXmlNode::lastChild [protected]

Definition at line 500 of file tinyxml.h.

Referenced by Clear(), InsertAfterChild(), LastChild(), LinkEndChild(), TiXmlElement::Print(), RemoveChild(), ReplaceChild(), TiXmlElement::TiXmlElement(), and TiXmlNode().

TiXmlNode* TiXmlNode::next [protected]

Definition at line 505 of file tinyxml.h.

Referenced by Clear(), FirstChild(), InsertAfterChild(), InsertBeforeChild(), LinkEndChild(), NextSibling(), RemoveChild(), ReplaceChild(), TiXmlNode(), and ~TiXmlNode().

TiXmlNode* TiXmlNode::parent [protected]

Definition at line 496 of file tinyxml.h.

Referenced by GetDocument(), Identify(), InsertAfterChild(), InsertBeforeChild(), IterateChildren(), LinkEndChild(), Parent(), RemoveChild(), ReplaceChild(), and TiXmlNode().

TiXmlNode* TiXmlNode::prev [protected]

Definition at line 504 of file tinyxml.h.

Referenced by InsertAfterChild(), InsertBeforeChild(), LastChild(), LinkEndChild(), PreviousSibling(), RemoveChild(), ReplaceChild(), and TiXmlNode().

NodeType TiXmlNode::type [protected]

Definition at line 497 of file tinyxml.h.

Referenced by TiXmlNode(), ToComment(), ToDeclaration(), ToDocument(), ToElement(), ToText(), ToUnknown(), and Type().

void* TiXmlNode::userData [protected]

Definition at line 506 of file tinyxml.h.

Referenced by CopyToClone(), GetUserData(), SetUserData(), and TiXmlNode().

TIXML_STRING TiXmlNode::value [protected]

Definition at line 502 of file tinyxml.h.

Referenced by TiXmlText::Blank(), CopyToClone(), TiXmlText::Parse(), TiXmlComment::Parse(), TiXmlUnknown::Parse(), TiXmlElement::Parse(), SetValue(), SValue(), TiXmlElement::TiXmlElement(), and Value().

The documentation for this class was generated from the following files:
Generated on Sun Nov 23 04:12:57 2008 for Sofa by  doxygen 1.5.7.1