Base class for xml_node and xml_attribute implementing common functions: name(), name_size(), value(), value_size() and parent(). More...

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

Public Member Functions
Ch *	name () const
	Gets name of the node. More...

void	name (const Ch *name)
	Sets name of node to a zero-terminated string. More...

void	name (const Ch *name, std::size_t size)
	Sets name of node to a non zero-terminated string. More...

std::size_t	name_size () const
	Gets size of node name, not including terminator character. More...

xml_node< Ch > *	parent () const
	Gets node parent. More...

Ch *	value () const
	Gets value of node. More...

void	value (const Ch *value)
	Sets value of node to a zero-terminated string. More...

void	value (const Ch *value, std::size_t size)
	Sets value of node to a non zero-terminated string. More...

std::size_t	value_size () const
	Gets size of node value, not including terminator character. More...

	xml_base ()

Static Protected Member Functions
static Ch *	nullstr ()

Protected Attributes
Ch *	m_name

std::size_t	m_name_size

xml_node< Ch > *	m_parent

Ch *	m_value

std::size_t	m_value_size

Detailed Description

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

Base class for xml_node and xml_attribute implementing common functions: name(), name_size(), value(), value_size() and parent().

Parameters

Ch	Character type to use

Definition at line 714 of file rapidxml.hpp.

Constructor & Destructor Documentation

◆ xml_base()

xml_base ( )

inline

Definition at line 723 of file rapidxml.hpp.

Member Function Documentation

◆ name() [1/3]

Ch* name ( ) const

inline

Gets name of the node.

Interpretation of name depends on type of node. Note that name will not be zero-terminated if rapidxml::parse_no_string_terminators option was selected during parse.

Use name_size() function to determine length of the name.

Returns: Name of node, or empty string if node has no name.

Definition at line 739 of file rapidxml.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ name() [2/3]

void name ( const Ch * name )

inline

Sets name of node to a zero-terminated string.

See also ownership_of_strings and xml_node::name(const Ch *, std::size_t).

Parameters

name	Name of node to set. Must be zero terminated.

Definition at line 796 of file rapidxml.hpp.

Here is the call graph for this function:

◆ name() [3/3]

void name	(	const Ch *	name,
		std::size_t	size
	)

inline

Sets name of node to a non zero-terminated string.

See ownership_of_strings.

Note that node does not own its name or value, it only stores a pointer to it. It will not delete or otherwise free the pointer on destruction. It is reponsibility of the user to properly manage lifetime of the string. The easiest way to achieve it is to use memory_pool of the document to allocate the string - on destruction of the document the string will be automatically freed.

Size of name must be specified separately, because name does not have to be zero terminated. Use name(const Ch *) function to have the length automatically calculated (string must be zero terminated).

Parameters

name	Name of node to set. Does not have to be zero terminated.
size	Size of name, in characters. This does not include zero terminator, if one is present.

Definition at line 787 of file rapidxml.hpp.

Here is the call graph for this function:

◆ name_size()

std::size_t name_size ( ) const

inline

Gets size of node name, not including terminator character.

This function works correctly irrespective of whether name is or is not zero terminated.

Returns: Size of node name, in characters.

Definition at line 747 of file rapidxml.hpp.

◆ nullstr()

static Ch* nullstr ( )

inlinestaticprotected

Definition at line 844 of file rapidxml.hpp.

Here is the caller graph for this function:

◆ parent()

xml_node<Ch>* parent ( ) const

inline

Gets node parent.

Returns: Pointer to parent node, or 0 if there is no parent.

Definition at line 836 of file rapidxml.hpp.

◆ value() [1/3]

Ch* value ( ) const

inline

Gets value of node.

Interpretation of value depends on type of node. Note that value will not be zero-terminated if rapidxml::parse_no_string_terminators option was selected during parse.

Use value_size() function to determine length of the value.

Returns: Value of node, or empty string if node has no value.

Definition at line 758 of file rapidxml.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ value() [2/3]

void value ( const Ch * value )

inline

Sets value of node to a zero-terminated string.

See also ownership_of_strings and xml_node::value(const Ch *, std::size_t).

Parameters

value Vame of node to set. Must be zero terminated.

Definition at line 826 of file rapidxml.hpp.

Here is the call graph for this function:

◆ value() [3/3]

void value	(	const Ch *	value,
		std::size_t	size
	)

inline

Sets value of node to a non zero-terminated string.

See ownership_of_strings.

Note that node does not own its name or value, it only stores a pointer to it. It will not delete or otherwise free the pointer on destruction. It is reponsibility of the user to properly manage lifetime of the string. The easiest way to achieve it is to use memory_pool of the document to allocate the string - on destruction of the document the string will be automatically freed.

Size of value must be specified separately, because it does not have to be zero terminated. Use value(const Ch *) function to have the length automatically calculated (string must be zero terminated).

If an element has a child node of type node_data, it will take precedence over element value when printing. If you want to manipulate data of elements using values, use parser flag rapidxml::parse_no_data_nodes to prevent creation of data nodes by the parser.

Parameters

value	value of node to set. Does not have to be zero terminated.
size	Size of value, in characters. This does not include zero terminator, if one is present.

Definition at line 817 of file rapidxml.hpp.

Here is the call graph for this function:

◆ value_size()

std::size_t value_size ( ) const

inline

Gets size of node value, not including terminator character.

This function works correctly irrespective of whether value is or is not zero terminated.

Returns: Size of node value, in characters.

Definition at line 766 of file rapidxml.hpp.

Member Data Documentation

◆ m_name

Ch* m_name

protected

Definition at line 850 of file rapidxml.hpp.

◆ m_name_size

std::size_t m_name_size

protected

Definition at line 852 of file rapidxml.hpp.

◆ m_parent

xml_node<Ch>* m_parent

protected

Definition at line 854 of file rapidxml.hpp.

◆ m_value

Ch* m_value

protected

Definition at line 851 of file rapidxml.hpp.

◆ m_value_size

std::size_t m_value_size

protected

Definition at line 853 of file rapidxml.hpp.

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

ArmarXCore/core/rapidxml/rapidxml.hpp

Public Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ xml_base()

Member Function Documentation

◆ name() [1/3]

◆ name() [2/3]

◆ name() [3/3]

◆ name_size()

◆ nullstr()

◆ parent()

◆ value() [1/3]

◆ value() [2/3]

◆ value() [3/3]

◆ value_size()

Member Data Documentation

◆ m_name

◆ m_name_size

◆ m_parent

◆ m_value

◆ m_value_size

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