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 QueryUnsigned64Value (uint64_t *value) const
 See QueryIntValue. More...
 
XMLError QueryUnsignedValue (unsigned int *value) const
 See QueryIntValue. More...
 
void SetAttribute (bool value)
 Set the attribute to value. More...
 
void SetAttribute (const char *value)
 Set the attribute to a string value. More...
 
void SetAttribute (double value)
 Set the attribute to value. More...
 
void SetAttribute (float value)
 Set the attribute to value. More...
 
void SetAttribute (int 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 (unsigned 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

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

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
BUF_SIZE 

Definition at line 1241 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLAttribute() [1/2]

tinyxml2::XMLAttribute::XMLAttribute ( )
inlineprivate

Definition at line 1243 of file tinyxml2.h.

◆ ~XMLAttribute()

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

Definition at line 1244 of file tinyxml2.h.

◆ 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()

Definition at line 1187 of file tinyxml2.h.

◆ DoubleValue()

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

Query as a double. See IntValue()

Definition at line 1193 of file tinyxml2.h.

◆ FloatValue()

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

Query as a float. See IntValue()

Definition at line 1199 of file tinyxml2.h.

◆ GetLineNum()

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

◆ Int64Value()

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

Definition at line 1168 of file tinyxml2.h.

◆ 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.

Definition at line 1162 of file tinyxml2.h.

◆ Name()

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

The name of the attribute.

Definition at line 1400 of file tinyxml2.cpp.

◆ Next()

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

The next attribute in the list.

Definition at line 1154 of file tinyxml2.h.

◆ operator=()

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

◆ ParseDeep()

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

Definition at line 1410 of file tinyxml2.cpp.

◆ QueryBoolValue()

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

See QueryIntValue.

Definition at line 1480 of file tinyxml2.cpp.

◆ QueryDoubleValue()

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

See QueryIntValue.

Definition at line 1498 of file tinyxml2.cpp.

◆ QueryFloatValue()

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

See QueryIntValue.

Definition at line 1489 of file tinyxml2.cpp.

◆ QueryInt64Value()

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

See QueryIntValue.

Definition at line 1462 of file tinyxml2.cpp.

◆ 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.

Definition at line 1444 of file tinyxml2.cpp.

◆ QueryUnsigned64Value()

XMLError tinyxml2::XMLAttribute::QueryUnsigned64Value ( uint64_t *  value) const

See QueryIntValue.

Definition at line 1471 of file tinyxml2.cpp.

◆ QueryUnsignedValue()

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

See QueryIntValue.

Definition at line 1453 of file tinyxml2.cpp.

◆ SetAttribute() [1/8]

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

Set the attribute to value.

Definition at line 1544 of file tinyxml2.cpp.

◆ SetAttribute() [2/8]

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

Set the attribute to a string value.

Definition at line 1507 of file tinyxml2.cpp.

◆ SetAttribute() [3/8]

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

Set the attribute to value.

Definition at line 1551 of file tinyxml2.cpp.

◆ SetAttribute() [4/8]

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

Set the attribute to value.

Definition at line 1558 of file tinyxml2.cpp.

◆ SetAttribute() [5/8]

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

Set the attribute to value.

Definition at line 1513 of file tinyxml2.cpp.

◆ SetAttribute() [6/8]

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

Set the attribute to value.

Definition at line 1529 of file tinyxml2.cpp.

◆ SetAttribute() [7/8]

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

Set the attribute to value.

Definition at line 1536 of file tinyxml2.cpp.

◆ SetAttribute() [8/8]

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

Set the attribute to value.

Definition at line 1521 of file tinyxml2.cpp.

◆ SetName()

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

Definition at line 1438 of file tinyxml2.cpp.

◆ Unsigned64Value()

uint64_t tinyxml2::XMLAttribute::Unsigned64Value ( ) const
inline

Definition at line 1174 of file tinyxml2.h.

◆ UnsignedValue()

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

Query as an unsigned integer. See IntValue()

Definition at line 1181 of file tinyxml2.h.

◆ Value()

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

The value of the attribute.

Definition at line 1405 of file tinyxml2.cpp.

Friends And Related Function Documentation

◆ XMLElement

friend class XMLElement
friend

Definition at line 1142 of file tinyxml2.h.

Member Data Documentation

◆ _memPool

MemPool* tinyxml2::XMLAttribute::_memPool
private

Definition at line 1256 of file tinyxml2.h.

◆ _name

StrPair tinyxml2::XMLAttribute::_name
mutableprivate

Definition at line 1252 of file tinyxml2.h.

◆ _next

XMLAttribute* tinyxml2::XMLAttribute::_next
private

Definition at line 1255 of file tinyxml2.h.

◆ _parseLineNum

int tinyxml2::XMLAttribute::_parseLineNum
private

Definition at line 1254 of file tinyxml2.h.

◆ _value

StrPair tinyxml2::XMLAttribute::_value
mutableprivate

Definition at line 1253 of file tinyxml2.h.


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


behaviortree_cpp_v4
Author(s): Davide Faconti
autogenerated on Fri Jun 28 2024 02:20:10