TiXmlAttribute Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:

TiXmlBase

List of all members.


Public Member Functions

 TiXmlAttribute ()
 Construct an empty attribute.
 TiXmlAttribute (const std::string &_name, const std::string &_value)
 std::string constructor.
 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 std::string & ValueStr () const
 Return the value of this attribute.
int IntValue () const
 Return the value of this attribute, converted to an integer.
double DoubleValue () const
 Return the value of this attribute, converted to a double.
const TIXML_STRING & NameTStr () const
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.
void SetName (const std::string &_name)
 STL std::string form.
void SetValue (const std::string &_value)
 STL std::string form.
const TiXmlAttribute * Next () const
 Get the next sibling attribute in the DOM. Returns null at end.
TiXmlAttribute * Next ()
const TiXmlAttribute * Previous () const
 Get the previous sibling attribute in the DOM. Returns null at beginning.
TiXmlAttribute * Previous ()
bool operator== (const TiXmlAttribute &rhs) const
bool operator< (const TiXmlAttribute &rhs) const
bool operator> (const TiXmlAttribute &rhs) const
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
virtual void Print (FILE *cfile, int depth) const
void Print (FILE *cfile, int depth, TIXML_STRING *str) const
void SetDocument (TiXmlDocument *doc)

Private Member Functions

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

Private Attributes

TiXmlDocument * document
TIXML_STRING name
TIXML_STRING value
TiXmlAttribute * prev
TiXmlAttribute * next

Friends

class TiXmlAttributeSet

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.

Constructor & Destructor Documentation

TiXmlAttribute (  )  [inline]

Construct an empty attribute.

TiXmlAttribute ( const std::string &  _name,
const std::string &  _value 
) [inline]

std::string constructor.

TiXmlAttribute ( const char *  _name,
const char *  _value 
) [inline]

Construct an attribute with a name and value.

TiXmlAttribute ( const TiXmlAttribute &   )  [private]

Member Function Documentation

const char* Name (  )  const [inline]

Return the name of this attribute.

const char* Value (  )  const [inline]

Return the value of this attribute.

const std::string& ValueStr (  )  const [inline]

Return the value of this attribute.

int IntValue (  )  const

Return the value of this attribute, converted to an integer.

double DoubleValue (  )  const

Return the value of this attribute, converted to a double.

const TIXML_STRING& NameTStr (  )  const [inline]

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.

int QueryDoubleValue ( double *  _value  )  const

QueryDoubleValue examines the value string. See QueryIntValue().

void SetName ( const char *  _name  )  [inline]

Set the name of this attribute.

void SetValue ( const char *  _value  )  [inline]

Set the value.

void SetIntValue ( int  _value  ) 

Set the value from an integer.

void SetDoubleValue ( double  _value  ) 

Set the value from a double.

void SetName ( const std::string &  _name  )  [inline]

STL std::string form.

void SetValue ( const std::string &  _value  )  [inline]

STL std::string form.

const TiXmlAttribute * Next (  )  const

Get the next sibling attribute in the DOM. Returns null at end.

TiXmlAttribute* Next (  )  [inline]

const TiXmlAttribute * Previous (  )  const

Get the previous sibling attribute in the DOM. Returns null at beginning.

TiXmlAttribute* Previous (  )  [inline]

bool operator== ( const TiXmlAttribute &  rhs  )  const [inline]

bool operator< ( const TiXmlAttribute &  rhs  )  const [inline]

bool operator> ( const TiXmlAttribute &  rhs  )  const [inline]

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

Implements TiXmlBase.

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

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.

void Print ( FILE *  cfile,
int  depth,
TIXML_STRING *  str 
) const

void SetDocument ( TiXmlDocument *  doc  )  [inline]

void operator= ( const TiXmlAttribute &  base  )  [private]

Friends And Related Function Documentation

friend class TiXmlAttributeSet [friend]

Member Data Documentation

TiXmlDocument* document [private]

TIXML_STRING name [private]

TIXML_STRING value [private]

TiXmlAttribute* prev [private]

TiXmlAttribute* next [private]

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