Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
TiXmlAttribute Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:
Inheritance graph
[legend]

Public Member Functions

double DoubleValue () const
 Return the value of this attribute, converted to a double. More...
 
int IntValue () const
 Return the value of this attribute, converted to an integer. More...
 
const char * Name () const
 Return the name of this attribute. More...
 
const TIXML_STRINGNameTStr () const
 
const TiXmlAttributeNext () const
 Get the next sibling attribute in the DOM. Returns null at end. More...
 
TiXmlAttributeNext ()
 
bool operator< (const TiXmlAttribute &rhs) const
 
bool operator== (const TiXmlAttribute &rhs) const
 
bool operator> (const TiXmlAttribute &rhs) const
 
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
 
const TiXmlAttributePrevious () const
 Get the previous sibling attribute in the DOM. Returns null at beginning. More...
 
TiXmlAttributePrevious ()
 
virtual void Print (FILE *cfile, int depth) const
 
void Print (FILE *cfile, int depth, TIXML_STRING *str) const
 
int QueryDoubleValue (double *_value) const
 QueryDoubleValue examines the value string. See QueryIntValue(). More...
 
int QueryIntValue (int *_value) const
 
void SetDocument (TiXmlDocument *doc)
 
void SetDoubleValue (double _value)
 Set the value from a double. More...
 
void SetIntValue (int _value)
 Set the value from an integer. More...
 
void SetName (const char *_name)
 Set the name of this attribute. More...
 
void SetName (const std::string &_name)
 STL std::string form. More...
 
void SetValue (const char *_value)
 Set the value. More...
 
void SetValue (const std::string &_value)
 STL std::string form. More...
 
 TiXmlAttribute ()
 Construct an empty attribute. More...
 
 TiXmlAttribute (const std::string &_name, const std::string &_value)
 std::string constructor. More...
 
 TiXmlAttribute (const char *_name, const char *_value)
 Construct an attribute with a name and value. More...
 
const char * Value () const
 Return the value of this attribute. More...
 
const std::string & ValueStr () const
 Return the value of this attribute. More...
 
- Public Member Functions inherited from TiXmlBase
int Column () const
 See Row() More...
 
void * GetUserData ()
 Get a pointer to arbitrary user data. More...
 
const void * GetUserData () const
 Get a pointer to arbitrary user data. More...
 
int Row () const
 
void SetUserData (void *user)
 Set a pointer to arbitrary user data. More...
 
 TiXmlBase ()
 
virtual ~TiXmlBase ()
 

Private Member Functions

void operator= (const TiXmlAttribute &base)
 
 TiXmlAttribute (const TiXmlAttribute &)
 

Private Attributes

TiXmlDocumentdocument
 
TIXML_STRING name
 
TiXmlAttributenext
 
TiXmlAttributeprev
 
TIXML_STRING value
 

Friends

class TiXmlAttributeSet
 

Additional Inherited Members

- Public Types inherited from TiXmlBase
enum  {
  TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_PARSING_ELEMENT,
  TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES, TIXML_ERROR_PARSING_EMPTY,
  TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT, TIXML_ERROR_PARSING_DECLARATION,
  TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_PARSING_CDATA, TIXML_ERROR_DOCUMENT_TOP_ONLY,
  TIXML_ERROR_STRING_COUNT
}
 
- Static Public Member Functions inherited from TiXmlBase
static void EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting. More...
 
static void SetCondenseWhiteSpace (bool condense)
 
- Static Public Attributes inherited from TiXmlBase
static const int utf8ByteTable [256]
 
- Static Protected Member Functions inherited from TiXmlBase
static void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
 
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
 
static const char * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
 
static int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
 
static int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
 
static bool IsWhiteSpace (char c)
 
static bool IsWhiteSpace (int c)
 
static const char * ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding)
 
static const char * ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
 
static bool StreamTo (std::istream *in, int character, TIXML_STRING *tag)
 
static bool StreamWhiteSpace (std::istream *in, TIXML_STRING *tag)
 
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static int ToLower (int v, TiXmlEncoding encoding)
 
- Protected Attributes inherited from TiXmlBase
TiXmlCursor location
 
void * userData
 Field containing a generic user pointer. More...
 
- Static Protected Attributes inherited from TiXmlBase
static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

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 785 of file tinyxml.h.

Constructor & Destructor Documentation

◆ TiXmlAttribute() [1/4]

TiXmlAttribute::TiXmlAttribute ( )
inline

Construct an empty attribute.

Definition at line 791 of file tinyxml.h.

◆ TiXmlAttribute() [2/4]

TiXmlAttribute::TiXmlAttribute ( const std::string &  _name,
const std::string &  _value 
)
inline

std::string constructor.

Definition at line 799 of file tinyxml.h.

◆ TiXmlAttribute() [3/4]

TiXmlAttribute::TiXmlAttribute ( const char *  _name,
const char *  _value 
)
inline

Construct an attribute with a name and value.

Definition at line 809 of file tinyxml.h.

◆ TiXmlAttribute() [4/4]

TiXmlAttribute::TiXmlAttribute ( const TiXmlAttribute )
private

Member Function Documentation

◆ DoubleValue()

double TiXmlAttribute::DoubleValue ( ) const

Return the value of this attribute, converted to a double.

Definition at line 1265 of file tinyxml.cpp.

◆ IntValue()

int TiXmlAttribute::IntValue ( ) const

Return the value of this attribute, converted to an integer.

Definition at line 1260 of file tinyxml.cpp.

◆ Name()

const char* TiXmlAttribute::Name ( ) const
inline

Return the name of this attribute.

Definition at line 817 of file tinyxml.h.

◆ NameTStr()

const TIXML_STRING& TiXmlAttribute::NameTStr ( ) const
inline

Definition at line 826 of file tinyxml.h.

◆ Next() [1/2]

const TiXmlAttribute * TiXmlAttribute::Next ( ) const

Get the next sibling attribute in the DOM. Returns null at end.

Definition at line 1166 of file tinyxml.cpp.

◆ Next() [2/2]

TiXmlAttribute* TiXmlAttribute::Next ( )
inline

Definition at line 856 of file tinyxml.h.

◆ operator<()

bool TiXmlAttribute::operator< ( const TiXmlAttribute rhs) const
inline

Definition at line 867 of file tinyxml.h.

◆ operator=()

void TiXmlAttribute::operator= ( const TiXmlAttribute base)
private

◆ operator==()

bool TiXmlAttribute::operator== ( const TiXmlAttribute rhs) const
inline

Definition at line 866 of file tinyxml.h.

◆ operator>()

bool TiXmlAttribute::operator> ( const TiXmlAttribute rhs) const
inline

Definition at line 868 of file tinyxml.h.

◆ Parse()

const char * TiXmlAttribute::Parse ( const char *  p,
TiXmlParsingData data,
TiXmlEncoding  encoding 
)
virtual

Implements TiXmlBase.

Definition at line 1390 of file tinyxmlparser.cpp.

◆ Previous() [1/2]

const TiXmlAttribute * TiXmlAttribute::Previous ( ) const

Get the previous sibling attribute in the DOM. Returns null at beginning.

Definition at line 1186 of file tinyxml.cpp.

◆ Previous() [2/2]

TiXmlAttribute* TiXmlAttribute::Previous ( )
inline

Definition at line 862 of file tinyxml.h.

◆ Print() [1/2]

virtual void TiXmlAttribute::Print ( FILE *  cfile,
int  depth 
) const
inlinevirtual

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.

Definition at line 876 of file tinyxml.h.

◆ Print() [2/2]

void TiXmlAttribute::Print ( FILE *  cfile,
int  depth,
TIXML_STRING str 
) const

Definition at line 1206 of file tinyxml.cpp.

◆ QueryDoubleValue()

int TiXmlAttribute::QueryDoubleValue ( double *  _value) const

QueryDoubleValue examines the value string. See QueryIntValue().

Definition at line 1239 of file tinyxml.cpp.

◆ QueryIntValue()

int TiXmlAttribute::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 1232 of file tinyxml.cpp.

◆ SetDocument()

void TiXmlAttribute::SetDocument ( TiXmlDocument doc)
inline

Definition at line 883 of file tinyxml.h.

◆ SetDoubleValue()

void TiXmlAttribute::SetDoubleValue ( double  _value)

Set the value from a double.

Definition at line 1253 of file tinyxml.cpp.

◆ SetIntValue()

void TiXmlAttribute::SetIntValue ( int  _value)

Set the value from an integer.

Definition at line 1246 of file tinyxml.cpp.

◆ SetName() [1/2]

void TiXmlAttribute::SetName ( const char *  _name)
inline

Set the name of this attribute.

Definition at line 841 of file tinyxml.h.

◆ SetName() [2/2]

void TiXmlAttribute::SetName ( const std::string &  _name)
inline

STL std::string form.

Definition at line 849 of file tinyxml.h.

◆ SetValue() [1/2]

void TiXmlAttribute::SetValue ( const char *  _value)
inline

Set the value.

Definition at line 842 of file tinyxml.h.

◆ SetValue() [2/2]

void TiXmlAttribute::SetValue ( const std::string &  _value)
inline

STL std::string form.

Definition at line 851 of file tinyxml.h.

◆ Value()

const char* TiXmlAttribute::Value ( ) const
inline

Return the value of this attribute.

Definition at line 818 of file tinyxml.h.

◆ ValueStr()

const std::string& TiXmlAttribute::ValueStr ( ) const
inline

Return the value of this attribute.

Definition at line 820 of file tinyxml.h.

Friends And Related Function Documentation

◆ TiXmlAttributeSet

friend class TiXmlAttributeSet
friend

Definition at line 787 of file tinyxml.h.

Member Data Documentation

◆ document

TiXmlDocument* TiXmlAttribute::document
private

Definition at line 889 of file tinyxml.h.

◆ name

TIXML_STRING TiXmlAttribute::name
private

Definition at line 890 of file tinyxml.h.

◆ next

TiXmlAttribute* TiXmlAttribute::next
private

Definition at line 893 of file tinyxml.h.

◆ prev

TiXmlAttribute* TiXmlAttribute::prev
private

Definition at line 892 of file tinyxml.h.

◆ value

TIXML_STRING TiXmlAttribute::value
private

Definition at line 891 of file tinyxml.h.


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


inertial_sense_ros
Author(s):
autogenerated on Sun Feb 28 2021 03:18:03