Public Member Functions | Private Attributes | List of all members
BT_TinyXML2::XMLHandle Class Reference

#include <tinyxml2.h>

Public Member Functions

XMLHandle FirstChild ()
 Get the first child of this handle. More...
 
XMLHandle FirstChildElement (const char *name=0)
 Get the first child element of this handle. More...
 
XMLHandle LastChild ()
 Get the last child of this handle. More...
 
XMLHandle LastChildElement (const char *name=0)
 Get the last child element of this handle. More...
 
XMLHandle NextSibling ()
 Get the next sibling of this handle. More...
 
XMLHandle NextSiblingElement (const char *name=0)
 Get the next sibling element of this handle. More...
 
XMLHandleoperator= (const XMLHandle &ref)
 Assignment. More...
 
XMLHandle PreviousSibling ()
 Get the previous sibling of this handle. More...
 
XMLHandle PreviousSiblingElement (const char *name=0)
 Get the previous sibling element of this handle. More...
 
XMLDeclarationToDeclaration ()
 Safe cast to XMLDeclaration. This can return null. More...
 
XMLElementToElement ()
 Safe cast to XMLElement. This can return null. More...
 
XMLNodeToNode ()
 Safe cast to XMLNode. This can return null. More...
 
XMLTextToText ()
 Safe cast to XMLText. This can return null. More...
 
XMLUnknownToUnknown ()
 Safe cast to XMLUnknown. This can return null. More...
 
 XMLHandle (XMLNode *node)
 Create a handle from any node (at any depth of the tree.) This can be a null pointer. More...
 
 XMLHandle (XMLNode &node)
 Create a handle from a node. More...
 
 XMLHandle (const XMLHandle &ref)
 Copy constructor. More...
 

Private Attributes

XMLNode_node
 

Detailed Description

A XMLHandle is a class that wraps a node pointer with null checks; this is an incredibly useful thing. Note that XMLHandle is not part of the TinyXML-2 DOM structure. It is a separate utility class.

Take an example:

<Document>
        <Element attributeA = "valueA">
                <Child attributeB = "value1" />
                <Child attributeB = "value2" />
        </Element>
</Document>

Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very easy to write a lot of code that looks like:

XMLElement* root = document.FirstChildElement( "Document" );
if ( root )
{
        XMLElement* element = root->FirstChildElement( "Element" );
        if ( element )
        {
                XMLElement* child = element->FirstChildElement( "Child" );
                if ( child )
                {
                        XMLElement* child2 = child->NextSiblingElement( "Child" );
                        if ( child2 )
                        {
                                // Finally do something useful.

And that doesn't even cover "else" cases. XMLHandle addresses the verbosity of such code. A XMLHandle checks for null pointers so it is perfectly safe and correct to use:

XMLHandle docHandle( &document );
XMLElement* child2 = docHandle.FirstChildElement( "Document" ).FirstChildElement( "Element" ).FirstChildElement().NextSiblingElement();
if ( child2 )
{
        // do something useful

Which is MUCH more concise and useful.

It is also safe to copy handles - internally they are nothing more than node pointers.

XMLHandle handleCopy = handle;

See also XMLConstHandle, which is the same as XMLHandle, but operates on const objects.

Definition at line 1990 of file tinyxml2.h.

Constructor & Destructor Documentation

BT_TinyXML2::XMLHandle::XMLHandle ( XMLNode node)
inlineexplicit

Create a handle from any node (at any depth of the tree.) This can be a null pointer.

Definition at line 1994 of file tinyxml2.h.

BT_TinyXML2::XMLHandle::XMLHandle ( XMLNode node)
inlineexplicit

Create a handle from a node.

Definition at line 1997 of file tinyxml2.h.

BT_TinyXML2::XMLHandle::XMLHandle ( const XMLHandle ref)
inline

Copy constructor.

Definition at line 2000 of file tinyxml2.h.

Member Function Documentation

XMLHandle BT_TinyXML2::XMLHandle::FirstChild ( )
inline

Get the first child of this handle.

Definition at line 2009 of file tinyxml2.h.

XMLHandle BT_TinyXML2::XMLHandle::FirstChildElement ( const char *  name = 0)
inline

Get the first child element of this handle.

Definition at line 2013 of file tinyxml2.h.

XMLHandle BT_TinyXML2::XMLHandle::LastChild ( )
inline

Get the last child of this handle.

Definition at line 2017 of file tinyxml2.h.

XMLHandle BT_TinyXML2::XMLHandle::LastChildElement ( const char *  name = 0)
inline

Get the last child element of this handle.

Definition at line 2021 of file tinyxml2.h.

XMLHandle BT_TinyXML2::XMLHandle::NextSibling ( )
inline

Get the next sibling of this handle.

Definition at line 2033 of file tinyxml2.h.

XMLHandle BT_TinyXML2::XMLHandle::NextSiblingElement ( const char *  name = 0)
inline

Get the next sibling element of this handle.

Definition at line 2037 of file tinyxml2.h.

XMLHandle& BT_TinyXML2::XMLHandle::operator= ( const XMLHandle ref)
inline

Assignment.

Definition at line 2003 of file tinyxml2.h.

XMLHandle BT_TinyXML2::XMLHandle::PreviousSibling ( )
inline

Get the previous sibling of this handle.

Definition at line 2025 of file tinyxml2.h.

XMLHandle BT_TinyXML2::XMLHandle::PreviousSiblingElement ( const char *  name = 0)
inline

Get the previous sibling element of this handle.

Definition at line 2029 of file tinyxml2.h.

XMLDeclaration* BT_TinyXML2::XMLHandle::ToDeclaration ( )
inline

Safe cast to XMLDeclaration. This can return null.

Definition at line 2058 of file tinyxml2.h.

XMLElement* BT_TinyXML2::XMLHandle::ToElement ( )
inline

Safe cast to XMLElement. This can return null.

Definition at line 2046 of file tinyxml2.h.

XMLNode* BT_TinyXML2::XMLHandle::ToNode ( )
inline

Safe cast to XMLNode. This can return null.

Definition at line 2042 of file tinyxml2.h.

XMLText* BT_TinyXML2::XMLHandle::ToText ( )
inline

Safe cast to XMLText. This can return null.

Definition at line 2050 of file tinyxml2.h.

XMLUnknown* BT_TinyXML2::XMLHandle::ToUnknown ( )
inline

Safe cast to XMLUnknown. This can return null.

Definition at line 2054 of file tinyxml2.h.

Member Data Documentation

XMLNode* BT_TinyXML2::XMLHandle::_node
private

Definition at line 2063 of file tinyxml2.h.


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


behaviortree_cpp
Author(s): Michele Colledanchise, Davide Faconti
autogenerated on Sat Jun 8 2019 18:04:06