tinyxml2::XMLAttribute Class Reference

#include <tinyxml2.h>

Collaboration diagram for tinyxml2::XMLAttribute:

Public Member Functions
const char *	Name () const
	The name of the attribute.
const char *	Value () const
	The value of the attribute.
const XMLAttribute *	Next () const
	The next attribute in the list.
int	IntValue () const
unsigned	UnsignedValue () const
	Query as an unsigned integer. See IntValue()
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()
XMLError	QueryIntValue (int *value) const
XMLError	QueryUnsignedValue (unsigned int *value) const
	See QueryIntValue.
XMLError	QueryBoolValue (bool *value) const
	See QueryIntValue.
XMLError	QueryDoubleValue (double *value) const
	See QueryIntValue.
XMLError	QueryFloatValue (float *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 (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.

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.

Definition at line 1044 of file tinyxml2.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
BUF_SIZE

Definition at line 1121 of file tinyxml2.h.

{ BUF_SIZE = 200 };

Constructor & Destructor Documentation

XMLAttribute() [1/2]

tinyxml2::XMLAttribute::XMLAttribute ( )

inlineprivate

Definition at line 1123 of file tinyxml2.h.

: _next( 0 ), _memPool( 0 ) {}

~XMLAttribute()

virtual tinyxml2::XMLAttribute::~XMLAttribute ( )

inlineprivatevirtual

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

                                            {
        bool b=false;
        QueryBoolValue( &b );
        return b;
    }

DoubleValue()

double tinyxml2::XMLAttribute::DoubleValue ( ) const

inline

Query as a double. See IntValue()

Definition at line 1081 of file tinyxml2.h.

                                            {
        double d=0;
        QueryDoubleValue( &d );
        return d;
    }

FloatValue()

float tinyxml2::XMLAttribute::FloatValue ( ) const

inline

Query as a float. See IntValue()

Definition at line 1087 of file tinyxml2.h.

                                            {
        float f=0;
        QueryFloatValue( &f );
        return f;
    }

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

                                            {
        int i=0;
        QueryIntValue( &i );
        return i;
    }

Name()

const char * tinyxml2::XMLAttribute::Name

(

)

const

The name of the attribute.

Definition at line 1242 of file tinyxml2.cpp.

{
    return _name.GetStr();
}

Referenced by tinyxml2::XMLElement::FindOrCreateAttribute(), and tinyxml2::XMLElement::ParseAttributes().

Next()

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

inline

The next attribute in the list.

Definition at line 1055 of file tinyxml2.h.

                                     {
        return _next;
    }

operator=()

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

private

ParseDeep()

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

private

Definition at line 1252 of file tinyxml2.cpp.

{
    // Parse using the name rules: bug fix, was using ParseText before
    p = _name.ParseName( p );
    if ( !p || !*p ) {
        return 0;
    }
 
    // Skip white space before =
    p = XMLUtil::SkipWhiteSpace( p );
    if ( *p != '=' ) {
        return 0;
    }
 
    ++p;    // move up to opening quote
    p = XMLUtil::SkipWhiteSpace( p );
    if ( *p != '\"' && *p != '\'' ) {
        return 0;
    }
 
    char endTag[2] = { *p, 0 };
    ++p;    // move past opening quote
 
    p = _value.ParseText( p, endTag, processEntities ? StrPair::ATTRIBUTE_VALUE : StrPair::ATTRIBUTE_VALUE_LEAVE_ENTITIES );
    return p;
}

Referenced by tinyxml2::XMLElement::ParseAttributes().

QueryBoolValue()

XMLError tinyxml2::XMLAttribute::QueryBoolValue

(

bool *

value

)

const

See QueryIntValue.

Definition at line 1304 of file tinyxml2.cpp.

{
    if ( XMLUtil::ToBool( Value(), value )) {
        return XML_NO_ERROR;
    }
    return XML_WRONG_ATTRIBUTE_TYPE;
}

QueryDoubleValue()

XMLError tinyxml2::XMLAttribute::QueryDoubleValue

(

double *

value

)

const

See QueryIntValue.

Definition at line 1322 of file tinyxml2.cpp.

{
    if ( XMLUtil::ToDouble( Value(), value )) {
        return XML_NO_ERROR;
    }
    return XML_WRONG_ATTRIBUTE_TYPE;
}

QueryFloatValue()

XMLError tinyxml2::XMLAttribute::QueryFloatValue

(

float *

value

)

const

See QueryIntValue.

Definition at line 1313 of file tinyxml2.cpp.

{
    if ( XMLUtil::ToFloat( Value(), value )) {
        return XML_NO_ERROR;
    }
    return XML_WRONG_ATTRIBUTE_TYPE;
}

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

Definition at line 1286 of file tinyxml2.cpp.

{
    if ( XMLUtil::ToInt( Value(), value )) {
        return XML_NO_ERROR;
    }
    return XML_WRONG_ATTRIBUTE_TYPE;
}

QueryUnsignedValue()

XMLError tinyxml2::XMLAttribute::QueryUnsignedValue

(

unsigned int *

value

)

const

See QueryIntValue.

Definition at line 1295 of file tinyxml2.cpp.

{
    if ( XMLUtil::ToUnsigned( Value(), value )) {
        return XML_NO_ERROR;
    }
    return XML_WRONG_ATTRIBUTE_TYPE;
}

SetAttribute() [1/6]

void tinyxml2::XMLAttribute::SetAttribute

(

bool

value

)

Set the attribute to value.

Definition at line 1353 of file tinyxml2.cpp.

{
    char buf[BUF_SIZE];
    XMLUtil::ToStr( v, buf, BUF_SIZE );
    _value.SetStr( buf );
}

SetAttribute() [2/6]

void tinyxml2::XMLAttribute::SetAttribute

(

const char *

value

)

Set the attribute to a string value.

Definition at line 1331 of file tinyxml2.cpp.

{
    _value.SetStr( v );
}

SetAttribute() [3/6]

void tinyxml2::XMLAttribute::SetAttribute

(

double

value

)

Set the attribute to value.

Definition at line 1360 of file tinyxml2.cpp.

{
    char buf[BUF_SIZE];
    XMLUtil::ToStr( v, buf, BUF_SIZE );
    _value.SetStr( buf );
}

SetAttribute() [4/6]

void tinyxml2::XMLAttribute::SetAttribute

(

float

value

)

Set the attribute to value.

Definition at line 1367 of file tinyxml2.cpp.

{
    char buf[BUF_SIZE];
    XMLUtil::ToStr( v, buf, BUF_SIZE );
    _value.SetStr( buf );
}

SetAttribute() [5/6]

void tinyxml2::XMLAttribute::SetAttribute

(

int

value

)

Set the attribute to value.

Definition at line 1337 of file tinyxml2.cpp.

{
    char buf[BUF_SIZE];
    XMLUtil::ToStr( v, buf, BUF_SIZE );
    _value.SetStr( buf );
}

SetAttribute() [6/6]

void tinyxml2::XMLAttribute::SetAttribute

(

unsigned

value

)

Set the attribute to value.

Definition at line 1345 of file tinyxml2.cpp.

{
    char buf[BUF_SIZE];
    XMLUtil::ToStr( v, buf, BUF_SIZE );
    _value.SetStr( buf );
}

SetName()

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

private

Definition at line 1280 of file tinyxml2.cpp.

{
    _name.SetStr( n );
}

Referenced by tinyxml2::XMLElement::FindOrCreateAttribute().

UnsignedValue()

unsigned tinyxml2::XMLAttribute::UnsignedValue ( ) const

inline

Query as an unsigned integer. See IntValue()

Definition at line 1069 of file tinyxml2.h.

                                            {
        unsigned i=0;
        QueryUnsignedValue( &i );
        return i;
    }

Value()

const char * tinyxml2::XMLAttribute::Value

(

)

const

The value of the attribute.

Definition at line 1247 of file tinyxml2.cpp.

{
    return _value.GetStr();
}

Referenced by QueryBoolValue(), QueryDoubleValue(), QueryFloatValue(), QueryIntValue(), and QueryUnsignedValue().

Friends And Related Function Documentation

XMLElement

friend class XMLElement

friend

Definition at line 1046 of file tinyxml2.h.

Member Data Documentation

_memPool

MemPool* tinyxml2::XMLAttribute::_memPool

private

Definition at line 1135 of file tinyxml2.h.

Referenced by tinyxml2::XMLElement::FindOrCreateAttribute(), and tinyxml2::XMLElement::ParseAttributes().

_name

StrPair tinyxml2::XMLAttribute::_name

mutableprivate

Definition at line 1132 of file tinyxml2.h.

Referenced by Name(), ParseDeep(), and SetName().

_next

XMLAttribute* tinyxml2::XMLAttribute::_next

private

Definition at line 1134 of file tinyxml2.h.

Referenced by tinyxml2::XMLElement::DeleteAttribute(), tinyxml2::XMLElement::FindOrCreateAttribute(), tinyxml2::XMLElement::ParseAttributes(), and tinyxml2::XMLElement::~XMLElement().

_value

StrPair tinyxml2::XMLAttribute::_value

mutableprivate

Definition at line 1133 of file tinyxml2.h.

Referenced by ParseDeep(), SetAttribute(), and Value().

---

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

• sdk/tools/xml2sdb/tinyxml2.h
• sdk/tools/xml2sdb/tinyxml2.cpp