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

#include <rtt/marsh/tinyxml.h>

Inheritance diagram for RTT::marsh::TiXmlAttribute:

Public Types
enum	{ TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY, 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_STRING_COUNT }
Public Member Functions
	TiXmlAttribute ()
	Construct an empty attribute.
	TiXmlAttribute (const char _name, const char _value)
	Construct an attribute with a name and value.
const char *	Name () const
	Return the name of this attribute.
const char *	Value () const
	Return the value of this attribute.
int	IntValue () const
	Return the value of this attribute, converted to an integer.
double	DoubleValue () const
	Return the value of this attribute, converted to a double.
const TIXML_STRING &	NameTStr () const
int	QueryIntValue (int *_value) const
	QueryIntValue examines the value string.
int	QueryDoubleValue (double *_value) const
	QueryDoubleValue examines the value string. See QueryIntValue().
void	SetName (const char *_name)
	Set the name of this attribute.
void	SetValue (const char *_value)
	Set the value.
void	SetIntValue (int _value)
	Set the value from an integer.
void	SetDoubleValue (double _value)
	Set the value from a double.
const TiXmlAttribute *	Next () const
	Get the next sibling attribute in the DOM. Returns null at end.
TiXmlAttribute *	Next ()
const TiXmlAttribute *	Previous () const
	Get the previous sibling attribute in the DOM. Returns null at beginning.
TiXmlAttribute *	Previous ()
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)
virtual void	Print (FILE *cfile, int depth) const
	All TinyXml classes can print themselves to a filestream.
virtual void	StreamOut (TIXML_OSTREAM *out) const
void	SetDocument (TiXmlDocument *doc)
int	Row () const
	Return the position, in the original source file, of this node or attribute.
int	Column () const
	See Row()
void	SetUserData (void *user)
void *	GetUserData ()
Static Public Member Functions
static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not.
static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting.
Static Public Attributes
static const int	utf8ByteTable [256]
Static Protected Member Functions
static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)
static bool	IsWhiteSpace (char c)
static bool	IsWhiteSpace (int c)
static const char *	ReadName (const char p, TIXML_STRING name, TiXmlEncoding encoding)
static const char *	ReadText (const char in, TIXML_STRING text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
static const char *	GetEntity (const char in, char value, int *length, TiXmlEncoding encoding)
static const char *	GetChar (const char p, char _value, int *length, TiXmlEncoding encoding)
static void	PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)
static void	PutString (const TIXML_STRING &str, TIXML_STRING *out)
static bool	StringEqual (const char p, const char endTag, bool ignoreCase, TiXmlEncoding encoding)
static int	IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
static int	IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
static int	ToLower (int v, TiXmlEncoding encoding)
static void	ConvertUTF32ToUTF8 (unsigned long input, char output, int length)
Protected Attributes
TiXmlCursor	location
void *	userData
	Field containing a generic user pointer.
Static Protected Attributes
static const char *	errorString [TIXML_ERROR_STRING_COUNT]
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 733 of file tinyxml.h.

Member Function Documentation

void RTT::marsh::TiXmlAttribute::Print	(	FILE *	cfile,
		int	depth
	)		const `[virtual]`

All TinyXml classes can print themselves to a filestream.

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

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

Implements RTT::marsh::TiXmlBase.

Definition at line 1304 of file tinyxml.cpp.

int RTT::marsh::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 1336 of file tinyxml.cpp.

Referenced by RTT::marsh::TiXmlElement::QueryIntAttribute().

int RTT::marsh::TiXmlBase::Row ( ) const [inline, inherited]

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 235 of file tinyxml.h.

static void RTT::marsh::TiXmlBase::SetCondenseWhiteSpace ( bool condense ) [inline, static, inherited]

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 values is not thread safe.

Definition at line 212 of file tinyxml.h.

Member Data Documentation

const char * RTT::marsh::TiXmlBase::errorString [static, protected, inherited]

Initial value:

{
    "No error",
    "Error",
    "Failed to open file",
    "Memory allocation failed.",
    "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.",
}

Definition at line 373 of file tinyxml.h.

const int RTT::marsh::TiXmlBase::utf8ByteTable [static, inherited]

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 243 of file tinyxml.h.

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

rtt/marsh/tinyxml.h
rtt/marsh/tinyxml.cpp
rtt/marsh/tinyxmlparser.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Function Documentation

Member Data Documentation