xml_attribute< Ch > Class Template Reference

Class representing attribute node of XML document. More...

#include <ArmarXCore/core/rapidxml/rapidxml.hpp>

+ Inheritance diagram for xml_attribute< Ch >:

Public Member Functions

xml_document< Ch > * document () const
 Gets document of which attribute is a child.
 
xml_attribute< Ch > * next_attribute (const Ch *name=nullptr, std::size_t name_size=0, bool case_sensitive=true) const
 Gets next attribute, optionally matching attribute name.
 
xml_attribute< Ch > * previous_attribute (const Ch *name=0, std::size_t name_size=0, bool case_sensitive=true) const
 Gets previous attribute, optionally matching attribute name.
 
 xml_attribute ()
 Constructs an empty attribute with the specified type.
 
- Public Member Functions inherited from xml_base< char >
char * name () const
 Gets name of the node.
 
void name (const char *name)
 Sets name of node to a zero-terminated string.
 
void name (const char *name, std::size_t size)
 Sets name of node to a non zero-terminated string.
 
std::size_t name_size () const
 Gets size of node name, not including terminator character.
 
xml_node< char > * parent () const
 Gets node parent.
 
char * value () const
 Gets value of node.
 
void value (const char *value)
 Sets value of node to a zero-terminated string.
 
void value (const char *value, std::size_t size)
 Sets value of node to a non zero-terminated string.
 
std::size_t value_size () const
 Gets size of node value, not including terminator character.
 
 xml_base ()
 

Friends

class xml_node< Ch >
 

Additional Inherited Members

- Static Protected Member Functions inherited from xml_base< char >
static char * nullstr ()
 
- Protected Attributes inherited from xml_base< char >
char * m_name
 
std::size_t m_name_size
 
xml_node< char > * m_parent
 
char * m_value
 
std::size_t m_value_size
 

Detailed Description

template<class Ch = char>
class rapidxml::xml_attribute< Ch >

Class representing attribute node of XML document.

Each attribute has name and value strings, which are available through name() and value() functions (inherited from xml_base). Note that after parse, both name and value of attribute will point to interior of source text used for parsing. Thus, this text must persist in memory for the lifetime of attribute.

Parameters
ChCharacter type to use.

Definition at line 906 of file rapidxml.hpp.

Constructor & Destructor Documentation

◆ xml_attribute()

template<class Ch = char>
xml_attribute ( )
inline

Constructs an empty attribute with the specified type.

Consider using memory_pool of appropriate xml_document if allocating attributes manually.

Definition at line 917 of file rapidxml.hpp.

+ Here is the caller graph for this function:

Member Function Documentation

◆ document()

template<class Ch = char>
xml_document< Ch > * document ( ) const
inline

Gets document of which attribute is a child.

Returns
Pointer to document that contains this attribute, or 0 if there is no parent document.

Definition at line 927 of file rapidxml.hpp.

+ Here is the call graph for this function:

◆ next_attribute()

template<class Ch = char>
xml_attribute< Ch > * next_attribute ( const Ch * name = nullptr,
std::size_t name_size = 0,
bool case_sensitive = true ) const
inline

Gets next attribute, optionally matching attribute name.

Parameters
nameName of attribute to find, or 0 to return next attribute regardless of its name; this string doesn't have to be zero-terminated if name_size is non-zero
name_sizeSize of name, in characters, or 0 to have size calculated automatically from string
case_sensitiveShould name comparison be case-sensitive; non case-sensitive comparison works properly only for ASCII characters
Returns
Pointer to found attribute, or 0 if not found.

Definition at line 986 of file rapidxml.hpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ previous_attribute()

template<class Ch = char>
xml_attribute< Ch > * previous_attribute ( const Ch * name = 0,
std::size_t name_size = 0,
bool case_sensitive = true ) const
inline

Gets previous attribute, optionally matching attribute name.

Parameters
nameName of attribute to find, or 0 to return previous attribute regardless of its name; this string doesn't have to be zero-terminated if name_size is non-zero
name_sizeSize of name, in characters, or 0 to have size calculated automatically from string
case_sensitiveShould name comparison be case-sensitive; non case-sensitive comparison works properly only for ASCII characters
Returns
Pointer to found attribute, or 0 if not found.

Definition at line 950 of file rapidxml.hpp.

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ xml_node< Ch >

template<class Ch = char>
friend class xml_node< Ch >
friend

Definition at line 897 of file rapidxml.hpp.


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