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

#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:
TiXmlBase

Public Member Functions

 TiXmlAttribute ()
 Construct an empty attribute.
 
 TiXmlAttribute (const char *_name, const char *_value)
 Construct an attribute with a name and value.
 
const char * Name () const
 Return the name of this attribute.
 
const char * Value () const
 Return the value of this attribute.
 
const int IntValue () const
 Return the value of this attribute, converted to an integer.
 
const double DoubleValue () const
 Return the value of this attribute, converted to a double.
 
int QueryIntValue (int *value) const
 
int QueryDoubleValue (double *value) const
 QueryDoubleValue examines the value string. See QueryIntValue().
 
void SetName (const char *_name)
 Set the name of this attribute.
 
void SetValue (const char *_value)
 Set the value.
 
void SetIntValue (int value)
 Set the value from an integer.
 
void SetDoubleValue (double value)
 Set the value from a double.
 
const TiXmlAttributeNext () const
 Get the next sibling attribute in the DOM. Returns null at end.
 
const TiXmlAttributePrevious () const
 Get the previous sibling attribute in the DOM. Returns null at beginning.
 
virtual void Print (FILE *cfile, int depth) const
 
- Public Member Functions inherited from TiXmlBase
int Row () const
 
int Column () const
 See Row()
 

Friends

class TiXmlAttributeSet
 

Additional Inherited Members

- 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

An attribute is a name-value pair. Elements have an arbitrary number of attributes, each with a unique name.

Note
The attributes are not TiXmlNodes, since they are not part of the tinyXML document object model. There are other suggested ways to look at this problem.

Member Function Documentation

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 QueryIntValue ( int *  value) const

QueryIntValue examines the value string. It is an alternative to the IntValue() method with richer error checking. If the value 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.

A specialized but useful call. Note that for success it returns 0, which is the opposite of almost all other TinyXml calls.


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