ttv::xml::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
int64_t	Int64Value () 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	QueryInt64Value (int64_t *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 (int64_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...

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.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
BUF_SIZE

Constructor & Destructor Documentation

XMLAttribute() [1/2]

ttv::xml::XMLAttribute::XMLAttribute ( )

inlineprivate

~XMLAttribute()

virtual ttv::xml::XMLAttribute::~XMLAttribute ( )

inlineprivatevirtual

XMLAttribute() [2/2]

ttv::xml::XMLAttribute::XMLAttribute ( const XMLAttribute &  )

private

Member Function Documentation

BoolValue()

bool ttv::xml::XMLAttribute::BoolValue ( ) const

inline

Query as a boolean. See IntValue()

DoubleValue()

double ttv::xml::XMLAttribute::DoubleValue ( ) const

inline

Query as a double. See IntValue()

FloatValue()

float ttv::xml::XMLAttribute::FloatValue ( ) const

inline

Query as a float. See IntValue()

Int64Value()

int64_t ttv::xml::XMLAttribute::Int64Value ( ) const

inline

IntValue()

int ttv::xml::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* ttv::xml::XMLAttribute::Name

(

)

const

The name of the attribute.

Next()

const XMLAttribute* ttv::xml::XMLAttribute::Next ( ) const

inline

The next attribute in the list.

operator=()

void ttv::xml::XMLAttribute::operator= ( const XMLAttribute &  )

private

ParseDeep()

char* ttv::xml::XMLAttribute::ParseDeep ( char *  p, bool  processEntities  )

private

QueryBoolValue()

XMLError ttv::xml::XMLAttribute::QueryBoolValue

(

bool *

value

)

const

See QueryIntValue.

QueryDoubleValue()

XMLError ttv::xml::XMLAttribute::QueryDoubleValue

(

double *

value

)

const

See QueryIntValue.

QueryFloatValue()

XMLError ttv::xml::XMLAttribute::QueryFloatValue

(

float *

value

)

const

See QueryIntValue.

QueryInt64Value()

XMLError ttv::xml::XMLAttribute::QueryInt64Value

(

int64_t *

value

)

const

See QueryIntValue.

QueryIntValue()

XMLError ttv::xml::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.

QueryUnsignedValue()

XMLError ttv::xml::XMLAttribute::QueryUnsignedValue

(

unsigned int *

value

)

const

See QueryIntValue.

SetAttribute() [1/7]

void ttv::xml::XMLAttribute::SetAttribute

(

const char *

value

)

Set the attribute to a string value.

SetAttribute() [2/7]

void ttv::xml::XMLAttribute::SetAttribute

(

int

value

)

Set the attribute to value.

SetAttribute() [3/7]

void ttv::xml::XMLAttribute::SetAttribute

(

unsigned

value

)

Set the attribute to value.

SetAttribute() [4/7]

void ttv::xml::XMLAttribute::SetAttribute

(

int64_t

value

)

Set the attribute to value.

SetAttribute() [5/7]

void ttv::xml::XMLAttribute::SetAttribute

(

bool

value

)

Set the attribute to value.

SetAttribute() [6/7]

void ttv::xml::XMLAttribute::SetAttribute

(

double

value

)

Set the attribute to value.

SetAttribute() [7/7]

void ttv::xml::XMLAttribute::SetAttribute

(

float

value

)

Set the attribute to value.

SetName()

void ttv::xml::XMLAttribute::SetName ( const char *  name )

private

UnsignedValue()

unsigned ttv::xml::XMLAttribute::UnsignedValue ( ) const

inline

Query as an unsigned integer. See IntValue()

Value()

const char* ttv::xml::XMLAttribute::Value

(

)

const

The value of the attribute.

Friends And Related Function Documentation

XMLElement

friend class XMLElement

friend

Member Data Documentation

_memPool

MemPool* ttv::xml::XMLAttribute::_memPool

private

_name

StrPair ttv::xml::XMLAttribute::_name

mutableprivate

_next

XMLAttribute* ttv::xml::XMLAttribute::_next

private

_value

StrPair ttv::xml::XMLAttribute::_value

mutableprivate

---

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

• modules/core/core_common/include/twitchsdk/core/xml/tinyxml2.h