xml_node< Ch > Class Template Reference

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

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

Inheritance diagram for xml_node< Ch >:

Public Member Functions
void	append_attribute (xml_attribute< Ch > *attribute)
	Appends a new attribute to the node.
void	append_node (xml_node< Ch > *child)
	Appends a new child node.
xml_document< Ch > *	document () const
	Gets document of which node is a child.
xml_attribute< Ch > *	first_attribute (const Ch *name=nullptr, std::size_t name_size=0, bool case_sensitive=true) const
	Gets first attribute of node, optionally matching attribute name.
xml_node< Ch > *	first_node (const Ch *name=nullptr, std::size_t name_size=0, bool case_sensitive=true) const
	Gets first child node, optionally matching node name.
void	insert_attribute (xml_attribute< Ch > *where, xml_attribute< Ch > *attribute)
	Inserts a new attribute at specified place inside the node.
void	insert_node (xml_node< Ch > *where, xml_node< Ch > *child)
	Inserts a new child node at specified place inside the node.
xml_attribute< Ch > *	last_attribute (const Ch *name=0, std::size_t name_size=0, bool case_sensitive=true) const
	Gets last attribute of node, optionally matching attribute name.
xml_node< Ch > *	last_node (const Ch *name=0, std::size_t name_size=0, bool case_sensitive=true) const
	Gets last child node, optionally matching node name.
xml_node< Ch > *	next_sibling (const Ch *name=nullptr, std::size_t name_size=0, bool case_sensitive=true) const
	Gets next sibling node, optionally matching node name.
void	prepend_attribute (xml_attribute< Ch > *attribute)
	Prepends a new attribute to the node.
void	prepend_node (xml_node< Ch > *child)
	Prepends a new child node.
xml_node< Ch > *	previous_sibling (const Ch *name=0, std::size_t name_size=0, bool case_sensitive=true) const
	Gets previous sibling node, optionally matching node name.
void	remove_all_attributes ()
	Removes all attributes of node.
void	remove_all_nodes ()
	Removes all child nodes (but not attributes).
void	remove_attribute (xml_attribute< Ch > *where)
	Removes specified attribute from node.
void	remove_first_attribute ()
	Removes first attribute of the node.
void	remove_first_node ()
	Removes first child node.
void	remove_last_attribute ()
	Removes last attribute of the node.
void	remove_last_node ()
	Removes last child of the node.
void	remove_node (xml_node< Ch > *where)
	Removes specified child from the node.
node_type	type () const
	Gets type of node.
void	type (node_type type)
	Sets type of node.
	xml_node (node_type type)
	Constructs an empty node 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 ()

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_node< Ch >

Class representing a node of XML document.

Each node may have associated name and value strings, which are available through name() and value() functions. Interpretation of name and value depends on type of the node. Type of node can be determined by using type() function.

Note that after parse, both name and value of node, if any, will point interior of source text used for parsing. Thus, this text must persist in the memory for the lifetime of node.

Parameters

Ch	Character type to use.

Definition at line 1035 of file rapidxml.hpp.

Constructor & Destructor Documentation

xml_node()

template<class Ch = char>

xml_node ( node_type type )

inline

Constructs an empty node with the specified type.

Consider using memory_pool of appropriate document to allocate nodes manually.

Parameters

type	Type of node to construct.

Definition at line 1045 of file rapidxml.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

append_attribute()

template<class Ch = char>

void append_attribute ( xml_attribute< Ch > * attribute )

inline

Appends a new attribute to the node.

Parameters

attribute

Attribute to append.

Definition at line 1486 of file rapidxml.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

append_node()

template<class Ch = char>

void append_node ( xml_node< Ch > * child )

inline

Appends a new child node.

The appended child becomes the last child.

Parameters

child

Node to append.

Definition at line 1332 of file rapidxml.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

document()

template<class Ch = char>

xml_document< Ch > * document ( ) const

inline

Gets document of which node is a child.

Returns

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

Definition at line 1066 of file rapidxml.hpp.

Here is the call graph for this function:

first_attribute()

template<class Ch = char>

xml_attribute< Ch > * first_attribute ( const Ch * name = nullptr, std::size_t name_size = 0, bool case_sensitive = true ) const

inline

Gets first attribute of node, optionally matching attribute name.

Parameters

name	Name of attribute to find, or 0 to return first attribute regardless of its name; this string doesn't have to be zero-terminated if name_size is non-zero
name_size	Size of name, in characters, or 0 to have size calculated automatically from string
case_sensitive	Should 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 1224 of file rapidxml.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

first_node()

template<class Ch = char>

xml_node< Ch > * first_node ( const Ch * name = nullptr, std::size_t name_size = 0, bool case_sensitive = true ) const

inline

Gets first child node, optionally matching node name.

Parameters

name	Name of child to find, or 0 to return first child regardless of its name; this string doesn't have to be zero-terminated if name_size is non-zero
name_size	Size of name, in characters, or 0 to have size calculated automatically from string
case_sensitive	Should name comparison be case-sensitive; non case-sensitive comparison works properly only for ASCII characters

Returns

Pointer to found child, or 0 if not found.

Definition at line 1084 of file rapidxml.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

insert_attribute()

template<class Ch = char>

void insert_attribute ( xml_attribute< Ch > * where, xml_attribute< Ch > * attribute )

inline

Inserts a new attribute at specified place inside the node.

All attributes after and including the specified attribute are moved one position back.

Parameters

where	Place where to insert the attribute, or 0 to insert at the back.
attribute	Attribute to insert.

Definition at line 1511 of file rapidxml.hpp.

Here is the call graph for this function:

insert_node()

template<class Ch = char>

void insert_node ( xml_node< Ch > * where, xml_node< Ch > * child )

inline

Inserts a new child node at specified place inside the node.

All children after and including the specified node are moved one position back.

Parameters

where	Place where to insert the child, or 0 to insert at the back.
child	Node to insert.

Definition at line 1357 of file rapidxml.hpp.

Here is the call graph for this function:

last_attribute()

template<class Ch = char>

xml_attribute< Ch > * last_attribute ( const Ch * name = 0, std::size_t name_size = 0, bool case_sensitive = true ) const

inline

Gets last attribute of node, optionally matching attribute name.

Parameters

name	Name of attribute to find, or 0 to return last attribute regardless of its name; this string doesn't have to be zero-terminated if name_size is non-zero
name_size	Size of name, in characters, or 0 to have size calculated automatically from string
case_sensitive	Should 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 1260 of file rapidxml.hpp.

Here is the call graph for this function:

last_node()

template<class Ch = char>

xml_node< Ch > * last_node ( const Ch * name = 0, std::size_t name_size = 0, bool case_sensitive = true ) const

inline

Gets last child node, optionally matching node name.

Behaviour is undefined if node has no children. Use first_node() to test if node has children.

Parameters

name	Name of child to find, or 0 to return last child regardless of its name; this string doesn't have to be zero-terminated if name_size is non-zero
name_size	Size of name, in characters, or 0 to have size calculated automatically from string
case_sensitive	Should name comparison be case-sensitive; non case-sensitive comparison works properly only for ASCII characters

Returns

Pointer to found child, or 0 if not found.

Definition at line 1118 of file rapidxml.hpp.

Here is the call graph for this function:

next_sibling()

template<class Ch = char>

xml_node< Ch > * next_sibling ( const Ch * name = nullptr, std::size_t name_size = 0, bool case_sensitive = true ) const

inline

Gets next sibling node, optionally matching node name.

Behaviour is undefined if node has no parent. Use parent() to test if node has a parent.

Parameters

name	Name of sibling to find, or 0 to return next sibling regardless of its name; this string doesn't have to be zero-terminated if name_size is non-zero
name_size	Size of name, in characters, or 0 to have size calculated automatically from string
case_sensitive	Should name comparison be case-sensitive; non case-sensitive comparison works properly only for ASCII characters

Returns

Pointer to found sibling, or 0 if not found.

Definition at line 1189 of file rapidxml.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

prepend_attribute()

template<class Ch = char>

void prepend_attribute ( xml_attribute< Ch > * attribute )

inline

Prepends a new attribute to the node.

Parameters

attribute

Attribute to prepend.

Definition at line 1463 of file rapidxml.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

prepend_node()

template<class Ch = char>

void prepend_node ( xml_node< Ch > * child )

inline

Prepends a new child node.

The prepended child becomes the first child, and all existing children are moved one position back.

Parameters

child

Node to prepend.

Definition at line 1308 of file rapidxml.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

previous_sibling()

template<class Ch = char>

xml_node< Ch > * previous_sibling ( const Ch * name = 0, std::size_t name_size = 0, bool case_sensitive = true ) const

inline

Gets previous sibling node, optionally matching node name.

Behaviour is undefined if node has no parent. Use parent() to test if node has a parent.

Parameters

name	Name of sibling to find, or 0 to return previous sibling regardless of its name; this string doesn't have to be zero-terminated if name_size is non-zero
name_size	Size of name, in characters, or 0 to have size calculated automatically from string
case_sensitive	Should name comparison be case-sensitive; non case-sensitive comparison works properly only for ASCII characters

Returns

Pointer to found sibling, or 0 if not found.

Definition at line 1152 of file rapidxml.hpp.

Here is the call graph for this function:

remove_all_attributes()

template<class Ch = char>

void remove_all_attributes ( )

inline

Removes all attributes of node.

Definition at line 1603 of file rapidxml.hpp.

Here is the call graph for this function:

remove_all_nodes()

template<class Ch = char>

void remove_all_nodes ( )

inline

Removes all child nodes (but not attributes).

Definition at line 1450 of file rapidxml.hpp.

Here is the call graph for this function:

remove_attribute()

template<class Ch = char>

void remove_attribute ( xml_attribute< Ch > * where )

inline

Removes specified attribute from node.

Parameters

where

Pointer to attribute to be removed.

Definition at line 1581 of file rapidxml.hpp.

Here is the call graph for this function:

remove_first_attribute()

template<class Ch = char>

void remove_first_attribute ( )

inline

Removes first attribute of the node.

If node has no attributes, behaviour is undefined. Use first_attribute() to test if node has attributes.

Definition at line 1538 of file rapidxml.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

remove_first_node()

template<class Ch = char>

void remove_first_node ( )

inline

Removes first child node.

If node has no children, behaviour is undefined. Use first_node() to test if node has children.

Definition at line 1384 of file rapidxml.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

remove_last_attribute()

template<class Ch = char>

void remove_last_attribute ( )

inline

Removes last attribute of the node.

If node has no attributes, behaviour is undefined. Use first_attribute() to test if node has attributes.

Definition at line 1560 of file rapidxml.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

remove_last_node()

template<class Ch = char>

void remove_last_node ( )

inline

Removes last child of the node.

If node has no children, behaviour is undefined. Use first_node() to test if node has children.

Definition at line 1406 of file rapidxml.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

remove_node()

template<class Ch = char>

void remove_node ( xml_node< Ch > * where )

inline

Removes specified child from the node.

Definition at line 1427 of file rapidxml.hpp.

Here is the call graph for this function:

type() [1/2]

template<class Ch = char>

node_type type ( ) const

inline

Gets type of node.

Returns

Type of node.

Definition at line 1055 of file rapidxml.hpp.

Here is the caller graph for this function:

type() [2/2]

template<class Ch = char>

void type ( node_type type )

inline

Sets type of node.

Parameters

type	Type of node to set.

Definition at line 1296 of file rapidxml.hpp.

Here is the call graph for this function:

---

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

• ArmarXCore/core/rapidxml/rapidxml.hpp