rospack_tinyxml::TiXmlNode Class Reference

#include <tinyxml.h>

Inheritance diagram for rospack_tinyxml::TiXmlNode:
Inheritance graph
[legend]

List of all members.

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 TiXmlNodeClone () const =0
TiXmlNodeFirstChild (const char *_value)
 The first child of this node with the matching 'value'. Will be null if none found.
const TiXmlNodeFirstChild (const char *value) const
TiXmlNodeFirstChild ()
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
TiXmlElementFirstChildElement (const char *_value)
const TiXmlElementFirstChildElement (const char *_value) const
 Convenience function to get through elements.
TiXmlElementFirstChildElement ()
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
TiXmlDocumentGetDocument ()
const TiXmlDocumentGetDocument () const
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
TiXmlNodeIterateChildren (const char *_value, const TiXmlNode *previous)
const TiXmlNodeIterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
TiXmlNodeIterateChildren (const TiXmlNode *previous)
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
TiXmlNodeLastChild (const char *_value)
 The last child of this node matching 'value'. Will be null if there are no children.
const TiXmlNodeLastChild (const char *value) const
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children.
const TiXmlNodeLastChild () const
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
TiXmlNodeNextSibling (const char *_next)
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlNodeNextSibling ()
const TiXmlNodeNextSibling () const
 Navigate to a sibling node.
TiXmlElementNextSiblingElement (const char *_next)
const TiXmlElementNextSiblingElement (const char *) const
TiXmlElementNextSiblingElement ()
const TiXmlElementNextSiblingElement () const
bool NoChildren () const
 Returns true if this node has no children.
const TiXmlNodeParent () const
TiXmlNodeParent ()
 One step up the DOM.
TiXmlNodePreviousSibling (const char *_prev)
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
TiXmlNodePreviousSibling ()
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
void SetValue (const char *_value)
virtual TiXmlCommentToComment ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlCommentToComment () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlElementToElement ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlElementToElement () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlTextToText ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlTextToText () const
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlUnknownToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlUnknownToUnknown () const
 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
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
 TiXmlNode (NodeType _type)

Protected Attributes

TiXmlNodefirstChild
TiXmlNodelastChild
TiXmlNodenext
TiXmlNodeparent
TiXmlNodeprev
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 439 of file tinyxml.h.


Member Enumeration Documentation

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

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

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

Definition at line 161 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 542 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 (  )  [inline]

Definition at line 539 of file tinyxml.h.

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

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

Definition at line 687 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 (  )  [inline]

Definition at line 681 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.

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

Definition at line 706 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.

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.

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

Definition at line 585 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 TiXmlNode previous  )  [inline]

Definition at line 579 of file tinyxml.h.

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::LastChild ( const char *  _value  )  [inline]

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

Definition at line 551 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 (  )  [inline]

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

Definition at line 548 of file tinyxml.h.

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

Definition at line 547 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.

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

Definition at line 652 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 (  )  [inline]

Definition at line 648 of file tinyxml.h.

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

Navigate to a sibling node.

Definition at line 647 of file tinyxml.h.

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

Definition at line 670 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 (  )  [inline]

Definition at line 661 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.

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

Returns true if this node has no children.

Definition at line 711 of file tinyxml.h.

void rospack_tinyxml::TiXmlNode::operator= ( const TiXmlNode base  )  [private]
const TiXmlNode* rospack_tinyxml::TiXmlNode::Parent (  )  const [inline]

Definition at line 536 of file tinyxml.h.

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

One step up the DOM.

Definition at line 535 of file tinyxml.h.

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

Definition at line 635 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 (  )  [inline]

Definition at line 631 of file tinyxml.h.

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

Navigate to a sibling node.

Definition at line 630 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 524 of file tinyxml.h.

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

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

Reimplemented in rospack_tinyxml::TiXmlComment.

Definition at line 722 of file tinyxml.h.

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

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

Reimplemented in rospack_tinyxml::TiXmlComment.

Definition at line 715 of file tinyxml.h.

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

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

Reimplemented in rospack_tinyxml::TiXmlDeclaration.

Definition at line 725 of file tinyxml.h.

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

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

Reimplemented in rospack_tinyxml::TiXmlDeclaration.

Definition at line 718 of file tinyxml.h.

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

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

Reimplemented in rospack_tinyxml::TiXmlDocument.

Definition at line 720 of file tinyxml.h.

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

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

Reimplemented in rospack_tinyxml::TiXmlDocument.

Definition at line 713 of file tinyxml.h.

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

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

Reimplemented in rospack_tinyxml::TiXmlElement.

Definition at line 721 of file tinyxml.h.

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

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

Reimplemented in rospack_tinyxml::TiXmlElement.

Definition at line 714 of file tinyxml.h.

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

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

Reimplemented in rospack_tinyxml::TiXmlText.

Definition at line 724 of file tinyxml.h.

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

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

Reimplemented in rospack_tinyxml::TiXmlText.

Definition at line 717 of file tinyxml.h.

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

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

Reimplemented in rospack_tinyxml::TiXmlUnknown.

Definition at line 723 of file tinyxml.h.

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

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

Reimplemented in rospack_tinyxml::TiXmlUnknown.

Definition at line 716 of file tinyxml.h.

int rospack_tinyxml::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 700 of file tinyxml.h.

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

const TIXML_STRING& rospack_tinyxml::TiXmlNode::ValueTStr (  )  const [inline]

Definition at line 513 of file tinyxml.h.


Friends And Related Function Documentation

friend class TiXmlDocument [friend]

Reimplemented from rospack_tinyxml::TiXmlBase.

Definition at line 441 of file tinyxml.h.

friend class TiXmlElement [friend]

Reimplemented from rospack_tinyxml::TiXmlBase.

Reimplemented in rospack_tinyxml::TiXmlText.

Definition at line 442 of file tinyxml.h.


Member Data Documentation

Definition at line 774 of file tinyxml.h.

Definition at line 775 of file tinyxml.h.

Definition at line 780 of file tinyxml.h.

Definition at line 771 of file tinyxml.h.

Definition at line 779 of file tinyxml.h.

Definition at line 772 of file tinyxml.h.

TIXML_STRING rospack_tinyxml::TiXmlNode::value [protected]

Definition at line 777 of file tinyxml.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


rospack
Author(s): Morgan Quigley, Brian Gerkey
autogenerated on Fri Jan 11 11:39:45 2013