#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLElement:

Collaboration diagram for tinyxml2::XMLElement:

[legend]

Public Types
enum	ElementClosingType { OPEN , CLOSED , CLOSING }

Public Member Functions
const char *	Name () const
	Get the name of an element (which is the Value() of the node.)

void	SetName (const char *str, bool staticMem=false)
	Set the name of the element.

virtual XMLElement *	ToElement () override
	Safely cast to an Element, or null.

virtual const XMLElement *	ToElement () const override

virtual bool	Accept (XMLVisitor *visitor) const override

const char *	Attribute (const char name, const char value=0) const

int	IntAttribute (const char *name, int defaultValue=0) const

ProtocolPP::jarray< uint8_t >	ArrayAttribute (const char *name, ProtocolPP::jarray< uint8_t > defaultValue=ProtocolPP::jarray< uint8_t >(0)) const

uint8_t	ByteAttribute (const char *name) const

uint16_t	ShortAttribute (const char *name) const

unsigned	UnsignedAttribute (const char *name, unsigned defaultValue=0) const
	See IntAttribute()

int64_t	Int64Attribute (const char *name, int64_t defaultValue=0) const
	See IntAttribute()

uint64_t	Unsigned64Attribute (const char *name, uint64_t defaultValue=0) const
	See IntAttribute()

bool	BoolAttribute (const char *name, bool defaultValue=false) const
	See IntAttribute()

double	DoubleAttribute (const char *name, double defaultValue=0) const
	See IntAttribute()

float	FloatAttribute (const char *name, float defaultValue=0) const
	See IntAttribute()

XMLError	QueryIntAttribute (const char name, int value) const

XMLError	QueryArrayAttribute (const char name, ProtocolPP::jarray< uint8_t > value) const

XMLError	QueryByteAttribute (const char name, uint8_t value) const

XMLError	QueryShortAttribute (const char name, uint16_t value) const

XMLError	QueryUnsignedAttribute (const char name, unsigned int value) const
	See QueryIntAttribute()

XMLError	QueryInt64Attribute (const char name, int64_t value) const
	See QueryIntAttribute()

XMLError	QueryUnsigned64Attribute (const char name, uint64_t value) const
	See QueryIntAttribute()

XMLError	QueryBoolAttribute (const char name, bool value) const
	See QueryIntAttribute()

XMLError	QueryDoubleAttribute (const char name, double value) const
	See QueryIntAttribute()

XMLError	QueryFloatAttribute (const char name, float value) const
	See QueryIntAttribute()

XMLError	QueryStringAttribute (const char name, const char *value) const
	See QueryIntAttribute()

XMLError	QueryAttribute (const char name, int value) const

XMLError	QueryAttribute (const char name, ProtocolPP::jarray< uint8_t > value) const

XMLError	QueryAttribute (const char name, uint8_t value) const

XMLError	QueryAttribute (const char name, uint16_t value) const

XMLError	QueryAttribute (const char name, unsigned int value) const

XMLError	QueryAttribute (const char name, int64_t value) const

XMLError	QueryAttribute (const char name, uint64_t value) const

XMLError	QueryAttribute (const char name, bool value) const

XMLError	QueryAttribute (const char name, double value) const

XMLError	QueryAttribute (const char name, float value) const

XMLError	QueryAttribute (const char name, const char *value) const

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, ProtocolPP::jarray< uint8_t > value)
	Sets the named attribute to value (Added for Protocol++).

void	SetAttribute (const char *name, uint8_t value)
	Sets the named attribute to value (Added for Protocol++).

void	SetAttribute (const char *name, uint16_t value)
	Sets the named attribute to value (Added for Protocol++).

void	SetAttribute (const char *name, unsigned value)
	Sets the named attribute to value.

void	SetAttribute (const char *name, int64_t value)
	Sets the named attribute to value.

void	SetAttribute (const char *name, uint64_t 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	SetAttribute (const char *name, float value)
	Sets the named attribute to value.

void	DeleteAttribute (const char *name)

const XMLAttribute *	FirstAttribute () const
	Return the first attribute in the list.

const XMLAttribute *	FindAttribute (const char *name) const
	Query a specific attribute in the list.

const char *	GetText () const

void	SetText (const char *inText)

void	SetText (ProtocolPP::jarray< uint8_t > value)
	Convenience method for setting text inside an element. See SetText() for important limitations.(Added for Protocol++)

void	SetText (uint8_t value)
	Convenience method for setting text inside an element. See SetText() for important limitations.(Added for Protocol++)

void	SetText (uint16_t value)
	Convenience method for setting text inside an element. See SetText() for important limitations.(Added for Protocol++)

void	SetText (int value)
	Convenience method for setting text inside an element. See SetText() for important limitations.

void	SetText (unsigned value)
	Convenience method for setting text inside an element. See SetText() for important limitations.

void	SetText (int64_t value)
	Convenience method for setting text inside an element. See SetText() for important limitations.

void	SetText (uint64_t value)
	Convenience method for setting text inside an element. See SetText() for important limitations.

void	SetText (bool value)
	Convenience method for setting text inside an element. See SetText() for important limitations.

void	SetText (double value)
	Convenience method for setting text inside an element. See SetText() for important limitations.

void	SetText (float value)
	Convenience method for setting text inside an element. See SetText() for important limitations.

XMLError	QueryIntText (int *ival) const

XMLError	QueryArrayText (ProtocolPP::jarray< uint8_t > *uval) const
	See QueryIntText(). Added for ProtocolPP()

XMLError	QueryByteText (uint8_t *uval) const
	See QueryIntText(). Added for ProtocolPP()

XMLError	QueryShortText (uint16_t *uval) const
	See QueryIntText(). Added for ProtocolPP()

XMLError	QueryUnsignedText (unsigned *uval) const
	See QueryIntText()

XMLError	QueryInt64Text (int64_t *uval) const
	See QueryIntText()

XMLError	QueryUnsigned64Text (uint64_t *uval) const
	See QueryIntText()

XMLError	QueryBoolText (bool *bval) const
	See QueryIntText()

XMLError	QueryDoubleText (double *dval) const
	See QueryIntText()

XMLError	QueryFloatText (float *fval) const
	See QueryIntText()

int	IntText (int defaultValue=0) const

unsigned	UnsignedText (unsigned defaultValue=0) const
	See QueryIntText()

int64_t	Int64Text (int64_t defaultValue=0) const
	See QueryIntText()

uint64_t	Unsigned64Text (uint64_t defaultValue=0) const
	See QueryIntText()

bool	BoolText (bool defaultValue=false) const
	See QueryIntText()

double	DoubleText (double defaultValue=0) const
	See QueryIntText()

float	FloatText (float defaultValue=0) const
	See QueryIntText()

XMLElement *	InsertNewChildElement (const char *name)

XMLComment *	InsertNewComment (const char *comment)
	See InsertNewChildElement()

XMLText *	InsertNewText (const char *text)
	See InsertNewChildElement()

XMLDeclaration *	InsertNewDeclaration (const char *text)
	See InsertNewChildElement()

XMLUnknown *	InsertNewUnknown (const char *text)
	See InsertNewChildElement()

ElementClosingType	ClosingType () const

virtual XMLNode *	ShallowClone (XMLDocument *document) const override

virtual bool	ShallowEqual (const XMLNode *compare) const override

Public Member Functions inherited from tinyxml2::XMLNode
const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode.

XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode.

virtual XMLText *	ToText ()
	Safely cast to Text, or null.

virtual XMLComment *	ToComment ()
	Safely cast to a Comment, or null.

virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null.

virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null.

virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null.

virtual const XMLText *	ToText () const

virtual const XMLComment *	ToComment () const

virtual const XMLDocument *	ToDocument () const

virtual const XMLDeclaration *	ToDeclaration () const

virtual const XMLUnknown *	ToUnknown () const

int	ChildElementCount (const char *value) const

int	ChildElementCount () const

const char *	Value () const

void	SetValue (const char *val, bool staticMem=false)

int	GetLineNum () const
	Gets the line number the node is in, if the document was parsed from a file.

const XMLNode *	Parent () const
	Get the parent of this node on the DOM.

XMLNode *	Parent ()

bool	NoChildren () const
	Returns true if this node has no children.

const XMLNode *	FirstChild () const
	Get the first child node, or null if none exists.

XMLNode *	FirstChild ()

const XMLElement *	FirstChildElement (const char *name=0) const

XMLElement *	FirstChildElement (const char *name=0)

const XMLNode *	LastChild () const
	Get the last child node, or null if none exists.

XMLNode *	LastChild ()

const XMLElement *	LastChildElement (const char *name=0) const

XMLElement *	LastChildElement (const char *name=0)

const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node.

XMLNode *	PreviousSibling ()

const XMLElement *	PreviousSiblingElement (const char *name=0) const
	Get the previous (left) sibling element of this node, with an optionally supplied name.

XMLElement *	PreviousSiblingElement (const char *name=0)

const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node.

XMLNode *	NextSibling ()

const XMLElement *	NextSiblingElement (const char *name=0) const
	Get the next (right) sibling element of this node, with an optionally supplied name.

XMLElement *	NextSiblingElement (const char *name=0)

XMLNode *	InsertEndChild (XMLNode *addThis)

XMLNode *	LinkEndChild (XMLNode *addThis)

XMLNode *	InsertFirstChild (XMLNode *addThis)

XMLNode *	InsertAfterChild (XMLNode afterThis, XMLNode addThis)

void	DeleteChildren ()

void	DeleteChild (XMLNode *node)

XMLNode *	DeepClone (XMLDocument *target) const

void	SetUserData (void *userData)

void *	GetUserData () const

Protected Member Functions
char *	ParseDeep (char p, StrPair parentEndTag, int *curLineNumPtr) override

Protected Member Functions inherited from tinyxml2::XMLNode
	XMLNode (XMLDocument *)

Friends
class	XMLDocument

Additional Inherited Members
Protected Attributes inherited from tinyxml2::XMLNode
XMLDocument *	_document

XMLNode *	_parent

StrPair	_value

int	_parseLineNum

XMLNode *	_firstChild

XMLNode *	_lastChild

XMLNode *	_prev

XMLNode *	_next

void *	_userData

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.

Member Function Documentation

◆ Accept()

virtual bool tinyxml2::XMLElement::Accept ( XMLVisitor * visitor ) const

overridevirtual

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

This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML-2 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():

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

Implements tinyxml2::XMLNode.

◆ ArrayAttribute()

ProtocolPP::jarray<uint8_t> tinyxml2::XMLElement::ArrayAttribute	(	const char *	name,
		ProtocolPP::jarray< uint8_t >	defaultValue = `ProtocolPP::jarray< uint8_t >(0)`
	)		const

Given an attribute name, ArrayAttribute() returns the value of the attribute interpreted as a byte array. 0 will be returned if there is an error. For a method with error checking, see QueryArrayAttribute(). Added for ProtocolPP()

◆ Attribute()

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();
}

◆ ByteAttribute()

uint8_t tinyxml2::XMLElement::ByteAttribute ( const char * name ) const

Given an attribute name, ByteAttribute() returns the value of the attribute interpreted as a byte. 0 will be returned if there is an error. For a method with error checking, see QueryByteAttribute(). Added for ProtocolPP()

◆ DeleteAttribute()

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

Delete an attribute.

◆ GetText()

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 XMLText child and accessing it directly.

If the first child of 'this' is a XMLText, 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 ".

◆ InsertNewChildElement()

XMLElement* tinyxml2::XMLElement::InsertNewChildElement ( const char * name )

Convenience method to create a new XMLElement and add it as last (right) child of this node. Returns the created and inserted element.

◆ IntAttribute()

int tinyxml2::XMLElement::IntAttribute	(	const char *	name,
		int	defaultValue = `0`
	)		const

Given an attribute name, IntAttribute() returns the value of the attribute interpreted as an integer. The default value will be returned if the attribute isn't present, or if there is an error. (For a method with error checking, see QueryIntAttribute()).

◆ QueryArrayAttribute()

XMLError tinyxml2::XMLElement::QueryArrayAttribute	(	const char *	name,
		ProtocolPP::jarray< uint8_t > *	value
	)		const

inline

Given an attribute name, QueryArrayAttribute() 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:

/// jarray<uint8_t> value(10, 0xAA);
/// QueryArrayAttribute( "key", &value );  // if "key" isn't found, value will still be 10 bytes of "AA"
///

Added for ProtocolPP()

Here is the call graph for this function:

◆ QueryAttribute() [1/4]

XMLError tinyxml2::XMLElement::QueryAttribute	(	const char *	name,
		int *	value
	)		const

inline

Given an attribute name, QueryAttribute() returns XML_SUCCESS, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. It is overloaded for the primitive types, and is a generally more convenient replacement of QueryIntAttribute() and related functions.

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;
QueryAttribute( "foo", &value );        // if "foo" isn't found, value will still be 10

◆ QueryAttribute() [2/4]

XMLError tinyxml2::XMLElement::QueryAttribute	(	const char *	name,
		ProtocolPP::jarray< uint8_t > *	value
	)		const

inline

Given an attribute name, QueryAttribute() 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:

/// jarray<uint8_t> value(4, 0xCC);
/// QueryAttribute( "seqnum", &value );  // if "seqnum" isn't found, value will still be "00000000"
///

Added for ProtocolPP()

◆ QueryAttribute() [3/4]

XMLError tinyxml2::XMLElement::QueryAttribute	(	const char *	name,
		uint16_t *	value
	)		const

inline

Given an attribute name, QueryAttribute() 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:

/// uint16_t value = 0xFFFF;
/// QueryAttribute( "seqnum", &value );  // if "seqnum" isn't found, value will still be "FFFF"
///

Added for ProtocolPP()

◆ QueryAttribute() [4/4]

XMLError tinyxml2::XMLElement::QueryAttribute	(	const char *	name,
		uint8_t *	value
	)		const

inline

Given an attribute name, QueryAttribute() 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:

/// uint8_t value = 0xFF;
/// QueryAttribute( "nh", &value );  // if "nh" isn't found, value will still be "FF"
///

Added for ProtocolPP()

◆ QueryByteAttribute()

XMLError tinyxml2::XMLElement::QueryByteAttribute	(	const char *	name,
		uint8_t *	value
	)		const

inline

Given an attribute name, QueryByteAttribute() 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:

/// uint8_t value = 0xFF;
/// QueryByteAttribute( "nh", &value );  // if "nh" isn't found, value will still be "FF"
///

Added for ProtocolPP()

Here is the call graph for this function:

◆ QueryIntAttribute()

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

inline

Given an attribute name, QueryIntAttribute() returns XML_SUCCESS, 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

Here is the call graph for this function:

◆ QueryIntText()

XMLError tinyxml2::XMLElement::QueryIntText ( int * ival ) const

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.

◆ QueryShortAttribute()

XMLError tinyxml2::XMLElement::QueryShortAttribute	(	const char *	name,
		uint16_t *	value
	)		const

inline

Given an attribute name, QueryShortAttribute() 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:

/// uint16_t value = 0xFFFE;
/// QueryShortAttribute( "version", &value );  // if "version" isn't found, value will still be "FFFE"
///

Added for ProtocolPP()

Here is the call graph for this function:

◆ SetText()

void tinyxml2::XMLElement::SetText ( const char * inText )

Convenience function for easy access to the text inside an element. Although easy and concise, SetText() is limited compared to creating an XMLText child and mutating it directly.

If the first child of 'this' is a XMLText, SetText() sets its value to the given string, otherwise it will create a first child that is an XMLText.

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

<foo>This is text</foo>
    fooElement->SetText( "Hullaballoo!" );
<foo>Hullaballoo!</foo>

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

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

then it will not change "This is text", but rather prefix it with a text element:

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

For this XML:

    <foo />

SetText() will generate

    <foo>Hullaballoo!</foo>

◆ ShallowClone()

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

overridevirtual

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.

◆ ShallowEqual()

virtual bool tinyxml2::XMLElement::ShallowEqual ( const XMLNode * compare ) const

overridevirtual

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.

◆ ShortAttribute()

uint16_t tinyxml2::XMLElement::ShortAttribute ( const char * name ) const

Given an attribute name, ShortAttribute() returns the value of the attribute interpreted as a uint16_t. 0 will be returned if there is an error. For a method with error checking, see QueryShortAttribute(). Added for ProtocolPP()

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

include/tinyxml2.h

Public Types

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Accept()

◆ ArrayAttribute()

◆ Attribute()

◆ ByteAttribute()

◆ DeleteAttribute()

◆ GetText()

◆ InsertNewChildElement()

◆ IntAttribute()

◆ QueryArrayAttribute()

◆ QueryAttribute() [1/4]

◆ QueryAttribute() [2/4]

◆ QueryAttribute() [3/4]

◆ QueryAttribute() [4/4]

◆ QueryByteAttribute()

◆ QueryIntAttribute()

◆ QueryIntText()

◆ QueryShortAttribute()

◆ SetText()

◆ ShallowClone()

◆ ShallowEqual()

◆ ShortAttribute()