MIDAS  0.75
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Friends Macros
Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
tinyxml2::XMLAttribute Class Reference

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

#include <tinyxml2.h>

Public Member Functions

const char * Name () const
 The name of the attribute. More...
 
const char * Value () const
 The value of the attribute. More...
 
const XMLAttributeNext () const
 The next attribute in the list. More...
 
int IntValue () const
 IntValue interprets the attribute as an integer, and returns the value. More...
 
unsigned UnsignedValue () const
 Query as an unsigned integer. See IntValue() More...
 
bool BoolValue () const
 Query as a boolean. See IntValue() More...
 
double DoubleValue () const
 Query as a double. See IntValue() More...
 
float FloatValue () const
 Query as a float. See IntValue() More...
 
XMLError QueryLongValue (long *value) const
 QueryIntValue interprets the attribute as an integer, and returns the value in the provided parameter. More...
 
XMLError QueryIntValue (int *value) const
 See QueryIntValue. More...
 
XMLError QueryUnsignedValue (unsigned int *value) const
 See QueryIntValue. More...
 
XMLError QueryBoolValue (bool *value) const
 See QueryIntValue. More...
 
XMLError QueryDoubleValue (double *value) const
 See QueryIntValue. More...
 
XMLError QueryFloatValue (float *value) const
 See QueryIntValue. More...
 
void SetAttribute (const char *value)
 Set the attribute to a string value. More...
 
void SetAttribute (int value)
 Set the attribute to value. More...
 
void SetAttribute (unsigned value)
 Set the attribute to value. More...
 
void SetAttribute (bool value)
 Set the attribute to value. More...
 
void SetAttribute (double value)
 Set the attribute to value. More...
 
void SetAttribute (float value)
 Set the attribute to value. More...
 

Private Types

enum  { BUF_SIZE = 200 }
 

Private Member Functions

 XMLAttribute ()
 
virtual ~XMLAttribute ()
 
 XMLAttribute (const XMLAttribute &)
 
void operator= (const XMLAttribute &)
 
void SetName (const char *name)
 
char * ParseDeep (char *p, bool processEntities)
 

Private Attributes

StrPair _name
 
StrPair _value
 
XMLAttribute_next
 
MemPool_memPool
 

Friends

class XMLElement
 

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 XMLNodes. You may only query the Next() attribute in a list.

Definition at line 1013 of file tinyxml2.h.

Member Enumeration Documentation

anonymous enum
private
Enumerator
BUF_SIZE 

Definition at line 1094 of file tinyxml2.h.

Constructor & Destructor Documentation

tinyxml2::XMLAttribute::XMLAttribute ( )
inlineprivate

Definition at line 1096 of file tinyxml2.h.

virtual tinyxml2::XMLAttribute::~XMLAttribute ( )
inlineprivatevirtual

Definition at line 1097 of file tinyxml2.h.

tinyxml2::XMLAttribute::XMLAttribute ( const XMLAttribute )
private

Member Function Documentation

bool tinyxml2::XMLAttribute::BoolValue ( ) const
inline

Query as a boolean. See IntValue()

Definition at line 1046 of file tinyxml2.h.

double tinyxml2::XMLAttribute::DoubleValue ( ) const
inline

Query as a double. See IntValue()

Definition at line 1052 of file tinyxml2.h.

float tinyxml2::XMLAttribute::FloatValue ( ) const
inline

Query as a float. See IntValue()

Definition at line 1058 of file tinyxml2.h.

int tinyxml2::XMLAttribute::IntValue ( ) const
inline

IntValue interprets the attribute as an integer, and returns the value.

If the value isn't an integer, 0 will be returned. There is no error checking; use QueryIntValue() if you need error checking.

Definition at line 1034 of file tinyxml2.h.

const char* tinyxml2::XMLAttribute::Name ( ) const
inline
const XMLAttribute* tinyxml2::XMLAttribute::Next ( ) const
inline

The next attribute in the list.

Definition at line 1026 of file tinyxml2.h.

Referenced by tinyxml2::XMLElement::ShallowClone(), tinyxml2::XMLElement::ShallowEqual(), and tinyxml2::XMLPrinter::VisitEnter().

void tinyxml2::XMLAttribute::operator= ( const XMLAttribute )
private
char * tinyxml2::XMLAttribute::ParseDeep ( char *  p,
bool  processEntities 
)
private
XMLError tinyxml2::XMLAttribute::QueryBoolValue ( bool *  value) const
XMLError tinyxml2::XMLAttribute::QueryDoubleValue ( double *  value) const
XMLError tinyxml2::XMLAttribute::QueryFloatValue ( float *  value) const
XMLError tinyxml2::XMLAttribute::QueryIntValue ( int *  value) const
XMLError tinyxml2::XMLAttribute::QueryLongValue ( long *  value) const

QueryIntValue interprets the attribute as an integer, and returns the value in the provided parameter.

The function will return XML_NO_ERROR on success, and XML_WRONG_ATTRIBUTE_TYPE if the conversion is not successful.

Definition at line 1086 of file tinyxml2.cpp.

References tinyxml2::XMLUtil::ToLong(), Value(), tinyxml2::XML_NO_ERROR, and tinyxml2::XML_WRONG_ATTRIBUTE_TYPE.

Referenced by tinyxml2::XMLElement::QueryLongAttribute().

XMLError tinyxml2::XMLAttribute::QueryUnsignedValue ( unsigned int *  value) const
void tinyxml2::XMLAttribute::SetAttribute ( const char *  value)

Set the attribute to a string value.

Definition at line 1140 of file tinyxml2.cpp.

References _value, and tinyxml2::StrPair::SetStr().

Referenced by tinyxml2::XMLElement::SetAttribute().

void tinyxml2::XMLAttribute::SetAttribute ( int  value)

Set the attribute to value.

Definition at line 1146 of file tinyxml2.cpp.

References _value, BUF_SIZE, tinyxml2::StrPair::SetStr(), and tinyxml2::XMLUtil::ToStr().

void tinyxml2::XMLAttribute::SetAttribute ( unsigned  value)

Set the attribute to value.

Definition at line 1154 of file tinyxml2.cpp.

References _value, BUF_SIZE, tinyxml2::StrPair::SetStr(), and tinyxml2::XMLUtil::ToStr().

void tinyxml2::XMLAttribute::SetAttribute ( bool  value)

Set the attribute to value.

Definition at line 1162 of file tinyxml2.cpp.

References _value, BUF_SIZE, tinyxml2::StrPair::SetStr(), and tinyxml2::XMLUtil::ToStr().

void tinyxml2::XMLAttribute::SetAttribute ( double  value)

Set the attribute to value.

Definition at line 1169 of file tinyxml2.cpp.

References _value, BUF_SIZE, tinyxml2::StrPair::SetStr(), and tinyxml2::XMLUtil::ToStr().

void tinyxml2::XMLAttribute::SetAttribute ( float  value)

Set the attribute to value.

Definition at line 1176 of file tinyxml2.cpp.

References _value, BUF_SIZE, tinyxml2::StrPair::SetStr(), and tinyxml2::XMLUtil::ToStr().

void tinyxml2::XMLAttribute::SetName ( const char *  name)
private

Definition at line 1080 of file tinyxml2.cpp.

References _name, and tinyxml2::StrPair::SetStr().

Referenced by tinyxml2::XMLElement::FindOrCreateAttribute().

unsigned tinyxml2::XMLAttribute::UnsignedValue ( ) const
inline

Query as an unsigned integer. See IntValue()

Definition at line 1040 of file tinyxml2.h.

const char* tinyxml2::XMLAttribute::Value ( ) const
inline

Friends And Related Function Documentation

friend class XMLElement
friend

Definition at line 1015 of file tinyxml2.h.

Member Data Documentation

MemPool* tinyxml2::XMLAttribute::_memPool
private
StrPair tinyxml2::XMLAttribute::_name
mutableprivate

Definition at line 1105 of file tinyxml2.h.

Referenced by ParseDeep(), and SetName().

XMLAttribute* tinyxml2::XMLAttribute::_next
private
StrPair tinyxml2::XMLAttribute::_value
mutableprivate

Definition at line 1106 of file tinyxml2.h.

Referenced by ParseDeep(), and SetAttribute().


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