#include <tinyxml.h>
Collaboration diagram for TiXmlHandle:
Note that TiXmlHandle is not part of the TinyXml 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:
TiXmlElement* root = document.FirstChildElement( "Document" );
if ( root )
{
TiXmlElement* element = root->FirstChildElement( "Element" );
if ( element )
{
TiXmlElement* child = element->FirstChildElement( "Child" );
if ( child )
{
TiXmlElement* child2 = child->NextSiblingElement( "Child" );
if ( child2 )
{
// Finally do something useful.
And that doesn't even cover "else" cases. TiXmlHandle addresses the verbosity of such code. A TiXmlHandle checks for null pointers so it is perfectly safe and correct to use:
TiXmlHandle docHandle( &document );
TiXmlElement* child2 = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", 1 ).Element();
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.
TiXmlHandle handleCopy = handle;
What they should not be used for is iteration:
int i=0;
while ( true )
{
TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", i ).Element();
if ( !child )
break;
// do something
++i;
}
It seems reasonable, but it is in fact two embedded while loops. The Child method is a linear walk to find the element, so this code would iterate much more than it needs to. Instead, prefer:
TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).FirstChild( "Child" ).Element();
for( child; child; child=child->NextSiblingElement() )
{
// do something
}
Definition at line 1457 of file tinyxml.h.
Public Member Functions | |
| TiXmlHandle (TiXmlNode *_node) | |
| Create a handle from any node (at any depth of the tree.) This can be a null pointer. | |
| TiXmlHandle (const TiXmlHandle &ref) | |
| Copy constructor. | |
| TiXmlHandle | operator= (const TiXmlHandle &ref) |
| TiXmlHandle | FirstChild () const |
| Return a handle to the first child node. | |
| TiXmlHandle | FirstChild (const char *value) const |
| Return a handle to the first child node with the given name. | |
| TiXmlHandle | FirstChildElement () const |
| Return a handle to the first child element. | |
| TiXmlHandle | FirstChildElement (const char *value) const |
| Return a handle to the first child element with the given name. | |
| TiXmlHandle | Child (const char *value, int index) const |
| Return a handle to the "index" child with the given name. | |
| TiXmlHandle | Child (int index) const |
| Return a handle to the "index" child. | |
| TiXmlHandle | ChildElement (const char *value, int index) const |
| Return a handle to the "index" child element with the given name. | |
| TiXmlHandle | ChildElement (int index) const |
| Return a handle to the "index" child element. | |
| TiXmlNode * | Node () const |
| Return the handle as a TiXmlNode. This may return null. | |
| TiXmlElement * | Element () const |
| Return the handle as a TiXmlElement. This may return null. | |
| TiXmlText * | Text () const |
| Return the handle as a TiXmlText. This may return null. | |
| TiXmlUnknown * | Unknown () const |
| Return the handle as a TiXmlUnknown. This may return null;. | |
Private Attributes | |
| TiXmlNode * | node |
|
|
Create a handle from any node (at any depth of the tree.) This can be a null pointer.
Definition at line 1461 of file tinyxml.h. Referenced by Child(), ChildElement(), FirstChild(), and FirstChildElement(). |
|
|
Copy constructor.
Definition at line 1463 of file tinyxml.h. References node. |
|
|
Return a handle to the "index" child. The first child is 0, the second 1, etc. Definition at line 1727 of file tinyxml.cpp. References TiXmlNode::FirstChild(), TiXmlNode::NextSibling(), node, and TiXmlHandle(). |
|
||||||||||||
|
Return a handle to the "index" child with the given name. The first child is 0, the second 1, etc. Definition at line 1746 of file tinyxml.cpp. References TiXmlNode::FirstChild(), TiXmlNode::NextSibling(), node, TiXmlHandle(), and value. Referenced by DMUAccelerometer::DMUAccelerometer(), DMURateGyro::DMURateGyro(), Whorl::Initialize(), MomentumWheel::Initialize(), Magnetometer::Magnetometer(), main(), WhorlHistory::Parse(), WheelHistory::Parse(), triadObserver::Parse(), QuaternionEKFObserver::Parse(), WhorlSim::SetController(), WhorlSim::SetObserver(), WhorlSim::SetOrbitController(), and WhorlSim::SetOrbitObserver(). |
|
|
Return a handle to the "index" child element. The first child element is 0, the second 1, etc. Note that only TiXmlElements are indexed: other types are not counted. Definition at line 1765 of file tinyxml.cpp. References TiXmlNode::FirstChildElement(), TiXmlNode::NextSiblingElement(), node, and TiXmlHandle(). |
|
||||||||||||
|
Return a handle to the "index" child element with the given name. The first child element is 0, the second 1, etc. Note that only TiXmlElements are indexed: other types are not counted. Definition at line 1784 of file tinyxml.cpp. References TiXmlNode::FirstChildElement(), TiXmlNode::NextSiblingElement(), node, TiXmlHandle(), and value. Referenced by main(). |
|
|
Return the handle as a TiXmlElement. This may return null.
Definition at line 1505 of file tinyxml.h. Referenced by DMUAccelerometer::DMUAccelerometer(), DMURateGyro::DMURateGyro(), Whorl::Initialize(), MomentumWheel::Initialize(), Magnetometer::Magnetometer(), main(), WhorlHistory::Parse(), WheelHistory::Parse(), triadObserver::Parse(), QuaternionEKFObserver::Parse(), WhorlSim::SetController(), WhorlSim::SetObserver(), WhorlSim::SetOrbitController(), WhorlSim::SetOrbitObserver(), and simulatorInertia(). |
|
|
Return a handle to the first child node with the given name.
Definition at line 1691 of file tinyxml.cpp. References TiXmlNode::FirstChild(), node, TiXmlHandle(), and value. |
|
|
Return a handle to the first child node.
Definition at line 1679 of file tinyxml.cpp. References TiXmlNode::FirstChild(), node, and TiXmlHandle(). Referenced by DMUAccelerometer::DMUAccelerometer(), DMURateGyro::DMURateGyro(), Whorl::Initialize(), MomentumWheel::Initialize(), Magnetometer::Magnetometer(), main(), WhorlHistory::Parse(), WheelHistory::Parse(), triadObserver::Parse(), QuaternionEKFObserver::Parse(), WhorlSim::SetController(), WhorlSim::SetObserver(), WhorlSim::SetOrbitController(), WhorlSim::SetOrbitObserver(), and simulatorInertia(). |
|
|
Return a handle to the first child element with the given name.
Definition at line 1715 of file tinyxml.cpp. References TiXmlNode::FirstChildElement(), node, TiXmlHandle(), and value. |
|
|
Return a handle to the first child element.
Definition at line 1703 of file tinyxml.cpp. References TiXmlNode::FirstChildElement(), node, and TiXmlHandle(). Referenced by main(). |
|
|
Return the handle as a TiXmlNode. This may return null.
Definition at line 1503 of file tinyxml.h. Referenced by main(). |
|
|
Definition at line 1464 of file tinyxml.h. References node. |
|
|
Return the handle as a TiXmlText. This may return null.
Definition at line 1507 of file tinyxml.h. Referenced by main(). |
|
|
Return the handle as a TiXmlUnknown. This may return null;.
Definition at line 1509 of file tinyxml.h. Referenced by main(). |
|
|
Definition at line 1512 of file tinyxml.h. Referenced by Child(), ChildElement(), FirstChild(), FirstChildElement(), operator=(), and TiXmlHandle(). |
1.3.9.1