tinyxml2::XMLAttribute Class Reference

#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 XMLAttribute *	Next () const
	The next attribute in the list. More...
int	IntValue () const
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	QueryIntValue (int *value) const
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 1076 of file tinyxml2.h.

Member Enumeration Documentation

anonymous enum

private

Enumerator
BUF_SIZE

Definition at line 1153 of file tinyxml2.h.

Constructor & Destructor Documentation

tinyxml2::XMLAttribute::XMLAttribute ( )

inlineprivate

Definition at line 1155 of file tinyxml2.h.

virtual tinyxml2::XMLAttribute::~XMLAttribute ( )

inlineprivatevirtual

Definition at line 1156 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 1107 of file tinyxml2.h.

double tinyxml2::XMLAttribute::DoubleValue ( ) const

inline

Query as a double. See IntValue()

Definition at line 1113 of file tinyxml2.h.

float tinyxml2::XMLAttribute::FloatValue ( ) const

inline

Query as a float. See IntValue()

Definition at line 1119 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 1095 of file tinyxml2.h.

const char * tinyxml2::XMLAttribute::Name

(

)

const

The name of the attribute.

Definition at line 1125 of file tinyxml2.cpp.

const XMLAttribute* tinyxml2::XMLAttribute::Next ( ) const

inline

The next attribute in the list.

Definition at line 1087 of file tinyxml2.h.

void tinyxml2::XMLAttribute::operator= ( const XMLAttribute &  )

private

char * tinyxml2::XMLAttribute::ParseDeep ( char *  p, bool  processEntities  )

private

Definition at line 1135 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryBoolValue

(

bool *

value

)

const

See QueryIntValue.

Definition at line 1187 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryDoubleValue

(

double *

value

)

const

See QueryIntValue.

Definition at line 1205 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryFloatValue

(

float *

value

)

const

See QueryIntValue.

Definition at line 1196 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryIntValue

(

int *

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 1169 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryUnsignedValue

(

unsigned int *

value

)

const

See QueryIntValue.

Definition at line 1178 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute

(

const char *

value

)

Set the attribute to a string value.

Definition at line 1214 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute

(

int

value

)

Set the attribute to value.

Definition at line 1220 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute

(

unsigned

value

)

Set the attribute to value.

Definition at line 1228 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute

(

bool

value

)

Set the attribute to value.

Definition at line 1236 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute

(

double

value

)

Set the attribute to value.

Definition at line 1243 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute

(

float

value

)

Set the attribute to value.

Definition at line 1250 of file tinyxml2.cpp.

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

private

Definition at line 1163 of file tinyxml2.cpp.

unsigned tinyxml2::XMLAttribute::UnsignedValue ( ) const

inline

Query as an unsigned integer. See IntValue()

Definition at line 1101 of file tinyxml2.h.

const char * tinyxml2::XMLAttribute::Value

(

)

const

The value of the attribute.

Definition at line 1130 of file tinyxml2.cpp.

Friends And Related Function Documentation

friend class XMLElement

friend

Definition at line 1078 of file tinyxml2.h.

Member Data Documentation

MemPool* tinyxml2::XMLAttribute::_memPool

private

Definition at line 1167 of file tinyxml2.h.

StrPair tinyxml2::XMLAttribute::_name

mutableprivate

Definition at line 1164 of file tinyxml2.h.

XMLAttribute* tinyxml2::XMLAttribute::_next

private

Definition at line 1166 of file tinyxml2.h.

StrPair tinyxml2::XMLAttribute::_value

mutableprivate

Definition at line 1165 of file tinyxml2.h.

---

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

• src/lib/Parameters/tinyxml2.h
• src/lib/Parameters/tinyxml2.cpp