DigitalSpaces::DIXMLElement1 Struct Reference
[XML]

#include <ContainerInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Inherited by TiXmlElement.


Detailed Description

Additional functionality that is supported by an XML Element.

An XML element is the most common type of XML object, which can have attributes as well as contain other objects.

See also:
DIXMLNode1

Public Member Functions

const char * GetAttribute (const char *name)
 Given an attribute name, Attribute( DNoParams ) returns the value for the attribute of that name, or null if none exists.
const char * GetAttribute (const char *name, int *i)
 Given an attribute name, Attribute( DNoParams ) returns the value for the attribute of that name, or null if none exists.
const char * GetAttribute (const char *name, double *d)
 Given an attribute name, Attribute( DNoParams ) returns the value for the attribute of that name, or null if none exists.
int DoQueryIntAttribute (const char *name, int *value)
 QueryIntAttribute examines the attribute - it is an alternative to the Attribute( DNoParams ) method with richer error checking.
int DoQueryDoubleAttribute (const char *name, double *value)
 QueryDoubleAttribute examines the attribute - see QueryIntAttribute( DNoParams ).
void SetAttribute (const char *name, const char *value)
 Sets an attribute of name to a given value.
void SetAttribute (const char *name, int value)
 Sets an attribute of name to a given value.
void SetDoubleAttribute (const char *name, double value)
 Sets an attribute of name to a given value.
void RemoveAttribute (const char *name)
 Deletes an attribute with the given name.

Member Function Documentation

const char* DigitalSpaces::DIXMLElement1::GetAttribute ( const char *  name  ) 

Given an attribute name, Attribute( DNoParams ) returns the value for the attribute of that name, or null if none exists.

Reimplemented in TiXmlElement.

const char* DigitalSpaces::DIXMLElement1::GetAttribute ( const char *  name,
int *  i 
)

Given an attribute name, Attribute( DNoParams ) 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.

Reimplemented in TiXmlElement.

const char* DigitalSpaces::DIXMLElement1::GetAttribute ( const char *  name,
double *  d 
)

Given an attribute name, Attribute( DNoParams ) 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.

Reimplemented in TiXmlElement.

int DigitalSpaces::DIXMLElement1::DoQueryIntAttribute ( const char *  name,
int *  value 
)

QueryIntAttribute examines the attribute - it is an alternative to the Attribute( DNoParams ) 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.

Reimplemented in TiXmlElement.

int DigitalSpaces::DIXMLElement1::DoQueryDoubleAttribute ( const char *  name,
double *  value 
)

QueryDoubleAttribute examines the attribute - see QueryIntAttribute( DNoParams ).

Reimplemented in TiXmlElement.

void DigitalSpaces::DIXMLElement1::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.

Reimplemented in TiXmlElement.

void DigitalSpaces::DIXMLElement1::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.

Reimplemented in TiXmlElement.

void DigitalSpaces::DIXMLElement1::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.

Reimplemented in TiXmlElement.

void DigitalSpaces::DIXMLElement1::RemoveAttribute ( const char *  name  ) 

Deletes an attribute with the given name.

Reimplemented in TiXmlElement.


The documentation for this struct was generated from the following file:

Generated on Sun Aug 31 17:46:28 2008 for Digital Spaces by  doxygen 1.5.6