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 TIXML_STRINGNameTStr () const
 
TiXmlAttributeNext ()
 
const TiXmlAttributeNext () const
 Get the next sibling attribute in the DOM. Returns null at end. More...
 
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)
 
TiXmlAttributePrevious ()
 
const TiXmlAttributePrevious () const
 Get the previous sibling attribute in the DOM. Returns null at beginning. More...
 
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...
 
 TiXmlAttribute ()
 Construct an empty attribute. More...
 
 TiXmlAttribute (const char *_name, const char *_value)
 Construct an attribute with a name and value. More...
 
- Public Member Functions inherited from TiXmlBase
int Row () const
 
 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 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 883 of file tinyxml.h.

Constructor & Destructor Documentation

◆ TiXmlAttribute() [1/3]

TiXmlAttribute::TiXmlAttribute ( )
inline

Construct an empty attribute.

Definition at line 889 of file tinyxml.h.

◆ TiXmlAttribute() [2/3]

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

Construct an attribute with a name and value.

Definition at line 907 of file tinyxml.h.

◆ TiXmlAttribute() [3/3]

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 1277 of file tinyxml.cpp.

◆ IntValue()

int TiXmlAttribute::IntValue ( ) const

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

Definition at line 1272 of file tinyxml.cpp.

◆ NameTStr()

const TIXML_STRING& TiXmlAttribute::NameTStr ( ) const
inline

Definition at line 927 of file tinyxml.h.

◆ Next() [1/2]

TiXmlAttribute* TiXmlAttribute::Next ( )
inline

Definition at line 962 of file tinyxml.h.

◆ Next() [2/2]

const TiXmlAttribute * TiXmlAttribute::Next ( ) const

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

Definition at line 1170 of file tinyxml.cpp.

◆ operator<()

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

Definition at line 978 of file tinyxml.h.

◆ operator=()

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

◆ operator==()

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

Definition at line 975 of file tinyxml.h.

◆ operator>()

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

Definition at line 981 of file tinyxml.h.

◆ Parse()

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

Implements TiXmlBase.

Definition at line 1392 of file tinyxmlparser.cpp.

◆ Previous() [1/2]

TiXmlAttribute* TiXmlAttribute::Previous ( )
inline

Definition at line 970 of file tinyxml.h.

◆ Previous() [2/2]

const TiXmlAttribute * TiXmlAttribute::Previous ( ) const

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

Definition at line 1190 of file tinyxml.cpp.

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

◆ Print() [2/2]

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

Definition at line 1210 of file tinyxml.cpp.

◆ QueryDoubleValue()

int TiXmlAttribute::QueryDoubleValue ( double *  _value) const

QueryDoubleValue examines the value string. See QueryIntValue().

Definition at line 1243 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 1236 of file tinyxml.cpp.

◆ SetDocument()

void TiXmlAttribute::SetDocument ( TiXmlDocument doc)
inline

Definition at line 999 of file tinyxml.h.

◆ SetDoubleValue()

void TiXmlAttribute::SetDoubleValue ( double  _value)

Set the value from a double.

Definition at line 1261 of file tinyxml.cpp.

◆ SetIntValue()

void TiXmlAttribute::SetIntValue ( int  _value)

Set the value from an integer.

Definition at line 1250 of file tinyxml.cpp.

Friends And Related Function Documentation

◆ TiXmlAttributeSet

friend class TiXmlAttributeSet
friend

Definition at line 885 of file tinyxml.h.

Member Data Documentation

◆ document

TiXmlDocument* TiXmlAttribute::document
private

Definition at line 1006 of file tinyxml.h.

◆ name

TIXML_STRING TiXmlAttribute::name
private

Definition at line 1007 of file tinyxml.h.

◆ next

TiXmlAttribute* TiXmlAttribute::next
private

Definition at line 1010 of file tinyxml.h.

◆ prev

TiXmlAttribute* TiXmlAttribute::prev
private

Definition at line 1009 of file tinyxml.h.

◆ value

TIXML_STRING TiXmlAttribute::value
private

Definition at line 1008 of file tinyxml.h.


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


sick_scan
Author(s): Michael Lehning , Jochen Sprickerhof , Martin Günther
autogenerated on Thu Sep 8 2022 02:30:19