An attribute is a name-value pair. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:

Collaboration diagram for TiXmlAttribute:

[legend]

Public Types
enum	{ TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_PARSING_ELEMENT, TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES, TIXML_ERROR_PARSING_EMPTY, TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT, TIXML_ERROR_PARSING_DECLARATION, TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_PARSING_CDATA, TIXML_ERROR_DOCUMENT_TOP_ONLY, TIXML_ERROR_STRING_COUNT }

Public Member Functions
	TiXmlAttribute ()
	Construct an empty attribute. More...

	TiXmlAttribute (const std::string &_name, const std::string &_value)
	std::string constructor. More...

	TiXmlAttribute (const char _name, const char _value)
	Construct an attribute with a name and value. More...

int	Column () const
	See Row() More...

double	DoubleValue () const
	Return the value of this attribute, converted to a double. More...

void *	GetUserData ()
	Get a pointer to arbitrary user data. More...

const void *	GetUserData () const
	Get a pointer to arbitrary user data. More...

int	IntValue () const
	Return the value of this attribute, converted to an integer. More...

const char *	Name () const
	Return the name of this attribute. More...

const std::string &	NameTStr () const

const TiXmlAttribute *	Next () const
	Get the next sibling attribute in the DOM. Returns null at end. More...

TiXmlAttribute *	Next ()

bool	operator< (const TiXmlAttribute &rhs) const

bool	operator== (const TiXmlAttribute &rhs) const

bool	operator> (const TiXmlAttribute &rhs) const

virtual const char *	Parse (const char p, TiXmlParsingData data, TiXmlEncoding encoding)

const TiXmlAttribute *	Previous () const
	Get the previous sibling attribute in the DOM. Returns null at beginning. More...

TiXmlAttribute *	Previous ()

virtual void	Print (FILE *cfile, int depth) const
	All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null. More...

void	Print (FILE cfile, int depth, std::string str) const

int	QueryDoubleValue (double *_value) const
	QueryDoubleValue examines the value string. See QueryIntValue(). More...

int	QueryIntValue (int *_value) const
	QueryIntValue examines the value string. More...

int	Row () const
	Return the position, in the original source file, of this node or attribute. More...

void	SetDocument (TiXmlDocument *doc)

void	SetDoubleValue (double _value)
	Set the value from a double. More...

void	SetIntValue (int _value)
	Set the value from an integer. More...

void	SetName (const char *_name)
	Set the name of this attribute. More...

void	SetName (const std::string &_name)
	STL std::string form. More...

void	SetUserData (void *user)
	Set a pointer to arbitrary user data. More...

void	SetValue (const char *_value)
	Set the value. More...

void	SetValue (const std::string &_value)
	STL std::string form. More...

const char *	Value () const
	Return the value of this attribute. More...

const std::string &	ValueStr () const
	Return the value of this attribute. More...

Static Public Member Functions
static void	EncodeString (const std::string &str, std::string *out)
	Expands entities in a string. More...

static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting. More...

static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not. More...

Static Public Attributes
static const int	utf8ByteTable [256]

Static Protected Member Functions
static void	ConvertUTF32ToUTF8 (unsigned long input, char output, int length)

static const char *	GetChar (const char p, char _value, int *length, TiXmlEncoding encoding)

static const char *	GetEntity (const char in, char value, int *length, TiXmlEncoding encoding)

static int	IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)

static int	IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)

static bool	IsWhiteSpace (char c)

static bool	IsWhiteSpace (int c)

static const char *	ReadName (const char p, std::string name, TiXmlEncoding encoding)

static const char *	ReadText (const char in, std::string text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)

static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)

static bool	StreamTo (std::istream in, int character, std::string tag)

static bool	StreamWhiteSpace (std::istream in, std::string tag)

static bool	StringEqual (const char p, const char endTag, bool ignoreCase, TiXmlEncoding encoding)

static int	ToLower (int v, TiXmlEncoding encoding)

Protected Attributes
TiXmlCursor	location

void *	userData
	Field containing a generic user pointer. More...

Static Protected Attributes
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

Private Member Functions
	TiXmlAttribute (const TiXmlAttribute &)

void	operator= (const TiXmlAttribute &base)

Private Attributes
TiXmlDocument *	document

std::string	name

TiXmlAttribute *	next

TiXmlAttribute *	prev

std::string	value

Friends
class	TiXmlAttributeSet

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 TiXmlNodes, since they are not part of the tinyXML document object model. There are other suggested ways to look at this problem.

Definition at line 802 of file tinyxml.h.

Member Enumeration Documentation

anonymous enum

inherited

Enumerator
TIXML_NO_ERROR
TIXML_ERROR
TIXML_ERROR_OPENING_FILE
TIXML_ERROR_PARSING_ELEMENT
TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME
TIXML_ERROR_READING_ELEMENT_VALUE
TIXML_ERROR_READING_ATTRIBUTES
TIXML_ERROR_PARSING_EMPTY
TIXML_ERROR_READING_END_TAG
TIXML_ERROR_PARSING_UNKNOWN
TIXML_ERROR_PARSING_COMMENT
TIXML_ERROR_PARSING_DECLARATION
TIXML_ERROR_DOCUMENT_EMPTY
TIXML_ERROR_EMBEDDED_NULL
TIXML_ERROR_PARSING_CDATA
TIXML_ERROR_DOCUMENT_TOP_ONLY
TIXML_ERROR_STRING_COUNT

Definition at line 284 of file tinyxml.h.

Constructor & Destructor Documentation

TiXmlAttribute::TiXmlAttribute ( )

inline

Construct an empty attribute.

Definition at line 808 of file tinyxml.h.

TiXmlAttribute::TiXmlAttribute	(	const std::string &	_name,
		const std::string &	_value
	)

inline

std::string constructor.

Definition at line 816 of file tinyxml.h.

TiXmlAttribute::TiXmlAttribute	(	const char *	_name,
		const char *	_value
	)

inline

Construct an attribute with a name and value.

Definition at line 826 of file tinyxml.h.

TiXmlAttribute::TiXmlAttribute ( const TiXmlAttribute & )

private

Member Function Documentation

int TiXmlBase::Column ( ) const

inlineinherited

See Row()

Definition at line 265 of file tinyxml.h.

void TiXmlBase::ConvertUTF32ToUTF8	(	unsigned long	input,
		char *	output,
		int *	length
	)

staticprotectedinherited

Definition at line 90 of file tinyxmlparser.cpp.

double TiXmlAttribute::DoubleValue ( ) const

Return the value of this attribute, converted to a double.

Definition at line 1234 of file tinyxml.cpp.

void TiXmlBase::EncodeString	(	const std::string &	str,
		std::string *	out
	)

staticinherited

Expands entities in a string.

Note this should not contian the tag's '<', '>', etc, or they will be transformed into entities!

Definition at line 54 of file tinyxml.cpp.

static const char* TiXmlBase::GetChar	(	const char *	p,
		char *	_value,
		int *	length,
		TiXmlEncoding	encoding
	)

inlinestaticprotectedinherited

Definition at line 347 of file tinyxml.h.

const char * TiXmlBase::GetEntity	(	const char *	in,
		char *	value,
		int *	length,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 442 of file tinyxmlparser.cpp.

void* TiXmlBase::GetUserData ( )

inlineinherited

Get a pointer to arbitrary user data.

Definition at line 268 of file tinyxml.h.

const void* TiXmlBase::GetUserData ( ) const

inlineinherited

Get a pointer to arbitrary user data.

Definition at line 269 of file tinyxml.h.

int TiXmlAttribute::IntValue ( ) const

Return the value of this attribute, converted to an integer.

Definition at line 1229 of file tinyxml.cpp.

int TiXmlBase::IsAlpha	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 131 of file tinyxmlparser.cpp.

int TiXmlBase::IsAlphaNum	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 152 of file tinyxmlparser.cpp.

static bool TiXmlBase::IsWhiteSpace ( char c )

inlinestaticprotectedinherited

Definition at line 310 of file tinyxml.h.

static bool TiXmlBase::IsWhiteSpace ( int c )

inlinestaticprotectedinherited

Definition at line 314 of file tinyxml.h.

static bool TiXmlBase::IsWhiteSpaceCondensed ( )

inlinestaticinherited

Return the current white space setting.

Definition at line 244 of file tinyxml.h.

const char* TiXmlAttribute::Name ( ) const

inline

Return the name of this attribute.

Definition at line 834 of file tinyxml.h.

const std::string& TiXmlAttribute::NameTStr ( ) const

inline

Definition at line 843 of file tinyxml.h.

const TiXmlAttribute * TiXmlAttribute::Next ( ) const

Get the next sibling attribute in the DOM. Returns null at end.

Definition at line 1127 of file tinyxml.cpp.

TiXmlAttribute* TiXmlAttribute::Next ( )

inline

Definition at line 873 of file tinyxml.h.

bool TiXmlAttribute::operator< ( const TiXmlAttribute & rhs ) const

inline

Definition at line 884 of file tinyxml.h.

void TiXmlAttribute::operator= ( const TiXmlAttribute & base )

private

bool TiXmlAttribute::operator== ( const TiXmlAttribute & rhs ) const

inline

Definition at line 883 of file tinyxml.h.

bool TiXmlAttribute::operator> ( const TiXmlAttribute & rhs ) const

inline

Definition at line 885 of file tinyxml.h.

const char * TiXmlAttribute::Parse	(	const char *	p,
		TiXmlParsingData *	data,
		TiXmlEncoding	encoding
	)

virtual

Implements TiXmlBase.

Definition at line 1394 of file tinyxmlparser.cpp.

const TiXmlAttribute * TiXmlAttribute::Previous ( ) const

Get the previous sibling attribute in the DOM. Returns null at beginning.

Definition at line 1147 of file tinyxml.cpp.

TiXmlAttribute* TiXmlAttribute::Previous ( )

inline

Definition at line 879 of file tinyxml.h.

virtual void TiXmlAttribute::Print	(	FILE *	cfile,
		int	depth
	)		const

inlinevirtual

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements TiXmlBase.

Definition at line 893 of file tinyxml.h.

void TiXmlAttribute::Print	(	FILE *	cfile,
		int	depth,
		std::string *	str
	)		const

Definition at line 1167 of file tinyxml.cpp.

int TiXmlAttribute::QueryDoubleValue ( double * _value ) const

QueryDoubleValue examines the value string. See QueryIntValue().

Definition at line 1200 of file tinyxml.cpp.

int TiXmlAttribute::QueryIntValue ( int * _value ) const

QueryIntValue examines the value string.

It is an alternative to the IntValue() method with richer error checking. If the value is an integer, it is stored in 'value' and the call returns TIXML_SUCCESS. If it is not an integer, it returns TIXML_WRONG_TYPE.

A specialized but useful call. Note that for success it returns 0, which is the opposite of almost all other TinyXml calls.

Definition at line 1193 of file tinyxml.cpp.

const char * TiXmlBase::ReadName	(	const char *	p,
		std::string *	name,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 405 of file tinyxmlparser.cpp.

const char * TiXmlBase::ReadText	(	const char *	in,
		std::string *	text,
		bool	ignoreWhiteSpace,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 578 of file tinyxmlparser.cpp.

int TiXmlBase::Row ( ) const

inlineinherited

Return the position, in the original source file, of this node or attribute.

The row and column are 1-based. (That is the first row and first column is 1,1). If the returns values are 0 or less, then the parser does not have a row and column value.

Generally, the row and column value will be set when the TiXmlDocument::Load(), TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator>>.

The values reflect the initial load. Once the DOM is modified programmatically (by adding or changing nodes and attributes) the new values will NOT update to reflect changes in the document.

There is a minor performance cost to computing the row and column. Computation can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.

See also: TiXmlDocument::SetTabSize()

Definition at line 264 of file tinyxml.h.

static void TiXmlBase::SetCondenseWhiteSpace ( bool condense )

inlinestaticinherited

The world does not agree on whether white space should be kept or not.

In order to make everyone happy, these global, static functions are provided to set whether or not TinyXml will condense all white space into a single space or not. The default is to condense. Note changing this value is not thread safe.

Definition at line 241 of file tinyxml.h.

void TiXmlAttribute::SetDocument ( TiXmlDocument * doc )

inline

Definition at line 900 of file tinyxml.h.

void TiXmlAttribute::SetDoubleValue ( double _value )

Set the value from a double.

Definition at line 1218 of file tinyxml.cpp.

void TiXmlAttribute::SetIntValue ( int _value )

Set the value from an integer.

Definition at line 1207 of file tinyxml.cpp.

void TiXmlAttribute::SetName ( const char * _name )

inline

Set the name of this attribute.

Definition at line 858 of file tinyxml.h.

void TiXmlAttribute::SetName ( const std::string & _name )

inline

STL std::string form.

Definition at line 866 of file tinyxml.h.

void TiXmlBase::SetUserData ( void * user )

inlineinherited

Set a pointer to arbitrary user data.

Definition at line 267 of file tinyxml.h.

void TiXmlAttribute::SetValue ( const char * _value )

inline

Set the value.

Definition at line 859 of file tinyxml.h.

void TiXmlAttribute::SetValue ( const std::string & _value )

inline

STL std::string form.

Definition at line 868 of file tinyxml.h.

const char * TiXmlBase::SkipWhiteSpace	(	const char *	p,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 318 of file tinyxmlparser.cpp.

bool TiXmlBase::StreamTo	(	std::istream *	in,
		int	character,
		std::string *	tag
	)

staticprotectedinherited

Definition at line 384 of file tinyxmlparser.cpp.

bool TiXmlBase::StreamWhiteSpace	(	std::istream *	in,
		std::string *	tag
	)

staticprotectedinherited

Definition at line 369 of file tinyxmlparser.cpp.

bool TiXmlBase::StringEqual	(	const char *	p,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

Definition at line 538 of file tinyxmlparser.cpp.

static int TiXmlBase::ToLower	(	int	v,
		TiXmlEncoding	encoding
	)

inlinestaticprotectedinherited

Definition at line 402 of file tinyxml.h.

const char* TiXmlAttribute::Value ( ) const

inline

Return the value of this attribute.

Definition at line 835 of file tinyxml.h.

const std::string& TiXmlAttribute::ValueStr ( ) const

inline

Return the value of this attribute.

Definition at line 837 of file tinyxml.h.

Friends And Related Function Documentation

friend class TiXmlAttributeSet

friend

Definition at line 804 of file tinyxml.h.

Member Data Documentation

TiXmlDocument* TiXmlAttribute::document

private

Definition at line 906 of file tinyxml.h.

const char * TiXmlBase::errorString

staticprotectedinherited

Initial value:

=
{
  "No error",
  "Error",
  "Failed to open file",
  "Error parsing Element.",
  "Failed to read Element name",
  "Error reading Element value.",
  "Error reading Attributes.",
  "Error: empty tag.",
  "Error reading end tag.",
  "Error parsing Unknown.",
  "Error parsing Comment.",
  "Error parsing Declaration.",
  "Error document empty.",
  "Error null (0) or unexpected EOF found in input stream.",
  "Error parsing CDATA.",
  "Error when TiXmlDocument added to document, because TiXmlDocument can only be at the root.",
}

Definition at line 391 of file tinyxml.h.

TiXmlCursor TiXmlBase::location

protectedinherited

Definition at line 393 of file tinyxml.h.

std::string TiXmlAttribute::name

private

Definition at line 907 of file tinyxml.h.

TiXmlAttribute* TiXmlAttribute::next

private

Definition at line 910 of file tinyxml.h.

TiXmlAttribute* TiXmlAttribute::prev

private

Definition at line 909 of file tinyxml.h.

void* TiXmlBase::userData

protectedinherited

Field containing a generic user pointer.

Definition at line 396 of file tinyxml.h.

const int TiXmlBase::utf8ByteTable

staticinherited

Initial value:

= 
{
  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  
    1,  1,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  
    2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  2,  
    3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  3,  
    4,  4,  4,  4,  4,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1  
}

Definition at line 273 of file tinyxml.h.

std::string TiXmlAttribute::value

private

Definition at line 908 of file tinyxml.h.

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

include/madara/utility/tinyxml.h
include/madara/utility/tinyxml.cpp
include/madara/utility/tinyxmlparser.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation