Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
tinyxml2::XMLAttribute Class Reference

#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
 
const char * Name () const
 The name of the attribute. More...
 
const XMLAttributeNext () 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
 
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 (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...
 
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

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 1126 of file tinyxml2.h.

Member Enumeration Documentation

anonymous enum
private
Enumerator
BUF_SIZE 

Definition at line 1217 of file tinyxml2.h.

Constructor & Destructor Documentation

tinyxml2::XMLAttribute::XMLAttribute ( )
inlineprivate

Definition at line 1219 of file tinyxml2.h.

virtual tinyxml2::XMLAttribute::~XMLAttribute ( )
inlineprivatevirtual

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

double tinyxml2::XMLAttribute::DoubleValue ( ) const
inline

Query as a double. See IntValue()

Definition at line 1173 of file tinyxml2.h.

float tinyxml2::XMLAttribute::FloatValue ( ) const
inline

Query as a float. See IntValue()

Definition at line 1179 of file tinyxml2.h.

int tinyxml2::XMLAttribute::GetLineNum ( ) const
inline

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

Definition at line 1137 of file tinyxml2.h.

int64_t tinyxml2::XMLAttribute::Int64Value ( ) const
inline

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

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

The name of the attribute.

Definition at line 1336 of file tinyxml2.cpp.

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

The next attribute in the list.

Definition at line 1140 of file tinyxml2.h.

void tinyxml2::XMLAttribute::operator= ( const XMLAttribute )
private
char * tinyxml2::XMLAttribute::ParseDeep ( char *  p,
bool  processEntities,
int *  curLineNumPtr 
)
private

Definition at line 1346 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryBoolValue ( bool *  value) const

See QueryIntValue.

Definition at line 1407 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryDoubleValue ( double *  value) const

See QueryIntValue.

Definition at line 1425 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryFloatValue ( float *  value) const

See QueryIntValue.

Definition at line 1416 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryInt64Value ( int64_t *  value) const

See QueryIntValue.

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

Definition at line 1380 of file tinyxml2.cpp.

XMLError tinyxml2::XMLAttribute::QueryUnsignedValue ( unsigned int *  value) const

See QueryIntValue.

Definition at line 1389 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute ( const char *  value)

Set the attribute to a string value.

Definition at line 1434 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute ( int  value)

Set the attribute to value.

Definition at line 1440 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute ( unsigned  value)

Set the attribute to value.

Definition at line 1448 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute ( int64_t  value)

Set the attribute to value.

Definition at line 1456 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute ( bool  value)

Set the attribute to value.

Definition at line 1465 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute ( double  value)

Set the attribute to value.

Definition at line 1472 of file tinyxml2.cpp.

void tinyxml2::XMLAttribute::SetAttribute ( float  value)

Set the attribute to value.

Definition at line 1479 of file tinyxml2.cpp.

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

Definition at line 1374 of file tinyxml2.cpp.

unsigned tinyxml2::XMLAttribute::UnsignedValue ( ) const
inline

Query as an unsigned integer. See IntValue()

Definition at line 1161 of file tinyxml2.h.

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

The value of the attribute.

Definition at line 1341 of file tinyxml2.cpp.

Friends And Related Function Documentation

friend class XMLElement
friend

Definition at line 1128 of file tinyxml2.h.

Member Data Documentation

MemPool* tinyxml2::XMLAttribute::_memPool
private

Definition at line 1232 of file tinyxml2.h.

StrPair tinyxml2::XMLAttribute::_name
mutableprivate

Definition at line 1228 of file tinyxml2.h.

XMLAttribute* tinyxml2::XMLAttribute::_next
private

Definition at line 1231 of file tinyxml2.h.

int tinyxml2::XMLAttribute::_parseLineNum
private

Definition at line 1230 of file tinyxml2.h.

StrPair tinyxml2::XMLAttribute::_value
mutableprivate

Definition at line 1229 of file tinyxml2.h.


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


behaviortree_cpp
Author(s): Michele Colledanchise, Davide Faconti
autogenerated on Sun Feb 3 2019 03:14:33