[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

TiXmlAttribute Class Reference

#include <tinyxml.hh>

Inheritance diagram for TiXmlAttribute:

List of all members.

---

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 699 of file tinyxml.hh.

Public Member Functions

• TiXmlAttribute ()

  Construct an empty attribute.
  

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

  std::string constructor.
  

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

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

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

  STL std::string form.
  

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

  STL std::string form.
  

• 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, int depth) const
• void SetDocument (TiXmlDocument *doc)

Friends

• class TiXmlAttributeSet

---

Constructor & Destructor Documentation

TiXmlAttribute::TiXmlAttribute

(

)

[inline]

Construct an empty attribute.

Definition at line 705 of file tinyxml.hh.

TiXmlAttribute::TiXmlAttribute	(	const std::string &	_name,
		const std::string &	_value
	)			[inline]

std::string constructor.

Definition at line 713 of file tinyxml.hh.

TiXmlAttribute::TiXmlAttribute	(	const char *	_name,
		const char *	_value
	)			[inline]

Construct an attribute with a name and value.

Definition at line 723 of file tinyxml.hh.

---

Member Function Documentation

double TiXmlAttribute::DoubleValue

(

)

const

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

int TiXmlAttribute::IntValue

(

)

const

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

const char* TiXmlAttribute::Name

(

)

const [inline]

Return the name of this attribute.

Definition at line 731 of file tinyxml.hh.

TiXmlAttribute* TiXmlAttribute::Next

(

)

const TiXmlAttribute* TiXmlAttribute::Next

(

)

const

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

bool TiXmlAttribute::operator<

(

const TiXmlAttribute &

rhs

)

const [inline]

Definition at line 778 of file tinyxml.hh.

bool TiXmlAttribute::operator==

(

const TiXmlAttribute &

rhs

)

const [inline]

Definition at line 777 of file tinyxml.hh.

bool TiXmlAttribute::operator>

(

const TiXmlAttribute &

rhs

)

const [inline]

Definition at line 779 of file tinyxml.hh.

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

Implements TiXmlBase.

TiXmlAttribute* TiXmlAttribute::Previous

(

)

const TiXmlAttribute* TiXmlAttribute::Previous

(

)

const

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

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

int TiXmlAttribute::QueryDoubleValue

(

double *

_value

)

const

QueryDoubleValue examines the value string. See QueryIntValue().

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.

void TiXmlAttribute::SetDocument

(

TiXmlDocument *

doc

)

[inline]

Definition at line 792 of file tinyxml.hh.

void TiXmlAttribute::SetDoubleValue

(

double

_value

)

Set the value from a double.

void TiXmlAttribute::SetIntValue

(

int

_value

)

Set the value from an integer.

void TiXmlAttribute::SetName

(

const std::string &

_name

)

[inline]

STL std::string form.

Definition at line 757 of file tinyxml.hh.

void TiXmlAttribute::SetName

(

const char *

_name

)

[inline]

Set the name of this attribute.

Definition at line 749 of file tinyxml.hh.

void TiXmlAttribute::SetValue

(

const std::string &

_value

)

[inline]

STL std::string form.

Definition at line 763 of file tinyxml.hh.

void TiXmlAttribute::SetValue

(

const char *

_value

)

[inline]

Set the value.

Definition at line 750 of file tinyxml.hh.

virtual void TiXmlAttribute::StreamOut	(	TIXML_OSTREAM *	out,
		int	depth
	)			const [virtual]

Implements TiXmlBase.

const char* TiXmlAttribute::Value

(

)

const [inline]

Return the value of this attribute.

Definition at line 732 of file tinyxml.hh.

---

Friends And Related Function Documentation

friend class TiXmlAttributeSet [friend]

Definition at line 701 of file tinyxml.hh.

---

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

• /home/tetron/hack/vos/libs/vos/vutil/tinyxml.hh