TiXmlElement Class Reference
[XML objects]

#include <TinyXML.h>

Inherits TiXmlNode, and DigitalSpaces::DIXMLElement1.

---

Detailed Description

The element is a container class.

It has a value, the element name, and can contain other elements, text, comments, and unknowns. Elements also contain an arbitrary number of attributes.

Public Member Functions
	TiXmlElement (const char *in_value)
	Construct an element.
virtual	~TiXmlElement ()
const char *	Attribute (const char *name) const
	Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.
const char *	Attribute (const char *name, int *i) const
	Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.
const char *	Attribute (const char *name, double *d) const
	Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.
int	QueryIntAttribute (const char *name, int *value) const
	QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking.
int	QueryDoubleAttribute (const char *name, double *value) const
	QueryDoubleAttribute examines the attribute - see QueryIntAttribute().
void	SetAttribute (const char *name, const char *value)
	Sets an attribute of name to a given value.
void	SetAttribute (const char *name, int value)
	Sets an attribute of name to a given value.
void	SetDoubleAttribute (const char *name, double value)
	Sets an attribute of name to a given value.
void	RemoveAttribute (const char *name)
	Deletes an attribute with the given name.
TiXmlAttribute *	FirstAttribute () const
	Access the first attribute in this element.
TiXmlAttribute *	LastAttribute () const
	Access the last attribute in this element.
virtual TiXmlNode *	Clone () const
virtual void	Print (FILE *cfile, int depth) const
	All TinyXml classes can print themselves to a filestream.
const char *	GetAttribute (const char *name)
	DSS.
const char *	GetAttribute (const char *name, int *i)
	Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.
const char *	GetAttribute (const char *name, double *d)
	Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.
int	DoQueryIntAttribute (const char *name, int *value)
	QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking.
int	DoQueryDoubleAttribute (const char *name, double *value)
	QueryDoubleAttribute examines the attribute - see QueryIntAttribute().
Protected Member Functions
virtual void	StreamOut (TiXmlOutStream *out) const
virtual const char *	Parse (const char *p, TiXmlParsingData *data)
const char *	ReadValue (const char *in, TiXmlParsingData *prevData)
Private Member Functions
	TiXmlElement (const TiXmlElement &)
void	operator= (const TiXmlElement &base)
Private Attributes
TiXmlAttributeSet	attributeSet

---

Constructor & Destructor Documentation

TiXmlElement::TiXmlElement

(

const char *

in_value

)

Construct an element.

virtual TiXmlElement::~TiXmlElement

(

)

[virtual]

TiXmlElement::TiXmlElement

(

const TiXmlElement &

)

[private]

---

Member Function Documentation

const char* TiXmlElement::Attribute

(

const char *

name

)

const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

Referenced by GetAttribute().

const char* TiXmlElement::Attribute	(	const char *	name,
		int *	i
	)			const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

If the attribute exists and can be converted to an integer, the integer value will be put in the return 'i', if 'i' is non-null.

const char* TiXmlElement::Attribute	(	const char *	name,
		double *	d
	)			const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

If the attribute exists and can be converted to an double, the double value will be put in the return 'd', if 'd' is non-null.

int TiXmlElement::QueryIntAttribute	(	const char *	name,
		int *	value
	)			const

QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking.

If the attribute 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. If the attribute does not exist, then TIXML_NO_ATTRIBUTE is returned.

Referenced by DoQueryIntAttribute().

int TiXmlElement::QueryDoubleAttribute	(	const char *	name,
		double *	value
	)			const

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

Referenced by DoQueryDoubleAttribute().

void TiXmlElement::SetAttribute	(	const char *	name,
		const char *	value
	)

Sets an attribute of name to a given value.

The attribute will be created if it does not exist, or changed if it does.

Reimplemented from DigitalSpaces::DIXMLElement1.

void TiXmlElement::SetAttribute	(	const char *	name,
		int	value
	)

Sets an attribute of name to a given value.

The attribute will be created if it does not exist, or changed if it does.

Reimplemented from DigitalSpaces::DIXMLElement1.

void TiXmlElement::SetDoubleAttribute	(	const char *	name,
		double	value
	)

Sets an attribute of name to a given value.

The attribute will be created if it does not exist, or changed if it does.

Reimplemented from DigitalSpaces::DIXMLElement1.

void TiXmlElement::RemoveAttribute

(

const char *

name

)

Deletes an attribute with the given name.

Reimplemented from DigitalSpaces::DIXMLElement1.

TiXmlAttribute* TiXmlElement::FirstAttribute

(

)

const [inline]

Access the first attribute in this element.

TiXmlAttribute* TiXmlElement::LastAttribute

(

)

const [inline]

Access the last attribute in this element.

virtual TiXmlNode* TiXmlElement::Clone

(

)

const [virtual]

Implements TiXmlNode.

virtual void TiXmlElement::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 TiXmlBase.

const char* TiXmlElement::GetAttribute

(

const char *

name

)

[inline]

DSS.

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

Reimplemented from DigitalSpaces::DIXMLElement1.

const char* TiXmlElement::GetAttribute	(	const char *	name,
		int *	i
	)			[inline]

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

If the attribute exists and can be converted to an integer, the integer value will be put in the return 'i', if 'i' is non-null.

Reimplemented from DigitalSpaces::DIXMLElement1.

const char* TiXmlElement::GetAttribute	(	const char *	name,
		double *	d
	)			[inline]

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

If the attribute exists and can be converted to an double, the double value will be put in the return 'd', if 'd' is non-null.

Reimplemented from DigitalSpaces::DIXMLElement1.

int TiXmlElement::DoQueryIntAttribute	(	const char *	name,
		int *	value
	)			[inline]

QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking.

If the attribute 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. If the attribute does not exist, then TIXML_NO_ATTRIBUTE is returned.

Reimplemented from DigitalSpaces::DIXMLElement1.

int TiXmlElement::DoQueryDoubleAttribute	(	const char *	name,
		double *	value
	)			[inline]

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

Reimplemented from DigitalSpaces::DIXMLElement1.

virtual void TiXmlElement::StreamOut

(

TiXmlOutStream *

out

)

const [protected, virtual]

Implements TiXmlBase.

virtual const char* TiXmlElement::Parse	(	const char *	p,
		TiXmlParsingData *	data
	)			[protected, virtual]

Implements TiXmlBase.

const char* TiXmlElement::ReadValue	(	const char *	in,
		TiXmlParsingData *	prevData
	)			[protected]

void TiXmlElement::operator=

(

const TiXmlElement &

base

)

[private]

---

Field Documentation

TiXmlAttributeSet TiXmlElement::attributeSet [private]

Referenced by FirstAttribute(), and LastAttribute().

---

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

• Common/TinyXML/TinyXML.h