DataDirector API
Public Member Functions | List of all members
TiXmlElement Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlElement:
TiXmlNode TiXmlBase

Public Member Functions

 TiXmlElement (const char *in_value)
 Construct an element.
 
const char * Attribute (const char *name) const
 
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().
 
int QueryDoubleAttribute (const char *name, float *value) const
 QueryFloatAttribute examines the attribute - see QueryIntAttribute().
 
void SetAttribute (const char *name, const char *value)
 
void SetAttribute (const char *name, int value)
 
void SetDoubleAttribute (const char *name, double value)
 
void RemoveAttribute (const char *name)
 
const TiXmlAttributeFirstAttribute () const
 Access the first attribute in this element.
 
const TiXmlAttributeLastAttribute () const
 Access the last attribute in this element.
 
virtual TiXmlNodeClone () const
 Creates a new Element and returns it - the returned element is a copy.
 
virtual void Print (FILE *cfile, int depth) const
 
- Public Member Functions inherited from TiXmlNode
const char * Value () const
 
void SetValue (const char *_value)
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'.
 
TiXmlNodeParent ()
 One step up the DOM.
 
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children.
 
const TiXmlNodeFirstChild (const char *value) const
 The first child of this node with the matching 'value'. Will be null if none found.
 
TiXmlNodeFirstChild (const char *value)
 The first child of this node with the matching 'value'. Will be null if none found.
 
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children.
 
TiXmlNodeLastChild (const char *value)
 The last child of this node matching 'value'. Will be null if there are no children.
 
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
 
const TiXmlNodeIterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'.
 
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.
 
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node.
 
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node.
 
const TiXmlNodeNextSibling () const
 Navigate to a sibling node.
 
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'.
 
const TiXmlElementNextSiblingElement () const
 
const TiXmlElementNextSiblingElement (const char *) const
 
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements.
 
const TiXmlElementFirstChildElement (const char *value) const
 Convenience function to get through elements.
 
virtual int Type () const
 
const TiXmlDocumentGetDocument () const
 
bool NoChildren () const
 Returns true if this node has no children.
 
const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlElementToElement () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlCommentToComment () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlTextToText () const
 Cast to a more defined type. Will return null not of the requested type.
 
const TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlElementToElement ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlCommentToComment ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlUnknownToUnknown ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlTextToText ()
 Cast to a more defined type. Will return null not of the requested type.
 
TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null not of the requested type.
 
- Public Member Functions inherited from TiXmlBase
int Row () const
 
int Column () const
 See Row()
 

Additional Inherited Members

- Public Types inherited from TiXmlNode
enum  NodeType
 
- Static Public Member Functions inherited from TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
 
- Protected Attributes inherited from TiXmlBase
void * userData
 Field containing a generic user pointer.
 

Detailed Description

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.

Member Function Documentation

const char* Attribute ( const char *  name) const

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

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

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

virtual void Print ( FILE *  cfile,
int  depth 
) const
virtual

All TinyXml classes can print themselves to a filestream. This is a formatted print, and will insert tabs and newlines.

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

Implements TiXmlBase.

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

void RemoveAttribute ( const char *  name)

Deletes an attribute with the given name.

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

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

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


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