Public Member Functions | Protected Member Functions | Private Attributes
RTT::marsh::TiXmlElement Class Reference

#include <tinyxml.h>

Inheritance diagram for RTT::marsh::TiXmlElement:
Inheritance graph
[legend]

List of all members.

Public Member Functions

const char * Attribute (const char *name) const
const char * Attribute (const char *name, int *i) const
const char * Attribute (const char *name, double *d) const
virtual TiXmlNodeClone () const
 Creates a new Element and returns it - the returned element is a copy.
const TiXmlAttributeFirstAttribute () const
 Access the first attribute in this element.
TiXmlAttributeFirstAttribute ()
const char * GetText () const
const TiXmlAttributeLastAttribute () const
 Access the last attribute in this element.
TiXmlAttributeLastAttribute ()
void operator= (const TiXmlElement &base)
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
virtual void Print (FILE *cfile, int depth) const
int QueryDoubleAttribute (const char *name, double *_value) const
 QueryDoubleAttribute examines the attribute - see QueryIntAttribute().
int QueryFloatAttribute (const char *name, float *_value) const
 QueryFloatAttribute examines the attribute - see QueryIntAttribute().
int QueryIntAttribute (const char *name, int *_value) const
void RemoveAttribute (const char *name)
void SetAttribute (const char *name, const char *_value)
void SetAttribute (const char *name, int value)
void SetDoubleAttribute (const char *name, double value)
 TiXmlElement (const char *in_value)
 Construct an element.
 TiXmlElement (const TiXmlElement &)
virtual const TiXmlElementToElement () const
 Cast to a more defined type. Will return null not of the requested type.
virtual TiXmlElementToElement ()
 Cast to a more defined type. Will return null not of the requested type.
virtual ~TiXmlElement ()

Protected Member Functions

void ClearThis ()
void CopyTo (TiXmlElement *target) const
const char * ReadValue (const char *in, TiXmlParsingData *prevData, TiXmlEncoding encoding)
virtual void StreamOut (TIXML_OSTREAM *out) const

Private Attributes

TiXmlAttributeSet attributeSet

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.

Definition at line 878 of file tinyxml.h.


Constructor & Destructor Documentation

RTT::marsh::TiXmlElement::TiXmlElement ( const char *  in_value)

Construct an element.

Definition at line 655 of file tinyxml.cpp.

Definition at line 673 of file tinyxml.cpp.

Definition at line 688 of file tinyxml.cpp.


Member Function Documentation

const char * RTT::marsh::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.

Definition at line 706 of file tinyxml.cpp.

const char * RTT::marsh::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.

Definition at line 718 of file tinyxml.cpp.

const char * RTT::marsh::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.

Definition at line 732 of file tinyxml.cpp.

Definition at line 694 of file tinyxml.cpp.

Creates a new Element and returns it - the returned element is a copy.

Implements RTT::marsh::TiXmlNode.

Definition at line 956 of file tinyxml.cpp.

void RTT::marsh::TiXmlElement::CopyTo ( TiXmlElement target) const [protected]

Definition at line 933 of file tinyxml.cpp.

Access the first attribute in this element.

Definition at line 971 of file tinyxml.h.

Definition at line 972 of file tinyxml.h.

const char * RTT::marsh::TiXmlElement::GetText ( ) const

Convenience function for easy access to the text inside an element. Although easy and concise, GetText() is limited compared to getting the TiXmlText child and accessing it directly.

If the first child of 'this' is a TiXmlText, the GetText() returns the character string of the Text node, else null is returned.

This is a convenient method for getting the text of simple contained text:

		<foo>This is text</foo>
		const char* str = fooElement->GetText();
		

'str' will be a pointer to "This is text".

Note that this function can be misleading. If the element foo was created from this XML:

		<foo><b>This is text</b></foo>
		

then the value of str would be null. The first child node isn't a text node, it is another element. From this XML:

		<foo>This is <b>text</b></foo>
		

GetText() will return "This is ".

WARNING: GetText() accesses a child node - don't become confused with the similarly named TiXmlHandle::Text() and TiXmlNode::ToText() which are safe type casts on the referenced node.

Definition at line 967 of file tinyxml.cpp.

Access the last attribute in this element.

Definition at line 973 of file tinyxml.h.

Definition at line 974 of file tinyxml.h.

void RTT::marsh::TiXmlElement::operator= ( const TiXmlElement base)

Definition at line 681 of file tinyxml.cpp.

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

Implements RTT::marsh::TiXmlBase.

Definition at line 1062 of file tinyxmlparser.cpp.

void RTT::marsh::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 RTT::marsh::TiXmlBase.

Definition at line 851 of file tinyxml.cpp.

int RTT::marsh::TiXmlElement::QueryDoubleAttribute ( const char *  name,
double *  _value 
) const

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

Definition at line 757 of file tinyxml.cpp.

int RTT::marsh::TiXmlElement::QueryFloatAttribute ( const char *  name,
float *  _value 
) const [inline]

QueryFloatAttribute examines the attribute - see QueryIntAttribute().

Definition at line 927 of file tinyxml.h.

int RTT::marsh::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.

Definition at line 746 of file tinyxml.cpp.

const char * RTT::marsh::TiXmlElement::ReadValue ( const char *  in,
TiXmlParsingData prevData,
TiXmlEncoding  encoding 
) [protected]

Definition at line 1182 of file tinyxmlparser.cpp.

void RTT::marsh::TiXmlElement::RemoveAttribute ( const char *  name)

Deletes an attribute with the given name.

Definition at line 507 of file tinyxml.cpp.

void RTT::marsh::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.

Definition at line 802 of file tinyxml.cpp.

void RTT::marsh::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.

Definition at line 768 of file tinyxml.cpp.

void RTT::marsh::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.

Definition at line 790 of file tinyxml.cpp.

void RTT::marsh::TiXmlElement::StreamOut ( TIXML_OSTREAM out) const [protected, virtual]

Implements RTT::marsh::TiXmlBase.

Definition at line 902 of file tinyxml.cpp.

virtual const TiXmlElement* RTT::marsh::TiXmlElement::ToElement ( ) const [inline, virtual]

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from RTT::marsh::TiXmlNode.

Definition at line 1020 of file tinyxml.h.

virtual TiXmlElement* RTT::marsh::TiXmlElement::ToElement ( ) [inline, virtual]

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from RTT::marsh::TiXmlNode.

Definition at line 1021 of file tinyxml.h.


Member Data Documentation

Definition at line 1042 of file tinyxml.h.


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


rtt
Author(s): RTT Developers
autogenerated on Fri Sep 9 2016 04:02:20