DD4hep - The AIDA detector description toolkit for high energy physics experiments
DD4hep  Rev:Unversioneddirectory
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
TiXmlNode Class Referenceabstract

TinyXML class. See http://www.grinninglizard.com/tinyxml. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlNode:
TiXmlBase TiXmlComment TiXmlDeclaration TiXmlDocument TiXmlElement TiXmlText TiXmlUnknown

Public Types

enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 
- Public Types inherited from 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_PARSING_CDATA,
  TIXML_ERROR_DOCUMENT_TOP_ONLY, TIXML_ERROR_STRING_COUNT
}
 

Public Member Functions

virtual ~TiXmlNode ()
 
const char * Value () const
 
const std::string & ValueStr () const
 
void SetValue (const char *_value)
 
void SetValue (const std::string &_value)
 STL std::string form. More...
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'. More...
 
TiXmlNodeParent ()
 One step up the DOM. More...
 
const TiXmlNodeParent () const
 
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children. More...
 
TiXmlNodeFirstChild ()
 
const TiXmlNodeFirstChild (const char *value) const
 
TiXmlNodeFirstChild (const char *_value)
 The first child of this node with the matching 'value'. Will be null if none found. More...
 
const TiXmlNodeLastChild () const
 
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children. More...
 
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. More...
 
const TiXmlNodeFirstChild (const std::string &_value) const
 STL std::string form. More...
 
TiXmlNodeFirstChild (const std::string &_value)
 STL std::string form. More...
 
const TiXmlNodeLastChild (const std::string &_value) const
 STL std::string form. More...
 
TiXmlNodeLastChild (const std::string &_value)
 STL std::string form. More...
 
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
 
TiXmlNodeIterateChildren (const TiXmlNode *previous)
 
const TiXmlNodeIterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'. More...
 
TiXmlNodeIterateChildren (const char *_value, const TiXmlNode *previous)
 
const TiXmlNodeIterateChildren (const std::string &_value, const TiXmlNode *previous) const
 STL std::string form. More...
 
TiXmlNodeIterateChildren (const std::string &_value, const TiXmlNode *previous)
 STL std::string form. More...
 
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
 
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
 
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node. More...
 
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node. More...
 
TiXmlNodePreviousSibling ()
 
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node. More...
 
TiXmlNodePreviousSibling (const char *_prev)
 
const TiXmlNodePreviousSibling (const std::string &_value) const
 STL std::string form. More...
 
TiXmlNodePreviousSibling (const std::string &_value)
 STL std::string form. More...
 
const TiXmlNodeNextSibling (const std::string &_value) const
 STL std::string form. More...
 
TiXmlNodeNextSibling (const std::string &_value)
 STL std::string form. More...
 
const TiXmlNodeNextSibling () const
 Navigate to a sibling node. More...
 
TiXmlNodeNextSibling ()
 
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'. More...
 
TiXmlNodeNextSibling (const char *_next)
 
const TiXmlElementNextSiblingElement () const
 
TiXmlElementNextSiblingElement ()
 
const TiXmlElementNextSiblingElement (const char *) const
 
TiXmlElementNextSiblingElement (const char *_next)
 
const TiXmlElementPreviousSiblingElement () const
 
TiXmlElementPreviousSiblingElement ()
 
const TiXmlElementPreviousSiblingElement (const char *) const
 
TiXmlElementPreviousSiblingElement (const char *_next)
 
const TiXmlElementNextSiblingElement (const std::string &_value) const
 STL std::string form. More...
 
TiXmlElementNextSiblingElement (const std::string &_value)
 STL std::string form. More...
 
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements. More...
 
TiXmlElementFirstChildElement ()
 
const TiXmlElementFirstChildElement (const char *_value) const
 Convenience function to get through elements. More...
 
TiXmlElementFirstChildElement (const char *_value)
 
const TiXmlElementFirstChildElement (const std::string &_value) const
 STL std::string form. More...
 
TiXmlElementFirstChildElement (const std::string &_value)
 STL std::string form. More...
 
int Type () const
 
const TiXmlDocumentGetDocument () const
 
TiXmlDocumentGetDocument ()
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
virtual const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlElementToElement () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlCommentToComment () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlTextToText () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlElementToElement ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlCommentToComment ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlUnknownToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlTextToText ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlNodeClone () const =0
 
virtual bool Accept (TiXmlVisitor *visitor) const =0
 
- Public Member Functions inherited from TiXmlBase
 TiXmlBase ()
 
virtual ~TiXmlBase ()
 
virtual void Print (FILE *cfile, int depth) const =0
 
int Row () const
 
int Column () const
 See Row() More...
 
void SetUserData (void *user)
 Set a pointer to arbitrary user data. More...
 
void * GetUserData ()
 Get a pointer to arbitrary user data. More...
 
const void * GetUserData () const
 Get a pointer to arbitrary user data. More...
 
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 (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
 
- Protected Attributes inherited from TiXmlBase
TiXmlCursor location
 
void * userData
 Field containing a generic user pointer. More...
 

Private Member Functions

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

Friends

class TiXmlDocument
 
class TiXmlElement
 
std::istream & operator>> (std::istream &in, TiXmlNode &base)
 
std::ostream & operator<< (std::ostream &out, const TiXmlNode &base)
 
std::string & operator<< (std::string &out, const TiXmlNode &base)
 Appends the XML node or attribute to a std::string. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting. More...
 
- Static Public Attributes inherited from TiXmlBase
static const int utf8ByteTable [256]
 
- Static Protected Member Functions inherited from TiXmlBase
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
 
static bool IsWhiteSpace (char c)
 
static bool IsWhiteSpace (int c)
 
static bool StreamWhiteSpace (std::istream *in, TIXML_STRING *tag)
 
static bool StreamTo (std::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_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 TiXmlBase
static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

Detailed Description

TinyXML class. See http://www.grinninglizard.com/tinyxml.

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.

See

See Also
http://www.grinninglizard.com/tinyxml

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

Constructor & Destructor Documentation

TiXmlNode::~TiXmlNode ( )
virtual

Definition at line 137 of file tinyxml_inl.h.

References firstChild, and next.

TiXmlNode::TiXmlNode ( NodeType  _type)
protected

Definition at line 126 of file tinyxml_inl.h.

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

TiXmlNode::TiXmlNode ( const TiXmlNode )
private

Member Function Documentation

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

void TiXmlNode::Clear ( )

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

Definition at line 156 of file tinyxml_inl.h.

References firstChild, lastChild, and next.

Referenced by TiXmlElement::ClearThis(), TiXmlDocument::LoadFile(), TiXmlComment::operator=(), TiXmlDeclaration::operator=(), and TiXmlDocument::operator=().

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

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

void TiXmlNode::CopyTo ( TiXmlNode target) const
protected
const TiXmlNode* TiXmlNode::FirstChild ( ) const
inline
TiXmlNode* TiXmlNode::FirstChild ( )
inline

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

Definition at line 327 of file tinyxml_inl.h.

References firstChild, next, and Value().

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

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

STL std::string form.

Definition at line 558 of file tinyxml.h.

References FirstChild().

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

STL std::string form.

Definition at line 561 of file tinyxml.h.

References FirstChild().

const TiXmlElement * TiXmlNode::FirstChildElement ( ) const

Convenience function to get through elements.

Definition at line 418 of file tinyxml_inl.h.

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

Referenced by FirstChildElement(), and TiXmlDocument::RootElement().

TiXmlElement* TiXmlNode::FirstChildElement ( )
inline

Definition at line 732 of file tinyxml.h.

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

Convenience function to get through elements.

Definition at line 433 of file tinyxml_inl.h.

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

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

Definition at line 738 of file tinyxml.h.

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

STL std::string form.

Definition at line 743 of file tinyxml.h.

References FirstChildElement().

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

STL std::string form.

Definition at line 746 of file tinyxml.h.

References FirstChildElement().

const TiXmlDocument * TiXmlNode::GetDocument ( ) const

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

Definition at line 507 of file tinyxml_inl.h.

References parent, and ToDocument().

Referenced by Identify(), InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), LinkEndChild(), TiXmlElement::Parse(), TiXmlComment::Parse(), TiXmlText::Parse(), TiXmlDeclaration::Parse(), TiXmlUnknown::Parse(), TiXmlElement::ReadValue(), and TiXmlElement::SetAttribute().

TiXmlDocument* TiXmlNode::GetDocument ( )
inline

Definition at line 763 of file tinyxml.h.

TiXmlNode * TiXmlNode::Identify ( const char *  start,
TiXmlEncoding  encoding 
)
protected
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 245 of file tinyxml_inl.h.

References Clone(), DOCUMENT, GetDocument(), lastChild, next, parent, prev, TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and Type().

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 213 of file tinyxml_inl.h.

References Clone(), DOCUMENT, firstChild, GetDocument(), next, parent, prev, TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and Type().

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 198 of file tinyxml_inl.h.

References Clone(), DOCUMENT, GetDocument(), LinkEndChild(), TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and Type().

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.

Definition at line 351 of file tinyxml_inl.h.

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

Referenced by IterateChildren().

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

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

Definition at line 365 of file tinyxml_inl.h.

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

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

Definition at line 595 of file tinyxml.h.

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

STL std::string form.

Definition at line 600 of file tinyxml.h.

References IterateChildren().

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

STL std::string form.

Definition at line 603 of file tinyxml.h.

References IterateChildren().

const TiXmlNode* TiXmlNode::LastChild ( ) const
inline

Definition at line 545 of file tinyxml.h.

References lastChild.

Referenced by LastChild(), and TiXmlPrinter::VisitEnter().

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

References lastChild.

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

Definition at line 339 of file tinyxml_inl.h.

References lastChild, prev, and Value().

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

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

STL std::string form.

Definition at line 564 of file tinyxml.h.

References LastChild().

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

STL std::string form.

Definition at line 567 of file tinyxml.h.

References LastChild().

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

Definition at line 171 of file tinyxml_inl.h.

References DOCUMENT, firstChild, GetDocument(), lastChild, next, parent, prev, TiXmlDocument::SetError(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_DOCUMENT_TOP_ONLY, and Type().

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

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

STL std::string form.

Definition at line 666 of file tinyxml.h.

References NextSibling().

const TiXmlNode* TiXmlNode::NextSibling ( ) const
inline

Navigate to a sibling node.

Definition at line 672 of file tinyxml.h.

References next.

Referenced by NextSibling(), and NextSiblingElement().

TiXmlNode* TiXmlNode::NextSibling ( )
inline

Definition at line 675 of file tinyxml.h.

References next.

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

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

Definition at line 379 of file tinyxml_inl.h.

References next, and Value().

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

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

Definition at line 448 of file tinyxml_inl.h.

References NextSibling(), and ToElement().

Referenced by TiXmlHandle::ChildElement(), and NextSiblingElement().

TiXmlElement* TiXmlNode::NextSiblingElement ( )
inline

Definition at line 690 of file tinyxml.h.

const 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 463 of file tinyxml_inl.h.

References NextSibling(), and ToElement().

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

Definition at line 699 of file tinyxml.h.

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

STL std::string form.

Definition at line 722 of file tinyxml.h.

References NextSiblingElement().

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

STL std::string form.

Definition at line 725 of file tinyxml.h.

References NextSiblingElement().

bool TiXmlNode::NoChildren ( ) const
inline

Returns true if this node has no children.

Definition at line 768 of file tinyxml.h.

References firstChild.

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

One step up the DOM.

Definition at line 525 of file tinyxml.h.

References parent.

const TiXmlNode* TiXmlNode::Parent ( ) const
inline

Definition at line 528 of file tinyxml.h.

References parent.

const TiXmlNode* TiXmlNode::PreviousSibling ( ) const
inline

Navigate to a sibling node.

Definition at line 643 of file tinyxml.h.

References prev.

Referenced by PreviousSibling(), and PreviousSiblingElement().

TiXmlNode* TiXmlNode::PreviousSibling ( )
inline

Definition at line 646 of file tinyxml.h.

References prev.

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

Navigate to a sibling node.

Definition at line 391 of file tinyxml_inl.h.

References prev, and Value().

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

Definition at line 652 of file tinyxml.h.

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

STL std::string form.

Definition at line 657 of file tinyxml.h.

References PreviousSibling().

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

STL std::string form.

Definition at line 660 of file tinyxml.h.

References PreviousSibling().

const TiXmlElement * TiXmlNode::PreviousSiblingElement ( ) const

Convenience function to get through elements. Calls PreviousSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

Definition at line 478 of file tinyxml_inl.h.

References PreviousSibling(), and ToElement().

TiXmlElement* TiXmlNode::PreviousSiblingElement ( )
inline

Definition at line 708 of file tinyxml.h.

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

Convenience function to get through elements. Calls PreviousSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

Definition at line 492 of file tinyxml_inl.h.

References PreviousSibling(), and ToElement().

TiXmlElement* TiXmlNode::PreviousSiblingElement ( const char *  _next)
inline

Definition at line 717 of file tinyxml.h.

bool TiXmlNode::RemoveChild ( TiXmlNode removeThis)

Delete a child of this node.

Definition at line 305 of file tinyxml_inl.h.

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 277 of file tinyxml_inl.h.

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

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

References value.

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

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

STL std::string form.

Definition at line 516 of file tinyxml.h.

virtual void TiXmlNode::StreamIn ( std::istream *  in,
TIXML_STRING tag 
)
protectedpure virtual
virtual const TiXmlComment* TiXmlNode::ToComment ( ) const
inlinevirtual

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

Reimplemented in TiXmlComment.

Definition at line 778 of file tinyxml.h.

virtual TiXmlComment* TiXmlNode::ToComment ( )
inlinevirtual

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

Reimplemented in TiXmlComment.

Definition at line 797 of file tinyxml.h.

virtual const TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) const
inlinevirtual

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

Reimplemented in TiXmlDeclaration.

Definition at line 787 of file tinyxml.h.

Referenced by TiXmlDocument::Parse().

virtual TiXmlDeclaration* TiXmlNode::ToDeclaration ( )
inlinevirtual

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

Reimplemented in TiXmlDeclaration.

Definition at line 806 of file tinyxml.h.

virtual const TiXmlDocument* TiXmlNode::ToDocument ( ) const
inlinevirtual

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

Reimplemented in TiXmlDocument.

Definition at line 772 of file tinyxml.h.

Referenced by GetDocument().

virtual TiXmlDocument* TiXmlNode::ToDocument ( )
inlinevirtual

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

Reimplemented in TiXmlDocument.

Definition at line 791 of file tinyxml.h.

virtual const TiXmlElement* TiXmlNode::ToElement ( ) const
inlinevirtual

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

Reimplemented in TiXmlElement.

Definition at line 775 of file tinyxml.h.

Referenced by DD4hep::XML::Handle_t::checksum(), FirstChildElement(), NextSiblingElement(), PreviousSiblingElement(), and TiXmlHandle::ToElement().

virtual TiXmlElement* TiXmlNode::ToElement ( )
inlinevirtual

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

Reimplemented in TiXmlElement.

Definition at line 794 of file tinyxml.h.

virtual const TiXmlText* TiXmlNode::ToText ( ) const
inlinevirtual

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

Reimplemented in TiXmlText.

Definition at line 784 of file tinyxml.h.

Referenced by DD4hep::XML::Handle_t::checksum(), TiXmlElement::GetText(), TiXmlElement::Print(), TiXmlHandle::ToText(), and TiXmlPrinter::VisitEnter().

virtual TiXmlText* TiXmlNode::ToText ( )
inlinevirtual

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

Reimplemented in TiXmlText.

Definition at line 803 of file tinyxml.h.

virtual const TiXmlUnknown* TiXmlNode::ToUnknown ( ) const
inlinevirtual

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

Reimplemented in TiXmlUnknown.

Definition at line 781 of file tinyxml.h.

Referenced by TiXmlHandle::ToUnknown().

virtual TiXmlUnknown* TiXmlNode::ToUnknown ( )
inlinevirtual

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

Reimplemented in TiXmlUnknown.

Definition at line 800 of file tinyxml.h.

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

References type.

Referenced by DD4hep::XML::Handle_t::checksum(), InsertAfterChild(), InsertBeforeChild(), InsertEndChild(), and LinkEndChild().

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

References value.

Referenced by DD4hep::XML::Handle_t::checksum(), TiXmlElement::Clone(), FirstChild(), TiXmlElement::GetText(), LastChild(), TiXmlDocument::LoadFile(), NextSibling(), PreviousSibling(), TiXmlDocument::SaveFile(), TiXmlPrinter::Visit(), TiXmlPrinter::VisitEnter(), and TiXmlPrinter::VisitExit().

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

References value.

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

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

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

Definition at line 432 of file tinyxml.h.

friend class TiXmlElement
friend

Definition at line 433 of file tinyxml.h.

Referenced by Identify().

Member Data Documentation

TiXmlNode* TiXmlNode::firstChild
protected
TiXmlNode* TiXmlNode::lastChild
protected
TiXmlNode* TiXmlNode::next
protected
TiXmlNode* TiXmlNode::parent
protected
TiXmlNode* TiXmlNode::prev
protected
NodeType TiXmlNode::type
protected

Definition at line 855 of file tinyxml.h.

Referenced by TiXmlNode(), Type(), and DD4hep::XML::ChildValue::typeStr().

TIXML_STRING TiXmlNode::value
protected

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