eXperiment robotics framework

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]

List of all members.

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.
const std::string & ValueStr () const
 Return Value() as a std::string.
const TIXML_STRING & ValueTStr () const
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'.
TiXmlNodeParent ()
 One step up the DOM.
const TiXmlNodeParent () const
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
TiXmlNodeFirstChild ()
const TiXmlNodeFirstChild (const char *value) const
 The first child of this node with the matching 'value'.
TiXmlNodeFirstChild (const char *_value)
 The first child of this node with the matching 'value'. Will be null if none found.
const TiXmlNodeLastChild () const
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children.
const TiXmlNodeLastChild (const char *value) const
TiXmlNodeLastChild (const char *_value)
 The last child of this node matching 'value'. Will be null if there are no children.
const TiXmlNodeFirstChild (const std::string &_value) const
 STL std::string form.
TiXmlNodeFirstChild (const std::string &_value)
 STL std::string form.
const TiXmlNodeLastChild (const std::string &_value) const
 STL std::string form.
TiXmlNodeLastChild (const std::string &_value)
 STL std::string form.
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
 An alternate way to walk the children of a node.
TiXmlNodeIterateChildren (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 char *_value, const TiXmlNode *previous)
const TiXmlNodeIterateChildren (const std::string &_value, const TiXmlNode *previous) const
 STL std::string form.
TiXmlNodeIterateChildren (const std::string &_value, const TiXmlNode *previous)
 STL std::string form.
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
 Add a new node related to this.
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 Add a new node related to this.
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 Replace a child of this node.
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node.
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
TiXmlNodePreviousSibling ()
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
TiXmlNodePreviousSibling (const char *_prev)
const TiXmlNodePreviousSibling (const std::string &_value) const
 STL std::string form.
TiXmlNodePreviousSibling (const std::string &_value)
 STL std::string form.
const TiXmlNodeNextSibling (const std::string &_value) const
 STL std::string form.
TiXmlNodeNextSibling (const std::string &_value)
 STL std::string form.
const TiXmlNodeNextSibling () const
 Navigate to a sibling node.
TiXmlNodeNextSibling ()
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
TiXmlNodeNextSibling (const char *_next)
const TiXmlElementNextSiblingElement () const
 Convenience function to get through elements.
TiXmlElementNextSiblingElement ()
const TiXmlElementNextSiblingElement (const char *) const
 Convenience function to get through elements.
TiXmlElementNextSiblingElement (const char *_next)
const TiXmlElementNextSiblingElement (const std::string &_value) const
 STL std::string form.
TiXmlElementNextSiblingElement (const std::string &_value)
 STL std::string form.
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
TiXmlElementFirstChildElement ()
const TiXmlElementFirstChildElement (const char *_value) const
 Convenience function to get through elements.
TiXmlElementFirstChildElement (const char *_value)
const TiXmlElementFirstChildElement (const std::string &_value) const
 STL std::string form.
TiXmlElementFirstChildElement (const std::string &_value)
 STL std::string form.
int Type () const
 Query the type (as an enumerated value, above) of this node.
const TiXmlDocumentGetDocument () const
 Return a pointer to the Document this node lives in.
TiXmlDocumentGetDocument ()
bool NoChildren () const
 Returns true if this node has no children.
virtual const TiXmlDocumentToDocument () const
 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 const TiXmlCommentToComment () const
 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.
virtual const TiXmlTextToText () const
 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 TiXmlElementToElement ()
 Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlCommentToComment ()
 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 TiXmlTextToText ()
 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 TiXmlNodeClone () const =0
 Create an exact duplicate of this node and return it.
virtual bool Accept (TiXmlVisitor *visitor) const =0
 Accept a hierchical visit the nodes in the TinyXML DOM.

Protected Member Functions

 TiXmlNode (NodeType _type)
void CopyTo (TiXmlNode *target) const
virtual void StreamIn (std::istream *in, TIXML_STRING *tag)=0
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)

Protected Attributes

TiXmlNodeparent
NodeType type
TiXmlNodefirstChild
TiXmlNodelastChild
TIXML_STRING value
TiXmlNodeprev
TiXmlNodenext

Private Member Functions

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

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.
std::string & operator<< (std::string &out, const TiXmlNode &base)
 Appends the XML node or attribute to a std::string.


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


Constructor & Destructor Documentation

virtual TiXmlNode::~TiXmlNode (  )  [virtual]

TiXmlNode::TiXmlNode ( NodeType  _type  )  [protected]

TiXmlNode::TiXmlNode ( const TiXmlNode  )  [private]


Member Function Documentation

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

References value.

const std::string& TiXmlNode::ValueStr (  )  const [inline]

Return Value() as a std::string.

If you only use STL, this is more efficient than calling Value(). Only available in STL mode.

Definition at line 499 of file tinyxml.h.

References value.

Referenced by operator<<(), and operator>>().

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

Definition at line 502 of file tinyxml.h.

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

References value.

Referenced by TiXmlComment::TiXmlComment(), and TiXmlText::TiXmlText().

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

STL std::string form.

Definition at line 517 of file tinyxml.h.

void TiXmlNode::Clear (  ) 

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

TiXmlNode* TiXmlNode::Parent (  )  [inline]

One step up the DOM.

Definition at line 524 of file tinyxml.h.

References parent.

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

Definition at line 525 of file tinyxml.h.

References parent.

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

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

Definition at line 527 of file tinyxml.h.

References firstChild.

Referenced by FirstChild(), and tpn::FirstChildText().

TiXmlNode* TiXmlNode::FirstChild (  )  [inline]

Definition at line 528 of file tinyxml.h.

References firstChild.

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

The first child of this node with the matching 'value'.

Will be null if none found.

TiXmlNode* 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 531 of file tinyxml.h.

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

Definition at line 536 of file tinyxml.h.

References lastChild.

Referenced by LastChild().

TiXmlNode* TiXmlNode::LastChild (  )  [inline]

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

Definition at line 537 of file tinyxml.h.

References lastChild.

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

TiXmlNode* 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 540 of file tinyxml.h.

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

STL std::string form.

Definition at line 545 of file tinyxml.h.

References FirstChild().

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

STL std::string form.

Definition at line 546 of file tinyxml.h.

References FirstChild().

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

STL std::string form.

Definition at line 547 of file tinyxml.h.

References LastChild().

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

STL std::string form.

Definition at line 548 of file tinyxml.h.

References LastChild().

const TiXmlNode* 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.

Referenced by IterateChildren().

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

Definition at line 568 of file tinyxml.h.

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

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

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

Definition at line 574 of file tinyxml.h.

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

STL std::string form.

Definition at line 579 of file tinyxml.h.

References IterateChildren().

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

STL std::string form.

Definition at line 580 of file tinyxml.h.

References IterateChildren().

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.

Referenced by tpn::ToXmlElement().

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

Referenced by operator<<().

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.

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.

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.

bool TiXmlNode::RemoveChild ( TiXmlNode removeThis  ) 

Delete a child of this node.

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

Navigate to a sibling node.

Definition at line 619 of file tinyxml.h.

References prev.

Referenced by PreviousSibling().

TiXmlNode* TiXmlNode::PreviousSibling (  )  [inline]

Definition at line 620 of file tinyxml.h.

References prev.

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

Navigate to a sibling node.

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

Definition at line 624 of file tinyxml.h.

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

STL std::string form.

Definition at line 629 of file tinyxml.h.

References PreviousSibling().

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

STL std::string form.

Definition at line 630 of file tinyxml.h.

References PreviousSibling().

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

STL std::string form.

Definition at line 631 of file tinyxml.h.

References NextSibling().

Referenced by tpn::FirstChildText().

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

STL std::string form.

Definition at line 632 of file tinyxml.h.

References NextSibling().

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

Navigate to a sibling node.

Definition at line 636 of file tinyxml.h.

References next.

Referenced by NextSibling().

TiXmlNode* TiXmlNode::NextSibling (  )  [inline]

Definition at line 637 of file tinyxml.h.

References next.

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

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

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

Definition at line 641 of file tinyxml.h.

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

Referenced by tpn::TinyXmlBinding< T, M >::BindingFromXml(), and NextSiblingElement().

TiXmlElement* TiXmlNode::NextSiblingElement (  )  [inline]

Definition at line 650 of file tinyxml.h.

const TiXmlElement* TiXmlNode::NextSiblingElement ( const char *   )  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.

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

Definition at line 659 of file tinyxml.h.

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

STL std::string form.

Definition at line 664 of file tinyxml.h.

References NextSiblingElement().

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

STL std::string form.

Definition at line 665 of file tinyxml.h.

References NextSiblingElement().

const TiXmlElement* TiXmlNode::FirstChildElement (  )  const

Convenience function to get through elements.

Referenced by tpn::TinyXmlBinding< T, M >::BindingFromXml(), FirstChildElement(), operator>>(), and TiXmlDocument::RootElement().

TiXmlElement* TiXmlNode::FirstChildElement (  )  [inline]

Definition at line 670 of file tinyxml.h.

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

Convenience function to get through elements.

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

Definition at line 676 of file tinyxml.h.

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

STL std::string form.

Definition at line 681 of file tinyxml.h.

References FirstChildElement().

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

STL std::string form.

Definition at line 682 of file tinyxml.h.

References FirstChildElement().

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

References type.

const TiXmlDocument* TiXmlNode::GetDocument (  )  const

Return a pointer to the Document this node lives in.

Returns null if not in a document.

TiXmlDocument* TiXmlNode::GetDocument (  )  [inline]

Definition at line 695 of file tinyxml.h.

bool TiXmlNode::NoChildren (  )  const [inline]

Returns true if this node has no children.

Definition at line 700 of file tinyxml.h.

References firstChild.

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

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

Reimplemented in TiXmlDocument.

Definition at line 702 of file tinyxml.h.

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

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

Reimplemented in TiXmlElement.

Definition at line 703 of file tinyxml.h.

Referenced by TiXmlHandle::ToElement().

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

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

Reimplemented in TiXmlComment.

Definition at line 704 of file tinyxml.h.

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

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

Reimplemented in TiXmlUnknown.

Definition at line 705 of file tinyxml.h.

Referenced by TiXmlHandle::ToUnknown().

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

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

Reimplemented in TiXmlText.

Definition at line 706 of file tinyxml.h.

Referenced by tpn::FirstChildText(), and TiXmlHandle::ToText().

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

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

Reimplemented in TiXmlDeclaration.

Definition at line 707 of file tinyxml.h.

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

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

Reimplemented in TiXmlDocument.

Definition at line 709 of file tinyxml.h.

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

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

Reimplemented in TiXmlElement.

Definition at line 710 of file tinyxml.h.

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

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

Reimplemented in TiXmlComment.

Definition at line 711 of file tinyxml.h.

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

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

Reimplemented in TiXmlUnknown.

Definition at line 712 of file tinyxml.h.

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

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

Reimplemented in TiXmlText.

Definition at line 713 of file tinyxml.h.

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

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

Reimplemented in TiXmlDeclaration.

Definition at line 714 of file tinyxml.h.

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

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

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

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

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

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


Friends And Related Function Documentation

friend class TiXmlDocument [friend]

Reimplemented from TiXmlBase.

Definition at line 430 of file tinyxml.h.

friend class TiXmlElement [friend]

Reimplemented from TiXmlBase.

Reimplemented in TiXmlText.

Definition at line 431 of file tinyxml.h.

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.

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::string& operator<< ( std::string &  out,
const TiXmlNode base 
) [friend]

Appends the XML node or attribute to a std::string.


Member Data Documentation

Definition at line 760 of file tinyxml.h.

Referenced by Parent().

Definition at line 761 of file tinyxml.h.

Referenced by Type().

Definition at line 763 of file tinyxml.h.

Referenced by FirstChild(), and NoChildren().

Definition at line 764 of file tinyxml.h.

Referenced by LastChild().

TIXML_STRING TiXmlNode::value [protected]

Definition at line 766 of file tinyxml.h.

Referenced by SetValue(), Value(), ValueStr(), and ValueTStr().

TiXmlNode* TiXmlNode::prev [protected]

Definition at line 768 of file tinyxml.h.

Referenced by PreviousSibling().

TiXmlNode* TiXmlNode::next [protected]

Definition at line 769 of file tinyxml.h.

Referenced by NextSibling().


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

The miarn project - written by Joao Xavier