Public Member Functions | Private Member Functions | Private Attributes | Friends
RTT::marsh::TiXmlAttribute Class Reference

#include <tinyxml.h>

Inheritance diagram for RTT::marsh::TiXmlAttribute:
Inheritance graph
[legend]

List of all members.

Public Member Functions

double DoubleValue () const
 Return the value of this attribute, converted to a double.
int IntValue () const
 Return the value of this attribute, converted to an integer.
const char * Name () const
 Return the name of this attribute.
const TIXML_STRINGNameTStr () const
const TiXmlAttributeNext () const
 Get the next sibling attribute in the DOM. Returns null at end.
TiXmlAttributeNext ()
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)
const TiXmlAttributePrevious () const
 Get the previous sibling attribute in the DOM. Returns null at beginning.
TiXmlAttributePrevious ()
virtual void Print (FILE *cfile, int depth) const
int QueryDoubleValue (double *_value) const
 QueryDoubleValue examines the value string. See QueryIntValue().
int QueryIntValue (int *_value) const
void SetDocument (TiXmlDocument *doc)
void SetDoubleValue (double _value)
 Set the value from a double.
void SetIntValue (int _value)
 Set the value from an integer.
void SetName (const char *_name)
 Set the name of this attribute.
void SetValue (const char *_value)
 Set the value.
virtual void StreamOut (TIXML_OSTREAM *out) const
 TiXmlAttribute ()
 Construct an empty attribute.
 TiXmlAttribute (const char *_name, const char *_value)
 Construct an attribute with a name and value.
const char * Value () const
 Return the value of this attribute.

Private Member Functions

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

Private Attributes

TiXmlDocumentdocument
TIXML_STRING name
TiXmlAttributenext
TiXmlAttributeprev
TIXML_STRING value

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 733 of file tinyxml.h.


Constructor & Destructor Documentation

Construct an empty attribute.

Definition at line 739 of file tinyxml.h.

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

Construct an attribute with a name and value.

Definition at line 757 of file tinyxml.h.


Member Function Documentation

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

Definition at line 1377 of file tinyxml.cpp.

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

Definition at line 1372 of file tinyxml.cpp.

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

Return the name of this attribute.

Definition at line 765 of file tinyxml.h.

Definition at line 771 of file tinyxml.h.

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

Definition at line 1268 of file tinyxml.cpp.

Definition at line 1277 of file tinyxml.cpp.

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

Definition at line 807 of file tinyxml.h.

void RTT::marsh::TiXmlAttribute::operator= ( const TiXmlAttribute base) [private]
bool RTT::marsh::TiXmlAttribute::operator== ( const TiXmlAttribute rhs) const [inline]

Definition at line 806 of file tinyxml.h.

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

Definition at line 808 of file tinyxml.h.

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

Implements RTT::marsh::TiXmlBase.

Definition at line 1366 of file tinyxmlparser.cpp.

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

Definition at line 1286 of file tinyxml.cpp.

Definition at line 1295 of file tinyxml.cpp.

void RTT::marsh::TiXmlAttribute::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 RTT::marsh::TiXmlBase.

Definition at line 1304 of file tinyxml.cpp.

int RTT::marsh::TiXmlAttribute::QueryDoubleValue ( double *  _value) const

QueryDoubleValue examines the value string. See QueryIntValue().

Definition at line 1343 of file tinyxml.cpp.

int RTT::marsh::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.

Definition at line 1336 of file tinyxml.cpp.

Definition at line 821 of file tinyxml.h.

Set the value from a double.

Definition at line 1361 of file tinyxml.cpp.

Set the value from an integer.

Definition at line 1350 of file tinyxml.cpp.

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

Set the name of this attribute.

Definition at line 786 of file tinyxml.h.

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

Set the value.

Definition at line 787 of file tinyxml.h.

void RTT::marsh::TiXmlAttribute::StreamOut ( TIXML_OSTREAM out) const [virtual]

Implements RTT::marsh::TiXmlBase.

Definition at line 1318 of file tinyxml.cpp.

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

Return the value of this attribute.

Definition at line 766 of file tinyxml.h.


Friends And Related Function Documentation

friend class TiXmlAttributeSet [friend]

Definition at line 735 of file tinyxml.h.


Member Data Documentation

Definition at line 827 of file tinyxml.h.

Definition at line 828 of file tinyxml.h.

Definition at line 831 of file tinyxml.h.

Definition at line 830 of file tinyxml.h.

Definition at line 829 of file tinyxml.h.


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


rtt
Author(s): RTT Developers
autogenerated on Sat Jun 8 2019 18:46:39