tinyxml2::XMLAttribute Class Reference

#include "tinyxml2.h"

Collaboration diagram for tinyxml2::XMLAttribute:

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 IntAttribute() More...
bool	BoolValue () const
	Query as a boolean. See IntAttribute() More...
double	DoubleValue () const
	Query as a double. See IntAttribute() More...
float	FloatValue () const
	Query as a float. See IntAttribute() More...
XMLError	QueryIntValue (int *value) const
XMLError	QueryUnsignedValue (unsigned int *value) const
	See QueryIntAttribute. More...
XMLError	QueryBoolValue (bool *value) const
	See QueryIntAttribute. More...
XMLError	QueryDoubleValue (double *value) const
	See QueryIntAttribute. More...
XMLError	QueryFloatValue (float *value) const
	See QueryIntAttribute. 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 974 of file tinyxml2.h.

Member Enumeration Documentation

anonymous enum

private

Enumerator
BUF_SIZE

Definition at line 1053 of file tinyxml2.h.

Constructor & Destructor Documentation

tinyxml2::XMLAttribute::XMLAttribute ( )

inlineprivate

Definition at line 1055 of file tinyxml2.h.

virtual tinyxml2::XMLAttribute::~XMLAttribute ( )

inlineprivatevirtual

Definition at line 1056 of file tinyxml2.h.

tinyxml2::XMLAttribute::XMLAttribute ( const XMLAttribute &  )

private

Member Function Documentation

bool tinyxml2::XMLAttribute::BoolValue ( ) const

inline

Query as a boolean. See IntAttribute()

Definition at line 1007 of file tinyxml2.h.

double tinyxml2::XMLAttribute::DoubleValue ( ) const

inline

Query as a double. See IntAttribute()

Definition at line 1013 of file tinyxml2.h.

float tinyxml2::XMLAttribute::FloatValue ( ) const

inline

Query as a float. See IntAttribute()

Definition at line 1019 of file tinyxml2.h.

int tinyxml2::XMLAttribute::IntValue ( ) const

inline

IntAttribute 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 QueryIntAttribute() if you need error checking.

Definition at line 995 of file tinyxml2.h.

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

inline

The name of the attribute.

Definition at line 979 of file tinyxml2.h.

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

inline

The next attribute in the list.

Definition at line 987 of file tinyxml2.h.

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

private

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

private

Definition at line 1047 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryBoolValue

(

bool *

value

)

const

See QueryIntAttribute.

Definition at line 1099 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryDoubleValue

(

double *

value

)

const

See QueryIntAttribute.

Definition at line 1117 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryFloatValue

(

float *

value

)

const

See QueryIntAttribute.

Definition at line 1108 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryIntValue

(

int *

value

)

const

QueryIntAttribute interprets the attribute as an integer, and returns the value in the provided paremeter. The function will return XML_NO_ERROR on success, and XML_WRONG_ATTRIBUTE_TYPE if the conversion is not successful.

Definition at line 1081 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryUnsignedValue

(

unsigned int *

value

)

const

See QueryIntAttribute.

Definition at line 1090 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute

(

const char *

value

)

Set the attribute to a string value.

Definition at line 1126 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute

(

int

value

)

Set the attribute to value.

Definition at line 1132 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute

(

unsigned

value

)

Set the attribute to value.

Definition at line 1140 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute

(

bool

value

)

Set the attribute to value.

Definition at line 1148 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute

(

double

value

)

Set the attribute to value.

Definition at line 1155 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute

(

float

value

)

Set the attribute to value.

Definition at line 1162 of file tinyxml2.cpp.

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

private

Definition at line 1075 of file tinyxml2.cpp.

unsigned tinyxml2::XMLAttribute::UnsignedValue ( ) const

inline

Query as an unsigned integer. See IntAttribute()

Definition at line 1001 of file tinyxml2.h.

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

inline

The value of the attribute.

Definition at line 983 of file tinyxml2.h.

Friends And Related Function Documentation

friend class XMLElement

friend

Definition at line 976 of file tinyxml2.h.

Field Documentation

MemPool* tinyxml2::XMLAttribute::_memPool

private

Definition at line 1067 of file tinyxml2.h.

StrPair tinyxml2::XMLAttribute::_name

mutableprivate

Definition at line 1064 of file tinyxml2.h.

XMLAttribute* tinyxml2::XMLAttribute::_next

private

Definition at line 1066 of file tinyxml2.h.

StrPair tinyxml2::XMLAttribute::_value

mutableprivate

Definition at line 1065 of file tinyxml2.h.

---

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

• ovr/sdk/third_party/tinyxml/tinyxml2.h
• ovr/sdk/third_party/tinyxml/tinyxml2.cpp