DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
TiXmlElement Class Reference

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

#include <tinyxml.h>

Inheritance diagram for TiXmlElement:
TiXmlNode TiXmlBase

Public Member Functions

 TiXmlElement (const char *in_value)
 Construct an element. More...
 
 TiXmlElement (const std::string &_value)
 std::string constructor. More...
 
 TiXmlElement (const TiXmlElement &)
 
void operator= (const TiXmlElement &base)
 
virtual ~TiXmlElement ()
 
const TiXmlAttributeAttributeNode (const char *name) const
 
const char * Attribute (const char *name) const
 
void ClearAttributes ()
 
const char * Attribute (const char *name, int *i) const
 
const char * Attribute (const char *name, double *d) const
 
int QueryIntAttribute (const char *name, int *_value) const
 
int QueryDoubleAttribute (const char *name, double *_value) const
 QueryDoubleAttribute examines the attribute - see QueryIntAttribute(). More...
 
int QueryFloatAttribute (const char *name, float *_value) const
 QueryFloatAttribute examines the attribute - see QueryIntAttribute(). More...
 
template<typename T >
int QueryValueAttribute (const std::string &name, T *outValue) const
 
void SetAttribute (const char *name, const char *_value)
 
const std::string * Attribute (const std::string &name) const
 
const std::string * Attribute (const std::string &name, int *i) const
 
const std::string * Attribute (const std::string &name, double *d) const
 
int QueryIntAttribute (const std::string &name, int *_value) const
 
int QueryDoubleAttribute (const std::string &name, double *_value) const
 
void SetAttribute (const std::string &name, const std::string &_value)
 STL std::string form. More...
 
void SetAttribute (const std::string &name, int _value)
 
void SetAttribute (const char *name, int value)
 
void SetDoubleAttribute (const char *name, double value)
 
void RemoveAttribute (const char *name)
 
void RemoveAttribute (const std::string &name)
 STL std::string form. More...
 
const TiXmlAttributeFirstAttribute () const
 Access the first attribute in this element. More...
 
TiXmlAttributeFirstAttribute ()
 
const TiXmlAttributeLastAttribute () const
 Access the last attribute in this element. More...
 
TiXmlAttributeLastAttribute ()
 
const char * GetText () const
 
virtual TiXmlNodeClone () const override
 Creates a new Element and returns it - the returned element is a copy. More...
 
virtual void Print (FILE *cfile, int depth) const override
 
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding) override
 
virtual const TiXmlElementToElement () const override
 Cast to a more defined type. Will return null not of the requested type. More...
 
virtual TiXmlElementToElement () override
 Cast to a more defined type. Will return null not of the requested type. More...
 
virtual bool Accept (TiXmlVisitor *visitor) const override
 
- Public Member Functions inherited from TiXmlNode
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 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 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...
 
- Public Member Functions inherited from TiXmlBase
 TiXmlBase ()
 
virtual ~TiXmlBase ()
 
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...
 

Protected Member Functions

void CopyTo (TiXmlElement *target) const
 
void ClearThis ()
 
virtual void StreamIn (std::istream *in, TIXML_STRING *tag) override
 
const char * ReadValue (const char *in, TiXmlParsingData *prevData, TiXmlEncoding encoding)
 
- Protected Member Functions inherited from TiXmlNode
 TiXmlNode (NodeType _type)
 
void CopyTo (TiXmlNode *target) const
 
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
 

Private Attributes

TiXmlAttributeSet attributeSet
 

Additional Inherited Members

- Public Types inherited from TiXmlNode
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
}
 
- 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)
 
- Protected Attributes inherited from TiXmlNode
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...
 
- 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 element is a container class. It has a value, the element name, and can contain other elements, text, comments, and unknowns. Elements also contain an arbitrary number of attributes.

See

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

Definition at line 1069 of file tinyxml.h.

Constructor & Destructor Documentation

◆ TiXmlElement() [1/3]

TiXmlElement::TiXmlElement ( const char *  in_value)

Construct an element.

Definition at line 523 of file tinyxml_inl.h.

◆ TiXmlElement() [2/3]

TiXmlElement::TiXmlElement ( const std::string &  _value)

std::string constructor.

◆ TiXmlElement() [3/3]

TiXmlElement::TiXmlElement ( const TiXmlElement copy)

Definition at line 541 of file tinyxml_inl.h.

◆ ~TiXmlElement()

TiXmlElement::~TiXmlElement ( )
virtual

Definition at line 556 of file tinyxml_inl.h.

Member Function Documentation

◆ Accept()

bool TiXmlElement::Accept ( TiXmlVisitor visitor) const
overridevirtual

Walk the XML tree visiting this node and all of its children.

Implements TiXmlNode.

Definition at line 875 of file tinyxml_inl.h.

◆ Attribute() [1/6]

const char * TiXmlElement::Attribute ( const char *  name) const

Given an attribute name, Attribute() returns the attribute value with that name, or null if none exists.

Definition at line 584 of file tinyxml_inl.h.

◆ Attribute() [2/6]

const char * TiXmlElement::Attribute ( const char *  name,
double *  d 
) const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. If the attribute exists and can be converted to an double, the double value will be put in the return 'd', if 'd' is non-null.

Definition at line 638 of file tinyxml_inl.h.

◆ Attribute() [3/6]

const char * TiXmlElement::Attribute ( const char *  name,
int *  i 
) const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. If the attribute exists and can be converted to an integer, the integer value will be put in the return 'i', if 'i' is non-null.

Definition at line 604 of file tinyxml_inl.h.

◆ Attribute() [4/6]

const std::string* TiXmlElement::Attribute ( const std::string &  name) const

◆ Attribute() [5/6]

const std::string* TiXmlElement::Attribute ( const std::string &  name,
double *  d 
) const

◆ Attribute() [6/6]

const std::string* TiXmlElement::Attribute ( const std::string &  name,
int *  i 
) const

◆ AttributeNode()

const TiXmlAttribute* TiXmlElement::AttributeNode ( const char *  name) const
inline

Given an attribute name, Attribute() returns the attribute with that name, or null if none exists.

Definition at line 1088 of file tinyxml.h.

◆ ClearAttributes()

void TiXmlElement::ClearAttributes ( )

Clear all attribute nodes of this node.

Definition at line 573 of file tinyxml_inl.h.

◆ ClearThis()

void TiXmlElement::ClearThis ( )
protected

Definition at line 562 of file tinyxml_inl.h.

◆ Clone()

TiXmlNode * TiXmlElement::Clone ( ) const
overridevirtual

Creates a new Element and returns it - the returned element is a copy.

Implements TiXmlNode.

Definition at line 889 of file tinyxml_inl.h.

◆ CopyTo()

void TiXmlElement::CopyTo ( TiXmlElement target) const
protected

Definition at line 853 of file tinyxml_inl.h.

◆ FirstAttribute() [1/2]

TiXmlAttribute* TiXmlElement::FirstAttribute ( )
inline

Definition at line 1196 of file tinyxml.h.

◆ FirstAttribute() [2/2]

const TiXmlAttribute* TiXmlElement::FirstAttribute ( ) const
inline

Access the first attribute in this element.

Definition at line 1193 of file tinyxml.h.

◆ GetText()

const char * TiXmlElement::GetText ( ) const

Convenience function for easy access to the text inside an element. Although easy and concise, GetText() is limited compared to getting the TiXmlText child and accessing it directly.

If the first child of 'this' is a TiXmlText, the GetText() returns the character string of the Text node, else null is returned.

This is a convenient method for getting the text of simple contained text:

<foo>This is text</foo>
const char* str = fooElement->GetText();

'str' will be a pointer to "This is text".

Note that this function can be misleading. If the element foo was created from this XML:

<foo><b>This is text</b></foo>

then the value of str would be null. The first child node isn't a text node, it is another element. From this XML:

<foo>This is <b>text</b></foo>

GetText() will return "This is ".

WARNING: GetText() accesses a child node - don't become confused with the similarly named TiXmlHandle_t::Text() and TiXmlNode::ToText() which are safe type casts on the referenced node.

Definition at line 900 of file tinyxml_inl.h.

◆ LastAttribute() [1/2]

TiXmlAttribute* TiXmlElement::LastAttribute ( )
inline

Definition at line 1202 of file tinyxml.h.

◆ LastAttribute() [2/2]

const TiXmlAttribute* TiXmlElement::LastAttribute ( ) const
inline

Access the last attribute in this element.

Definition at line 1199 of file tinyxml.h.

◆ operator=()

void TiXmlElement::operator= ( const TiXmlElement base)

Definition at line 549 of file tinyxml_inl.h.

◆ Parse()

const char * TiXmlElement::Parse ( const char *  p,
TiXmlParsingData data,
TiXmlEncoding  encoding 
)
overridevirtual

Implements TiXmlBase.

Definition at line 1078 of file tinyxmlparser_inl.h.

◆ Print()

void TiXmlElement::Print ( FILE *  cfile,
int  depth 
) const
overridevirtual

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements TiXmlBase.

Definition at line 800 of file tinyxml_inl.h.

◆ QueryDoubleAttribute() [1/2]

int TiXmlElement::QueryDoubleAttribute ( const char *  name,
double *  _value 
) const

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

Definition at line 692 of file tinyxml_inl.h.

◆ QueryDoubleAttribute() [2/2]

int TiXmlElement::QueryDoubleAttribute ( const std::string &  name,
double *  _value 
) const

◆ QueryFloatAttribute()

int TiXmlElement::QueryFloatAttribute ( const char *  name,
float *  _value 
) const
inline

QueryFloatAttribute examines the attribute - see QueryIntAttribute().

Definition at line 1128 of file tinyxml.h.

◆ QueryIntAttribute() [1/2]

int TiXmlElement::QueryIntAttribute ( const char *  name,
int *  _value 
) const

QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking. If the attribute is an integer, it is stored in 'value' and the call returns TIXML_SUCCESS. If it is not an integer, it returns TIXML_WRONG_TYPE. If the attribute does not exist, then TIXML_NO_ATTRIBUTE is returned.

Definition at line 672 of file tinyxml_inl.h.

◆ QueryIntAttribute() [2/2]

int TiXmlElement::QueryIntAttribute ( const std::string &  name,
int *  _value 
) const

◆ QueryValueAttribute()

template<typename T >
int TiXmlElement::QueryValueAttribute ( const std::string &  name,
T *  outValue 
) const
inline

Template form of the attribute query which will try to read the attribute into the specified type. Very easy, very powerful, but be careful to make sure to call this with the correct type.

Returns
TIXML_SUCCESS, TIXML_WRONG_TYPE, or TIXML_NO_ATTRIBUTE

Definition at line 1143 of file tinyxml.h.

◆ ReadValue()

const char * TiXmlElement::ReadValue ( const char *  in,
TiXmlParsingData prevData,
TiXmlEncoding  encoding 
)
protected

Definition at line 1202 of file tinyxmlparser_inl.h.

◆ RemoveAttribute() [1/2]

void TiXmlElement::RemoveAttribute ( const char *  name)

Deletes an attribute with the given name.

Definition at line 406 of file tinyxml_inl.h.

◆ RemoveAttribute() [2/2]

void TiXmlElement::RemoveAttribute ( const std::string &  name)
inline

STL std::string form.

Definition at line 1188 of file tinyxml.h.

◆ SetAttribute() [1/4]

void TiXmlElement::SetAttribute ( const char *  name,
const char *  _value 
)

Sets an attribute of name to a given value. The attribute will be created if it does not exist, or changed if it does.

Definition at line 746 of file tinyxml_inl.h.

◆ SetAttribute() [2/4]

void TiXmlElement::SetAttribute ( const char *  name,
int  value 
)

Sets an attribute of name to a given value. The attribute will be created if it does not exist, or changed if it does.

Definition at line 712 of file tinyxml_inl.h.

◆ SetAttribute() [3/4]

void TiXmlElement::SetAttribute ( const std::string &  name,
const std::string &  _value 
)

STL std::string form.

STL std::string form.

◆ SetAttribute() [4/4]

void TiXmlElement::SetAttribute ( const std::string &  name,
int  _value 
)

◆ SetDoubleAttribute()

void TiXmlElement::SetDoubleAttribute ( const char *  name,
double  value 
)

Sets an attribute of name to a given value. The attribute will be created if it does not exist, or changed if it does.

Definition at line 734 of file tinyxml_inl.h.

◆ StreamIn()

virtual void TiXmlElement::StreamIn ( std::istream *  in,
TIXML_STRING tag 
)
overrideprotectedvirtual

Implements TiXmlNode.

◆ ToElement() [1/2]

virtual const TiXmlElement* TiXmlElement::ToElement ( ) const
inlineoverridevirtual

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

Reimplemented from TiXmlNode.

Definition at line 1250 of file tinyxml.h.

◆ ToElement() [2/2]

virtual TiXmlElement* TiXmlElement::ToElement ( )
inlineoverridevirtual

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

Reimplemented from TiXmlNode.

Definition at line 1253 of file tinyxml.h.

Member Data Documentation

◆ attributeSet

TiXmlAttributeSet TiXmlElement::attributeSet
private

Definition at line 1278 of file tinyxml.h.


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