BT_TinyXML2::XMLAttribute Class Reference

#include <tinyxml2.h>

List of all members.

Public Member Functions
bool	BoolValue () const
	Query as a boolean. See IntValue()
double	DoubleValue () const
	Query as a double. See IntValue()
float	FloatValue () const
	Query as a float. See IntValue()
int	GetLineNum () const
	Gets the line number the attribute is in, if the document was parsed from a file.
int64_t	Int64Value () const
int	IntValue () const
const char *	Name () const
	The name of the attribute.
const XMLAttribute *	Next () const
	The next attribute in the list.
XMLError	QueryBoolValue (bool *value) const
	See QueryIntValue.
XMLError	QueryDoubleValue (double *value) const
	See QueryIntValue.
XMLError	QueryFloatValue (float *value) const
	See QueryIntValue.
XMLError	QueryInt64Value (int64_t *value) const
	See QueryIntValue.
XMLError	QueryIntValue (int *value) const
XMLError	QueryUnsignedValue (unsigned int *value) const
	See QueryIntValue.
void	SetAttribute (const char *value)
	Set the attribute to a string value.
void	SetAttribute (int value)
	Set the attribute to value.
void	SetAttribute (unsigned value)
	Set the attribute to value.
void	SetAttribute (int64_t value)
	Set the attribute to value.
void	SetAttribute (bool value)
	Set the attribute to value.
void	SetAttribute (double value)
	Set the attribute to value.
void	SetAttribute (float value)
	Set the attribute to value.
unsigned	UnsignedValue () const
	Query as an unsigned integer. See IntValue()
const char *	Value () const
	The value of the attribute.
Private Types
enum	{ BUF_SIZE = 200 }
Private Member Functions
void	operator= (const XMLAttribute &)
char *	ParseDeep (char *p, bool processEntities, int *curLineNumPtr)
void	SetName (const char *name)
	XMLAttribute ()
	XMLAttribute (const XMLAttribute &)
virtual	~XMLAttribute ()
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.

Definition at line 1133 of file tinyxml2.h.

---

Member Enumeration Documentation

anonymous enum [private]

Enumerator:

BUF_SIZE

Definition at line 1224 of file tinyxml2.h.

---

Constructor & Destructor Documentation

BT_TinyXML2::XMLAttribute::XMLAttribute

(

)

[inline, private]

Definition at line 1226 of file tinyxml2.h.

virtual BT_TinyXML2::XMLAttribute::~XMLAttribute

(

)

[inline, private, virtual]

Definition at line 1227 of file tinyxml2.h.

BT_TinyXML2::XMLAttribute::XMLAttribute

(

const XMLAttribute &

)

[private]

---

Member Function Documentation

bool BT_TinyXML2::XMLAttribute::BoolValue

(

)

const [inline]

Query as a boolean. See IntValue()

Definition at line 1174 of file tinyxml2.h.

double BT_TinyXML2::XMLAttribute::DoubleValue

(

)

const [inline]

Query as a double. See IntValue()

Definition at line 1180 of file tinyxml2.h.

float BT_TinyXML2::XMLAttribute::FloatValue

(

)

const [inline]

Query as a float. See IntValue()

Definition at line 1186 of file tinyxml2.h.

int BT_TinyXML2::XMLAttribute::GetLineNum

(

)

const [inline]

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

Definition at line 1144 of file tinyxml2.h.

int64_t BT_TinyXML2::XMLAttribute::Int64Value

(

)

const [inline]

Definition at line 1161 of file tinyxml2.h.

int BT_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 1155 of file tinyxml2.h.

const char * BT_TinyXML2::XMLAttribute::Name

(

)

const

The name of the attribute.

Definition at line 1346 of file tinyxml2.cpp.

const XMLAttribute* BT_TinyXML2::XMLAttribute::Next

(

)

const [inline]

The next attribute in the list.

Definition at line 1147 of file tinyxml2.h.

void BT_TinyXML2::XMLAttribute::operator=

(

const XMLAttribute &

)

[private]

char * BT_TinyXML2::XMLAttribute::ParseDeep	(	char *	p,
		bool	processEntities,
		int *	curLineNumPtr
	)		[private]

Definition at line 1356 of file tinyxml2.cpp.

XMLError BT_TinyXML2::XMLAttribute::QueryBoolValue

(

bool *

value

)

const

See QueryIntValue.

Definition at line 1417 of file tinyxml2.cpp.

XMLError BT_TinyXML2::XMLAttribute::QueryDoubleValue

(

double *

value

)

const

See QueryIntValue.

Definition at line 1435 of file tinyxml2.cpp.

XMLError BT_TinyXML2::XMLAttribute::QueryFloatValue

(

float *

value

)

const

See QueryIntValue.

Definition at line 1426 of file tinyxml2.cpp.

XMLError BT_TinyXML2::XMLAttribute::QueryInt64Value

(

int64_t *

value

)

const

See QueryIntValue.

Definition at line 1408 of file tinyxml2.cpp.

XMLError BT_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.

Definition at line 1390 of file tinyxml2.cpp.

XMLError BT_TinyXML2::XMLAttribute::QueryUnsignedValue

(

unsigned int *

value

)

const

See QueryIntValue.

Definition at line 1399 of file tinyxml2.cpp.

void BT_TinyXML2::XMLAttribute::SetAttribute

(

const char *

value

)

Set the attribute to a string value.

Definition at line 1444 of file tinyxml2.cpp.

void BT_TinyXML2::XMLAttribute::SetAttribute

(

int

value

)

Set the attribute to value.

Definition at line 1450 of file tinyxml2.cpp.

void BT_TinyXML2::XMLAttribute::SetAttribute

(

unsigned

value

)

Set the attribute to value.

Definition at line 1458 of file tinyxml2.cpp.

void BT_TinyXML2::XMLAttribute::SetAttribute

(

int64_t

value

)

Set the attribute to value.

Definition at line 1466 of file tinyxml2.cpp.

void BT_TinyXML2::XMLAttribute::SetAttribute

(

bool

value

)

Set the attribute to value.

Definition at line 1475 of file tinyxml2.cpp.

void BT_TinyXML2::XMLAttribute::SetAttribute

(

double

value

)

Set the attribute to value.

Definition at line 1482 of file tinyxml2.cpp.

void BT_TinyXML2::XMLAttribute::SetAttribute

(

float

value

)

Set the attribute to value.

Definition at line 1489 of file tinyxml2.cpp.

void BT_TinyXML2::XMLAttribute::SetName

(

const char *

name

)

[private]

Definition at line 1384 of file tinyxml2.cpp.

unsigned BT_TinyXML2::XMLAttribute::UnsignedValue

(

)

const [inline]

Query as an unsigned integer. See IntValue()

Definition at line 1168 of file tinyxml2.h.

const char * BT_TinyXML2::XMLAttribute::Value

(

)

const

The value of the attribute.

Definition at line 1351 of file tinyxml2.cpp.

---

Friends And Related Function Documentation

friend class XMLElement [friend]

Definition at line 1135 of file tinyxml2.h.

---

Member Data Documentation

MemPool* BT_TinyXML2::XMLAttribute::_memPool [private]

Definition at line 1239 of file tinyxml2.h.

StrPair BT_TinyXML2::XMLAttribute::_name [mutable, private]

Definition at line 1235 of file tinyxml2.h.

XMLAttribute* BT_TinyXML2::XMLAttribute::_next [private]

Definition at line 1238 of file tinyxml2.h.

int BT_TinyXML2::XMLAttribute::_parseLineNum [private]

Definition at line 1237 of file tinyxml2.h.

StrPair BT_TinyXML2::XMLAttribute::_value [mutable, private]

Definition at line 1236 of file tinyxml2.h.

---

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

• tinyxml2.h
• tinyxml2.cpp