DD4hep - The AIDA detector description toolkit for high energy physics experiments
DD4hep  Rev:Unversioneddirectory
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
TiXmlAttribute Class Reference

TinyXML class. See http://www.grinninglizard.com/tinyxml. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:
TiXmlBase

Public Member Functions

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

Private Member Functions

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

Private Attributes

TiXmlDocumentdocument
 
TIXML_STRING name
 
TIXML_STRING value
 
TiXmlAttributeprev
 
TiXmlAttributenext
 

Friends

class TiXmlAttributeSet
 

Additional Inherited Members

- Public Types inherited from TiXmlBase
enum  {
  TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY,
  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 SetCondenseWhiteSpace (bool condense)
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting. More...
 
- Static Public Attributes inherited from TiXmlBase
static const int utf8ByteTable [256]
 
- Static Protected Member Functions inherited from TiXmlBase
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
 
static bool IsWhiteSpace (char c)
 
static bool IsWhiteSpace (int c)
 
static bool StreamWhiteSpace (std::istream *in, TIXML_STRING *tag)
 
static bool StreamTo (std::istream *in, int character, TIXML_STRING *tag)
 
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 * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
 
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
 
static void PutString (const TIXML_STRING &str, TIXML_STRING *out)
 
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
 
static int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
 
static int ToLower (int v, TiXmlEncoding encoding)
 
static void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
 
- 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

TinyXML class. See http://www.grinninglizard.com/tinyxml.

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.

See

See Also
http://www.grinninglizard.com/tinyxml

Definition at line 877 of file tinyxml.h.

Constructor & Destructor Documentation

TiXmlAttribute::TiXmlAttribute ( )
inline

Construct an empty attribute.

Definition at line 882 of file tinyxml.h.

References document, next, and prev.

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

std::string constructor.

Definition at line 890 of file tinyxml.h.

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

Construct an attribute with a name and value.

Definition at line 899 of file tinyxml.h.

References document, name, next, prev, and value.

TiXmlAttribute::TiXmlAttribute ( const TiXmlAttribute )
private

Member Function Documentation

double TiXmlAttribute::DoubleValue ( ) const

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

Definition at line 1303 of file tinyxml_inl.h.

References value.

int TiXmlAttribute::IntValue ( ) const

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

Definition at line 1298 of file tinyxml_inl.h.

References value.

const char* TiXmlAttribute::Name ( ) const
inline

Return the name of this attribute.

Definition at line 906 of file tinyxml.h.

References name.

Referenced by TiXmlAttributeSet::Add(), DD4hep::XML::Handle_t::checksum(), TiXmlElement::CopyTo(), and TiXmlElement::Parse().

const TIXML_STRING& TiXmlAttribute::NameTStr ( ) const
inline

Definition at line 921 of file tinyxml.h.

References name.

Referenced by TiXmlElement::Parse().

const TiXmlAttribute * TiXmlAttribute::Next ( ) const

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

Definition at line 1196 of file tinyxml_inl.h.

References name, next, and value.

Referenced by DD4hep::XML::Handle_t::checksum(), TiXmlElement::CopyTo(), TiXmlElement::Print(), and TiXmlPrinter::VisitEnter().

TiXmlAttribute* TiXmlAttribute::Next ( )
inline

Definition at line 961 of file tinyxml.h.

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

Definition at line 974 of file tinyxml.h.

References name.

void TiXmlAttribute::operator= ( const TiXmlAttribute base)
private
bool TiXmlAttribute::operator== ( const TiXmlAttribute rhs) const
inline

Definition at line 971 of file tinyxml.h.

References name.

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

Definition at line 977 of file tinyxml.h.

References name.

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

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

Definition at line 1216 of file tinyxml_inl.h.

References name, prev, and value.

TiXmlAttribute* TiXmlAttribute::Previous ( )
inline

Definition at line 967 of file tinyxml.h.

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

Referenced by TiXmlDocument::Print(), and TiXmlPrinter::VisitEnter().

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

Definition at line 1236 of file tinyxml_inl.h.

References TiXmlBase::PutString(), TIXML_STRING, v, and value.

int TiXmlAttribute::QueryDoubleValue ( double *  _value) const

QueryDoubleValue examines the value string. See QueryIntValue().

Definition at line 1269 of file tinyxml_inl.h.

References TIXML_SUCCESS, TIXML_WRONG_TYPE, and value.

Referenced by TiXmlElement::QueryDoubleAttribute().

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 1262 of file tinyxml_inl.h.

References TIXML_SUCCESS, TIXML_WRONG_TYPE, and value.

Referenced by TiXmlElement::QueryIntAttribute().

void TiXmlAttribute::SetDocument ( TiXmlDocument doc)
inline

Definition at line 994 of file tinyxml.h.

References document.

Referenced by TiXmlElement::Parse().

void TiXmlAttribute::SetDoubleValue ( double  _value)

Set the value from a double.

Definition at line 1287 of file tinyxml_inl.h.

References SetValue().

void TiXmlAttribute::SetIntValue ( int  _value)

Set the value from an integer.

Definition at line 1276 of file tinyxml_inl.h.

References SetValue().

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

Set the name of this attribute.

Definition at line 938 of file tinyxml.h.

References name.

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

STL std::string form.

Definition at line 950 of file tinyxml.h.

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

Set the value.

Definition at line 941 of file tinyxml.h.

References value.

Referenced by TiXmlElement::Parse(), TiXmlElement::SetAttribute(), SetDoubleValue(), and SetIntValue().

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

STL std::string form.

Definition at line 954 of file tinyxml.h.

References value.

const char* TiXmlAttribute::Value ( ) const
inline

Return the value of this attribute.

Definition at line 909 of file tinyxml.h.

References value.

Referenced by TiXmlElement::Attribute(), DD4hep::XML::Handle_t::checksum(), TiXmlElement::CopyTo(), TiXmlElement::Parse(), and TiXmlDeclaration::Parse().

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

Return the value of this attribute.

Definition at line 913 of file tinyxml.h.

References value.

Referenced by TiXmlElement::QueryValueAttribute().

Friends And Related Function Documentation

friend class TiXmlAttributeSet
friend

Definition at line 878 of file tinyxml.h.

Member Data Documentation

TiXmlDocument* TiXmlAttribute::document
private

Definition at line 1002 of file tinyxml.h.

Referenced by SetDocument(), and TiXmlAttribute().

TIXML_STRING TiXmlAttribute::name
private
TiXmlAttribute* TiXmlAttribute::next
private
TiXmlAttribute* TiXmlAttribute::prev
private
TIXML_STRING TiXmlAttribute::value
private

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