#include <tinyxml.h>
Public Member Functions | |
| virtual bool | Accept (TiXmlVisitor *visitor) const |
| 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 TiXmlNode * | Clone () const |
| Creates a new Element and returns it - the returned element is a copy. | |
| const TiXmlAttribute * | FirstAttribute () const |
| Access the first attribute in this element. | |
| TiXmlAttribute * | FirstAttribute () |
| const char * | GetText () const |
| const TiXmlAttribute * | LastAttribute () const |
| Access the last attribute in this element. | |
| TiXmlAttribute * | LastAttribute () |
| 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 TiXmlElement * | ToElement () const |
| Cast to a more defined type. Will return null not of the requested type. | |
| virtual TiXmlElement * | ToElement () |
| 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) |
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.
Constructor & Destructor Documentation
| rospack_tinyxml::TiXmlElement::TiXmlElement | ( | const char * | in_value | ) |
Construct an element.
Definition at line 505 of file tinyxml.cpp.
| rospack_tinyxml::TiXmlElement::TiXmlElement | ( | const TiXmlElement & | copy | ) |
Definition at line 523 of file tinyxml.cpp.
| rospack_tinyxml::TiXmlElement::~TiXmlElement | ( | ) | [virtual] |
Definition at line 538 of file tinyxml.cpp.
Member Function Documentation
| bool rospack_tinyxml::TiXmlElement::Accept | ( | TiXmlVisitor * | visitor | ) | const [virtual] |
Walk the XML tree visiting this node and all of its children.
Implements rospack_tinyxml::TiXmlNode.
Definition at line 847 of file tinyxml.cpp.
| const char * rospack_tinyxml::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 556 of file tinyxml.cpp.
| const char * rospack_tinyxml::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 576 of file tinyxml.cpp.
| const char * rospack_tinyxml::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 610 of file tinyxml.cpp.
| void rospack_tinyxml::TiXmlElement::ClearThis | ( | ) | [protected] |
Definition at line 544 of file tinyxml.cpp.
| TiXmlNode * rospack_tinyxml::TiXmlElement::Clone | ( | ) | const [virtual] |
Creates a new Element and returns it - the returned element is a copy.
Implements rospack_tinyxml::TiXmlNode.
Definition at line 861 of file tinyxml.cpp.
| void rospack_tinyxml::TiXmlElement::CopyTo | ( | TiXmlElement * | target | ) | const [protected] |
Definition at line 825 of file tinyxml.cpp.
| const TiXmlAttribute* rospack_tinyxml::TiXmlElement::FirstAttribute | ( | ) | const [inline] |
| TiXmlAttribute* rospack_tinyxml::TiXmlElement::FirstAttribute | ( | ) | [inline] |
| const char * rospack_tinyxml::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 872 of file tinyxml.cpp.
| const TiXmlAttribute* rospack_tinyxml::TiXmlElement::LastAttribute | ( | ) | const [inline] |
| TiXmlAttribute* rospack_tinyxml::TiXmlElement::LastAttribute | ( | ) | [inline] |
| void rospack_tinyxml::TiXmlElement::operator= | ( | const TiXmlElement & | base | ) |
Definition at line 531 of file tinyxml.cpp.
| const char * rospack_tinyxml::TiXmlElement::Parse | ( | const char * | p, |
| TiXmlParsingData * | data, | ||
| TiXmlEncoding | encoding | ||
| ) | [virtual] |
Implements rospack_tinyxml::TiXmlBase.
Definition at line 1051 of file tinyxmlparser.cpp.
| void rospack_tinyxml::TiXmlElement::Print | ( | FILE * | cfile, |
| int | depth | ||
| ) | const [virtual] |
All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.
This is a formatted print, and will insert tabs and newlines.
(For an unformatted stream, use the << operator.)
Implements rospack_tinyxml::TiXmlBase.
Definition at line 772 of file tinyxml.cpp.
| int rospack_tinyxml::TiXmlElement::QueryDoubleAttribute | ( | const char * | name, |
| double * | _value | ||
| ) | const |
QueryDoubleAttribute examines the attribute - see QueryIntAttribute().
Definition at line 664 of file tinyxml.cpp.
| int rospack_tinyxml::TiXmlElement::QueryFloatAttribute | ( | const char * | name, |
| float * | _value | ||
| ) | const [inline] |
QueryFloatAttribute examines the attribute - see QueryIntAttribute().
| int rospack_tinyxml::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 644 of file tinyxml.cpp.
| const char * rospack_tinyxml::TiXmlElement::ReadValue | ( | const char * | in, |
| TiXmlParsingData * | prevData, | ||
| TiXmlEncoding | encoding | ||
| ) | [protected] |
Definition at line 1179 of file tinyxmlparser.cpp.
| void rospack_tinyxml::TiXmlElement::RemoveAttribute | ( | const char * | name | ) |
Deletes an attribute with the given name.
Definition at line 417 of file tinyxml.cpp.
| void rospack_tinyxml::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 718 of file tinyxml.cpp.
| void rospack_tinyxml::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 684 of file tinyxml.cpp.
| void rospack_tinyxml::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 706 of file tinyxml.cpp.
| virtual const TiXmlElement* rospack_tinyxml::TiXmlElement::ToElement | ( | ) | const [inline, virtual] |
Cast to a more defined type. Will return null not of the requested type.
Reimplemented from rospack_tinyxml::TiXmlNode.
| virtual TiXmlElement* rospack_tinyxml::TiXmlElement::ToElement | ( | ) | [inline, virtual] |
Cast to a more defined type. Will return null not of the requested type.
Reimplemented from rospack_tinyxml::TiXmlNode.
Member Data Documentation
The documentation for this class was generated from the following files: