tinyxml2::XMLAttribute Class Reference

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

#include <tinyxml2.h>

Public Member Functions
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...
int	GetLineNum () const
	Gets the line number the attribute is in, if the document was parsed from a file. More...
int64_t	Int64Value () const
int	IntValue () const
	IntValue interprets the attribute as an integer, and returns the value. More...
const char *	Name () const
	The name of the attribute. More...
const XMLAttribute *	Next () const
	The next attribute in the list. 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...
XMLError	QueryInt64Value (int64_t *value) const
	See QueryIntValue. More...
XMLError	QueryIntValue (int *value) const
	QueryIntValue interprets the attribute as an integer, and returns the value in the provided parameter. More...
XMLError	QueryUnsigned64Value (uint64_t *value) const
	See QueryIntValue. More...
XMLError	QueryUnsignedValue (unsigned int *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 (int64_t value)
	Set the attribute to value. More...
void	SetAttribute (uint64_t 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...
uint64_t	Unsigned64Value () const
unsigned	UnsignedValue () const
	Query as an unsigned integer. See IntValue() More...
const char *	Value () const
	The value of the attribute. More...

Private Types
enum	{ BUF_SIZE = 200 }

Private Member Functions
	XMLAttribute ()
	XMLAttribute (const XMLAttribute &)
virtual	~XMLAttribute ()
void	operator= (const XMLAttribute &)
char *	ParseDeep (char *p, bool processEntities, int *curLineNumPtr)
void	SetName (const char *name)

Private Attributes
MemPool *	_memPool
StrPair	_name
XMLAttribute *	_next
int	_parseLineNum
StrPair	_value

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.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
BUF_SIZE

Constructor & Destructor Documentation

XMLAttribute() [1/2]

tinyxml2::XMLAttribute::XMLAttribute ( )

inlineprivate

~XMLAttribute()

virtual tinyxml2::XMLAttribute::~XMLAttribute ( )

inlineprivatevirtual

XMLAttribute() [2/2]

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

private

Member Function Documentation

BoolValue()

bool tinyxml2::XMLAttribute::BoolValue ( ) const

inline

Query as a boolean. See IntValue()

DoubleValue()

double tinyxml2::XMLAttribute::DoubleValue ( ) const

inline

Query as a double. See IntValue()

FloatValue()

float tinyxml2::XMLAttribute::FloatValue ( ) const

inline

Query as a float. See IntValue()

GetLineNum()

int tinyxml2::XMLAttribute::GetLineNum ( ) const

inline

Gets the line number the attribute is in, if the document was parsed from a file.

Int64Value()

int64_t tinyxml2::XMLAttribute::Int64Value ( ) const

inline

IntValue()

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.

Name()

const char* tinyxml2::XMLAttribute::Name

(

)

const

The name of the attribute.

Next()

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

inline

The next attribute in the list.

operator=()

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

private

ParseDeep()

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

private

QueryBoolValue()

XMLError tinyxml2::XMLAttribute::QueryBoolValue

(

bool *

value

)

const

See QueryIntValue.

QueryDoubleValue()

XMLError tinyxml2::XMLAttribute::QueryDoubleValue

(

double *

value

)

const

See QueryIntValue.

QueryFloatValue()

XMLError tinyxml2::XMLAttribute::QueryFloatValue

(

float *

value

)

const

See QueryIntValue.

QueryInt64Value()

XMLError tinyxml2::XMLAttribute::QueryInt64Value

(

int64_t *

value

)

const

See QueryIntValue.

QueryIntValue()

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_SUCCESS on success, and XML_WRONG_ATTRIBUTE_TYPE if the conversion is not successful.

QueryUnsigned64Value()

XMLError tinyxml2::XMLAttribute::QueryUnsigned64Value

(

uint64_t *

value

)

const

See QueryIntValue.

QueryUnsignedValue()

XMLError tinyxml2::XMLAttribute::QueryUnsignedValue

(

unsigned int *

value

)

const

See QueryIntValue.

SetAttribute() [1/8]

void tinyxml2::XMLAttribute::SetAttribute

(

const char *

value

)

Set the attribute to a string value.

SetAttribute() [2/8]

void tinyxml2::XMLAttribute::SetAttribute

(

int

value

)

Set the attribute to value.

SetAttribute() [3/8]

void tinyxml2::XMLAttribute::SetAttribute

(

unsigned

value

)

Set the attribute to value.

SetAttribute() [4/8]

void tinyxml2::XMLAttribute::SetAttribute

(

int64_t

value

)

Set the attribute to value.

SetAttribute() [5/8]

void tinyxml2::XMLAttribute::SetAttribute

(

uint64_t

value

)

Set the attribute to value.

SetAttribute() [6/8]

void tinyxml2::XMLAttribute::SetAttribute

(

bool

value

)

Set the attribute to value.

SetAttribute() [7/8]

void tinyxml2::XMLAttribute::SetAttribute

(

double

value

)

Set the attribute to value.

SetAttribute() [8/8]

void tinyxml2::XMLAttribute::SetAttribute

(

float

value

)

Set the attribute to value.

SetName()

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

private

Unsigned64Value()

uint64_t tinyxml2::XMLAttribute::Unsigned64Value ( ) const

inline

UnsignedValue()

unsigned tinyxml2::XMLAttribute::UnsignedValue ( ) const

inline

Query as an unsigned integer. See IntValue()

Value()

const char* tinyxml2::XMLAttribute::Value

(

)

const

The value of the attribute.

Friends And Related Function Documentation

XMLElement

friend class XMLElement

friend

Member Data Documentation

_memPool

MemPool* tinyxml2::XMLAttribute::_memPool

private

_name

StrPair tinyxml2::XMLAttribute::_name

mutableprivate

_next

XMLAttribute* tinyxml2::XMLAttribute::_next

private

_parseLineNum

int tinyxml2::XMLAttribute::_parseLineNum

private

_value

StrPair tinyxml2::XMLAttribute::_value

mutableprivate

---

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

• include/tinyxml2.h