Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends
tinyxml2::XMLElement Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLElement:
Inheritance graph
[legend]

List of all members.

Public Types

enum  { OPEN, CLOSED, CLOSING }

Public Member Functions

virtual bool Accept (XMLVisitor *visitor) const
const char * Attribute (const char *name, const char *value=0) const
bool BoolAttribute (const char *name) const
 See IntAttribute()
int ClosingType () const
void DeleteAttribute (const char *name)
double DoubleAttribute (const char *name) const
 See IntAttribute()
const XMLAttributeFindAttribute (const char *name) const
 Query a specific attribute in the list.
const XMLAttributeFirstAttribute () const
 Return the first attribute in the list.
float FloatAttribute (const char *name) const
 See IntAttribute()
const char * GetText () const
int IntAttribute (const char *name) const
const char * Name () const
 Get the name of an element (which is the Value() of the node.)
char * ParseDeep (char *p, StrPair *endTag)
XMLError QueryBoolAttribute (const char *name, bool *value) const
 See QueryIntAttribute()
XMLError QueryBoolText (bool *bval) const
 See QueryIntText()
XMLError QueryDoubleAttribute (const char *name, double *value) const
 See QueryIntAttribute()
XMLError QueryDoubleText (double *dval) const
 See QueryIntText()
XMLError QueryFloatAttribute (const char *name, float *value) const
 See QueryIntAttribute()
XMLError QueryFloatText (float *fval) const
 See QueryIntText()
XMLError QueryIntAttribute (const char *name, int *value) const
XMLError QueryIntText (int *ival) const
XMLError QueryUnsignedAttribute (const char *name, unsigned int *value) const
 See QueryIntAttribute()
XMLError QueryUnsignedText (unsigned *uval) const
 See QueryIntText()
void SetAttribute (const char *name, const char *value)
 Sets the named attribute to value.
void SetAttribute (const char *name, int value)
 Sets the named attribute to value.
void SetAttribute (const char *name, unsigned value)
 Sets the named attribute to value.
void SetAttribute (const char *name, bool value)
 Sets the named attribute to value.
void SetAttribute (const char *name, double value)
 Sets the named attribute to value.
void SetName (const char *str, bool staticMem=false)
 Set the name of the element.
virtual XMLNodeShallowClone (XMLDocument *document) const
virtual bool ShallowEqual (const XMLNode *compare) const
virtual XMLElementToElement ()
 Safely cast to an Element, or null.
virtual const XMLElementToElement () const
unsigned UnsignedAttribute (const char *name) const
 See IntAttribute()

Private Member Functions

XMLAttributeFindAttribute (const char *name)
XMLAttributeFindOrCreateAttribute (const char *name)
void operator= (const XMLElement &)
char * ParseAttributes (char *p)
 XMLElement (XMLDocument *doc)
 XMLElement (const XMLElement &)
virtual ~XMLElement ()

Private Attributes

int _closingType
XMLAttribute_rootAttribute

Friends

class XMLBase
class XMLDocument

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 1075 of file tinyxml2.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
OPEN 
CLOSED 
CLOSING 

Definition at line 1315 of file tinyxml2.h.


Constructor & Destructor Documentation

Definition at line 1171 of file tinyxml2.cpp.

tinyxml2::XMLElement::~XMLElement ( ) [private, virtual]

Definition at line 1178 of file tinyxml2.cpp.


Member Function Documentation

bool tinyxml2::XMLElement::Accept ( XMLVisitor visitor) const [virtual]

Accept a hierarchical visit of the nodes in the TinyXML DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the TiXmlVisitor interface.

This is essentially a SAX interface for TinyXML. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML is unchanged by using this interface versus any other.)

The interface has been based on ideas from:

Which are both good references for "visiting".

An example of using Accept():

    	TiXmlPrinter printer;
    	tinyxmlDoc.Accept( &printer );
    	const char* xmlcstr = printer.CStr();
    	

Implements tinyxml2::XMLNode.

Definition at line 1477 of file tinyxml2.cpp.

const char * tinyxml2::XMLElement::Attribute ( const char *  name,
const char *  value = 0 
) const

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

    	const char* value = ele->Attribute( "foo" );
    	

The 'value' parameter is normally null. However, if specified, the attribute will only be returned if the 'name' and 'value' match. This allow you to write code:

    	if ( ele->Attribute( "foo", "bar" ) ) callFooIsBar();
    	

rather than:

    	if ( ele->Attribute( "foo" ) ) {
    		if ( strcmp( ele->Attribute( "foo" ), "bar" ) == 0 ) callFooIsBar();
    	}
    	

Definition at line 1212 of file tinyxml2.cpp.

bool tinyxml2::XMLElement::BoolAttribute ( const char *  name) const [inline]

See IntAttribute()

Definition at line 1139 of file tinyxml2.h.

int tinyxml2::XMLElement::ClosingType ( ) const [inline]

Definition at line 1320 of file tinyxml2.h.

void tinyxml2::XMLElement::DeleteAttribute ( const char *  name)

Delete an attribute.

Definition at line 1327 of file tinyxml2.cpp.

double tinyxml2::XMLElement::DoubleAttribute ( const char *  name) const [inline]

See IntAttribute()

Definition at line 1145 of file tinyxml2.h.

const XMLAttribute * tinyxml2::XMLElement::FindAttribute ( const char *  name) const

Query a specific attribute in the list.

Definition at line 1200 of file tinyxml2.cpp.

XMLAttribute * tinyxml2::XMLElement::FindAttribute ( const char *  name) [private]

Definition at line 1188 of file tinyxml2.cpp.

XMLAttribute * tinyxml2::XMLElement::FindOrCreateAttribute ( const char *  name) [private]

Definition at line 1300 of file tinyxml2.cpp.

Return the first attribute in the list.

Definition at line 1242 of file tinyxml2.h.

float tinyxml2::XMLElement::FloatAttribute ( const char *  name) const [inline]

See IntAttribute()

Definition at line 1151 of file tinyxml2.h.

const char * tinyxml2::XMLElement::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 ".

Definition at line 1225 of file tinyxml2.cpp.

int tinyxml2::XMLElement::IntAttribute ( const char *  name) const [inline]

Given an attribute name, IntAttribute() returns the value of the attribute interpreted as an integer. 0 will be returned if there is an error. For a method with error checking, see QueryIntAttribute()

Definition at line 1127 of file tinyxml2.h.

const char* tinyxml2::XMLElement::Name ( ) const [inline]

Get the name of an element (which is the Value() of the node.)

Definition at line 1081 of file tinyxml2.h.

void tinyxml2::XMLElement::operator= ( const XMLElement ) [private]
char * tinyxml2::XMLElement::ParseAttributes ( char *  p) [private]

Definition at line 1346 of file tinyxml2.cpp.

char * tinyxml2::XMLElement::ParseDeep ( char *  p,
StrPair endTag 
) [virtual]

Reimplemented from tinyxml2::XMLNode.

Definition at line 1407 of file tinyxml2.cpp.

XMLError tinyxml2::XMLElement::QueryBoolAttribute ( const char *  name,
bool *  value 
) const [inline]

See QueryIntAttribute()

Definition at line 1186 of file tinyxml2.h.

See QueryIntText()

Definition at line 1260 of file tinyxml2.cpp.

XMLError tinyxml2::XMLElement::QueryDoubleAttribute ( const char *  name,
double *  value 
) const [inline]

See QueryIntAttribute()

Definition at line 1194 of file tinyxml2.h.

See QueryIntText()

Definition at line 1273 of file tinyxml2.cpp.

XMLError tinyxml2::XMLElement::QueryFloatAttribute ( const char *  name,
float *  value 
) const [inline]

See QueryIntAttribute()

Definition at line 1202 of file tinyxml2.h.

See QueryIntText()

Definition at line 1286 of file tinyxml2.cpp.

XMLError tinyxml2::XMLElement::QueryIntAttribute ( const char *  name,
int *  value 
) const [inline]

Given an attribute name, QueryIntAttribute() returns XML_NO_ERROR, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. If successful, the result of the conversion will be written to 'value'. If not successful, nothing will be written to 'value'. This allows you to provide default value:

    	int value = 10;
    	QueryIntAttribute( "foo", &value );		// if "foo" isn't found, value will still be 10
    	

Definition at line 1170 of file tinyxml2.h.

Convenience method to query the value of a child text node. This is probably best shown by example. Given you have a document is this form:

    		<point>
    			<x>1</x>
    			<y>1.4</y>
    		</point>
    	

The QueryIntText() and similar functions provide a safe and easier way to get to the "value" of x and y.

    		int x = 0;
    		float y = 0;	// types of x and y are contrived for example
    		const XMLElement* xElement = pointElement->FirstChildElement( "x" );
    		const XMLElement* yElement = pointElement->FirstChildElement( "y" );
    		xElement->QueryIntText( &x );
    		yElement->QueryFloatText( &y );
    	
Returns:
XML_SUCCESS (0) on success, XML_CAN_NOT_CONVERT_TEXT if the text cannot be converted to the requested type, and XML_NO_TEXT_NODE if there is no child text to query.

Definition at line 1234 of file tinyxml2.cpp.

XMLError tinyxml2::XMLElement::QueryUnsignedAttribute ( const char *  name,
unsigned int *  value 
) const [inline]

See QueryIntAttribute()

Definition at line 1178 of file tinyxml2.h.

See QueryIntText()

Definition at line 1247 of file tinyxml2.cpp.

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
const char *  value 
) [inline]

Sets the named attribute to value.

Definition at line 1211 of file tinyxml2.h.

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
int  value 
) [inline]

Sets the named attribute to value.

Definition at line 1216 of file tinyxml2.h.

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
unsigned  value 
) [inline]

Sets the named attribute to value.

Definition at line 1221 of file tinyxml2.h.

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
bool  value 
) [inline]

Sets the named attribute to value.

Definition at line 1226 of file tinyxml2.h.

void tinyxml2::XMLElement::SetAttribute ( const char *  name,
double  value 
) [inline]

Sets the named attribute to value.

Definition at line 1231 of file tinyxml2.h.

void tinyxml2::XMLElement::SetName ( const char *  str,
bool  staticMem = false 
) [inline]

Set the name of the element.

Definition at line 1085 of file tinyxml2.h.

XMLNode * tinyxml2::XMLElement::ShallowClone ( XMLDocument document) const [virtual]

Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())

Note: if called on a XMLDocument, this will return null.

Implements tinyxml2::XMLNode.

Definition at line 1439 of file tinyxml2.cpp.

bool tinyxml2::XMLElement::ShallowEqual ( const XMLNode compare) const [virtual]

Test if 2 nodes are the same, but don't test children. The 2 nodes do not need to be in the same Document.

Note: if called on a XMLDocument, this will return false.

Implements tinyxml2::XMLNode.

Definition at line 1452 of file tinyxml2.cpp.

virtual XMLElement* tinyxml2::XMLElement::ToElement ( ) [inline, virtual]

Safely cast to an Element, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 1089 of file tinyxml2.h.

virtual const XMLElement* tinyxml2::XMLElement::ToElement ( ) const [inline, virtual]

Reimplemented from tinyxml2::XMLNode.

Definition at line 1092 of file tinyxml2.h.

unsigned tinyxml2::XMLElement::UnsignedAttribute ( const char *  name) const [inline]

See IntAttribute()

Definition at line 1133 of file tinyxml2.h.


Friends And Related Function Documentation

friend class XMLBase [friend]

Definition at line 1077 of file tinyxml2.h.

friend class XMLDocument [friend]

Reimplemented from tinyxml2::XMLNode.

Definition at line 1078 of file tinyxml2.h.


Member Data Documentation

Definition at line 1338 of file tinyxml2.h.

Definition at line 1342 of file tinyxml2.h.


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


oculus_sdk
Author(s): Tully Foote
autogenerated on Thu Jun 6 2019 20:13:50