sipxportlib  Version 3.3
Public Member Functions | Protected Member Functions | List of all members
TiXmlElement Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlElement:
Inheritance graph
[legend]
Collaboration diagram for TiXmlElement:
Collaboration graph
[legend]

Public Member Functions

 TiXmlElement (const char *in_value)
 Construct an element. More...
 
 TiXmlElement (const TiXmlElement &)
 
void operator= (const TiXmlElement &base)
 
virtual ~TiXmlElement ()
 
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(). More...
 
int QueryDoubleAttribute (const char *name, float *value) const
 QueryFloatAttribute examines the attribute - see QueryIntAttribute(). More...
 
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. More...
 
TiXmlAttributeFirstAttribute ()
 
const TiXmlAttributeLastAttribute () const
 Access the last attribute in this element. More...
 
TiXmlAttributeLastAttribute ()
 
virtual TiXmlNodeClone () const
 Creates a new Element and returns it - the returned element is a copy. More...
 
virtual void Print (FILE *cfile, int depth) const
 
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
 
- Public Member Functions inherited from TiXmlNode
virtual ~TiXmlNode ()
 
const char * Value () const
 
void SetValue (const char *_value)
 
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
 The first child of this node with the matching 'value'. Will be null if none found. More...
 
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 TiXmlNodeIterateChildren (const TiXmlNode *previous) const
 
TiXmlNodeIterateChildren (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, TiXmlNode *previous)
 
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 *)
 
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 *)
 
const TiXmlElementNextSiblingElement () const
 
TiXmlElementNextSiblingElement ()
 
const TiXmlElementNextSiblingElement (const char *) const
 
TiXmlElementNextSiblingElement (const char *)
 
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)
 
virtual int Type () const
 
const TiXmlDocumentGetDocument () const
 
TiXmlDocumentGetDocument ()
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
const TiXmlElementToElement () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
const TiXmlCommentToComment () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
const TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
const TiXmlTextToText () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
const TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlElementToElement ()
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlCommentToComment ()
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlUnknownToUnknown ()
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlTextToText ()
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null 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)
 
void * GetUserData ()
 

Protected Member Functions

void CopyTo (TiXmlElement *target) const
 
void ClearThis ()
 
virtual void StreamOut (TIXML_OSTREAM *out) const
 
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)
 
const TIXML_STRINGSValue () const
 

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_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 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_OSTREAM *out)
 
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

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.

Constructor & Destructor Documentation

TiXmlElement ( const char *  in_value)

Construct an element.

TiXmlElement ( const TiXmlElement copy)
~TiXmlElement ( )
virtual

Member Function Documentation

void operator= ( const TiXmlElement base)
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.

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.

int QueryDoubleAttribute ( const char *  name,
double *  value 
) const

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

int QueryDoubleAttribute ( const char *  name,
float *  value 
) const
inline

QueryFloatAttribute examines the attribute - see QueryIntAttribute().

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.

void RemoveAttribute ( const char *  name)

Deletes an attribute with the given name.

const TiXmlAttribute* FirstAttribute ( ) const
inline

Access the first attribute in this element.

TiXmlAttribute* FirstAttribute ( )
inline
const TiXmlAttribute* LastAttribute ( ) const
inline

Access the last attribute in this element.

TiXmlAttribute* LastAttribute ( )
inline
TiXmlNode * Clone ( ) const
virtual

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

Implements TiXmlNode.

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.

const char * Parse ( const char *  p,
TiXmlParsingData data,
TiXmlEncoding  encoding 
)
virtual

Implements TiXmlBase.

void CopyTo ( TiXmlElement target) const
protected
void ClearThis ( )
protected
void StreamOut ( TIXML_OSTREAM out) const
protectedvirtual

Implements TiXmlBase.

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