Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
TiXmlAttribute Class Reference
An attribute is a name-value pair. More...
#include <tinyxml.h>
Inherits TiXmlBase.
Public Member Functions | |
| TiXmlAttribute () | |
| Construct an empty attribute. | |
| TiXmlAttribute (const std::string &_name, const std::string &_value) | |
| std::string constructor. | |
| TiXmlAttribute (const char *_name, const char *_value) | |
| Construct an attribute with a name and value. | |
| const char * | Name () const |
| Return the name of this attribute. | |
| const char * | Value () const |
| Return the value of this attribute. | |
| const std::string & | ValueStr () const |
| Return the value of this attribute. | |
| int | IntValue () const |
| Return the value of this attribute, converted to an integer. | |
| double | DoubleValue () const |
| Return the value of this attribute, converted to a double. | |
| int | QueryIntValue (int *_value) const |
| QueryIntValue examines the value string. | |
| int | QueryDoubleValue (double *_value) const |
| QueryDoubleValue examines the value string. See QueryIntValue(). | |
| void | SetName (const char *_name) |
| Set the name of this attribute. | |
| void | SetValue (const char *_value) |
| Set the value. | |
| void | SetIntValue (int _value) |
| Set the value from an integer. | |
| void | SetDoubleValue (double _value) |
| Set the value from a double. | |
| void | SetName (const std::string &_name) |
| STL std::string form. | |
| void | SetValue (const std::string &_value) |
| STL std::string form. | |
| const TiXmlAttribute * | Next () const |
| Get the next sibling attribute in the DOM. Returns null at end. | |
| const TiXmlAttribute * | Previous () const |
| Get the previous sibling attribute in the DOM. Returns null at beginning. | |
| virtual void | Print (FILE *cfile, int depth) const |
| 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. | |
| int | Row () const |
| Return the position, in the original source file, of this node or attribute. | |
| int | Column () const |
| See Row() | |
| void | SetUserData (void *user) |
| Set a pointer to arbitrary user data. | |
| void * | GetUserData () |
| Get a pointer to arbitrary user data. | |
| const void * | GetUserData () const |
| Get a pointer to arbitrary user data. | |
Static Public Member Functions | |
| static void | SetCondenseWhiteSpace (bool condense) |
| The world does not agree on whether white space should be kept or not. | |
| static bool | IsWhiteSpaceCondensed () |
| Return the current white space setting. | |
| static void | EncodeString (const TIXML_STRING &str, TIXML_STRING *out) |
| Expands entities in a string. | |
Protected Attributes | |
| void * | userData |
| Field containing a generic user pointer. | |
Detailed Description
An attribute is a name-value pair.
Elements have an arbitrary number of attributes, each with a unique name.
- Note:
- The attributes are not TiXmlNodes, since they are not part of the tinyXML document object model. There are other suggested ways to look at this problem.
Definition at line 779 of file tinyxml.h.
Constructor & Destructor Documentation
| TiXmlAttribute | ( | ) |
| TiXmlAttribute | ( | const std::string & | _name, |
| const std::string & | _value | ||
| ) |
| TiXmlAttribute | ( | const char * | _name, |
| const char * | _value | ||
| ) |
Member Function Documentation
| double DoubleValue | ( | ) | const |
Return the value of this attribute, converted to a double.
Definition at line 1232 of file tinyxml.cpp.
| void EncodeString | ( | const TIXML_STRING & | str, |
| TIXML_STRING * | out | ||
| ) | [static, inherited] |
Expands entities in a string.
Note this should not contian the tag's '<', '>', etc, or they will be transformed into entities!
Definition at line 52 of file tinyxml.cpp.
| const void* GetUserData | ( | ) | const [inherited] |
| void* GetUserData | ( | ) | [inherited] |
| int IntValue | ( | ) | const |
Return the value of this attribute, converted to an integer.
Definition at line 1227 of file tinyxml.cpp.
| static bool IsWhiteSpaceCondensed | ( | ) | [static, inherited] |
| const char* Name | ( | ) | const |
| const TiXmlAttribute * Next | ( | ) | const |
Get the next sibling attribute in the DOM. Returns null at end.
Definition at line 1125 of file tinyxml.cpp.
| const TiXmlAttribute * Previous | ( | ) | const |
Get the previous sibling attribute in the DOM. Returns null at beginning.
Definition at line 1145 of file tinyxml.cpp.
| virtual void 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 TiXmlBase.
| int QueryDoubleValue | ( | double * | _value ) | const |
QueryDoubleValue examines the value string. See QueryIntValue().
Definition at line 1198 of file tinyxml.cpp.
| int QueryIntValue | ( | int * | _value ) | const |
QueryIntValue examines the value string.
It is an alternative to the IntValue() method with richer error checking. If the value 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.
A specialized but useful call. Note that for success it returns 0, which is the opposite of almost all other TinyXml calls.
Definition at line 1191 of file tinyxml.cpp.
| int Row | ( | ) | const [inherited] |
Return the position, in the original source file, of this node or attribute.
The row and column are 1-based. (That is the first row and first column is 1,1). If the returns values are 0 or less, then the parser does not have a row and column value.
Generally, the row and column value will be set when the TiXmlDocument::Load(), TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator>>.
The values reflect the initial load. Once the DOM is modified programmatically (by adding or changing nodes and attributes) the new values will NOT update to reflect changes in the document.
There is a minor performance cost to computing the row and column. Computation can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.
- See also:
- TiXmlDocument::SetTabSize()
| static void SetCondenseWhiteSpace | ( | bool | condense ) | [static, inherited] |
The world does not agree on whether white space should be kept or not.
In order to make everyone happy, these global, static functions are provided to set whether or not TinyXml will condense all white space into a single space or not. The default is to condense. Note changing this value is not thread safe.
| void SetDoubleValue | ( | double | _value ) |
Set the value from a double.
Definition at line 1216 of file tinyxml.cpp.
| void SetIntValue | ( | int | _value ) |
Set the value from an integer.
Definition at line 1205 of file tinyxml.cpp.
| void SetName | ( | const char * | _name ) |
| void SetName | ( | const std::string & | _name ) |
| void SetUserData | ( | void * | user ) | [inherited] |
| void SetValue | ( | const std::string & | _value ) |
| const char* Value | ( | ) | const |
| const std::string& ValueStr | ( | ) | const |
Field Documentation
Generated on Tue Jul 12 2022 11:28:38 by
1.7.2