eXperiment robotics framework

TiXmlAttribute Class Reference

An attribute is a name-value pair. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:

Inheritance graph
[legend]
Collaboration diagram for TiXmlAttribute:

Collaboration graph
[legend]

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
 QueryIntValue examines the value string.
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 TiXmlAttributeNext () const
 Get the next sibling attribute in the DOM. Returns null at end.
TiXmlAttributeNext ()
const TiXmlAttributePrevious () const
 Get the previous sibling attribute in the DOM. Returns null at beginning.
TiXmlAttributePrevious ()
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
 All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.
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

TiXmlDocumentdocument
TIXML_STRING name
TIXML_STRING value
TiXmlAttributeprev
TiXmlAttributenext

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.

Definition at line 784 of file tinyxml.h.


Constructor & Destructor Documentation

TiXmlAttribute::TiXmlAttribute (  )  [inline]

Construct an empty attribute.

Definition at line 790 of file tinyxml.h.

References document, next, and prev.

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

std::string constructor.

Definition at line 798 of file tinyxml.h.

References document, name, next, prev, and value.

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

Construct an attribute with a name and value.

Definition at line 808 of file tinyxml.h.

References document, name, next, prev, and value.

TiXmlAttribute::TiXmlAttribute ( const TiXmlAttribute  )  [private]


Member Function Documentation

const char* TiXmlAttribute::Name (  )  const [inline]

Return the name of this attribute.

Definition at line 816 of file tinyxml.h.

References name.

const char* TiXmlAttribute::Value (  )  const [inline]

Return the value of this attribute.

Definition at line 817 of file tinyxml.h.

References value.

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

Return the value of this attribute.

Definition at line 819 of file tinyxml.h.

References value.

Referenced by TiXmlElement::QueryValueAttribute().

int TiXmlAttribute::IntValue (  )  const

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

double TiXmlAttribute::DoubleValue (  )  const

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

const TIXML_STRING& TiXmlAttribute::NameTStr (  )  const [inline]

Definition at line 825 of file tinyxml.h.

References name.

int TiXmlAttribute::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 TiXmlAttribute::QueryDoubleValue ( double *  _value  )  const

QueryDoubleValue examines the value string. See QueryIntValue().

void TiXmlAttribute::SetName ( const char *  _name  )  [inline]

Set the name of this attribute.

Definition at line 840 of file tinyxml.h.

References name.

void TiXmlAttribute::SetValue ( const char *  _value  )  [inline]

Set the value.

Definition at line 841 of file tinyxml.h.

References value.

void TiXmlAttribute::SetIntValue ( int  _value  ) 

Set the value from an integer.

void TiXmlAttribute::SetDoubleValue ( double  _value  ) 

Set the value from a double.

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

STL std::string form.

Definition at line 848 of file tinyxml.h.

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

STL std::string form.

Definition at line 850 of file tinyxml.h.

const TiXmlAttribute* TiXmlAttribute::Next (  )  const

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

TiXmlAttribute* TiXmlAttribute::Next (  )  [inline]

Definition at line 855 of file tinyxml.h.

const TiXmlAttribute* TiXmlAttribute::Previous (  )  const

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

TiXmlAttribute* TiXmlAttribute::Previous (  )  [inline]

Definition at line 861 of file tinyxml.h.

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

Definition at line 865 of file tinyxml.h.

References name.

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

Definition at line 866 of file tinyxml.h.

References name.

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

Definition at line 867 of file tinyxml.h.

References name.

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

Implements TiXmlBase.

virtual void TiXmlAttribute::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.

Definition at line 875 of file tinyxml.h.

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

void TiXmlAttribute::SetDocument ( TiXmlDocument doc  )  [inline]

Definition at line 882 of file tinyxml.h.

References document.

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


Friends And Related Function Documentation

friend class TiXmlAttributeSet [friend]

Definition at line 786 of file tinyxml.h.


Member Data Documentation

Definition at line 888 of file tinyxml.h.

Referenced by SetDocument(), and TiXmlAttribute().

TIXML_STRING TiXmlAttribute::name [private]

Definition at line 889 of file tinyxml.h.

Referenced by Name(), NameTStr(), operator<(), operator==(), operator>(), SetName(), and TiXmlAttribute().

TIXML_STRING TiXmlAttribute::value [private]

Definition at line 890 of file tinyxml.h.

Referenced by SetValue(), TiXmlAttribute(), Value(), and ValueStr().

Definition at line 891 of file tinyxml.h.

Referenced by TiXmlAttributeSet::Last(), and TiXmlAttribute().

Definition at line 892 of file tinyxml.h.

Referenced by TiXmlAttributeSet::First(), and TiXmlAttribute().


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

The miarn project - written by Joao Xavier