xml_document< Ch > Class Template Reference

This class represents root of the DOM hierarchy. More...

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

Public Member Functions

void clear ()
 Clears the document by deleting all nodes and clearing the memory pool. More...
 
template<int Flags>
void parse (Ch *text)
 Parses zero-terminated XML string according to given flags. More...
 
 xml_document ()
 Constructs empty XML document. More...
 

Detailed Description

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

This class represents root of the DOM hierarchy.

It is also an xml_node and a memory_pool through public inheritance. Use parse() function to build a DOM tree from a zero-terminated XML text string. parse() function allocates memory for nodes and attributes by using functions of xml_document, which are inherited from memory_pool. To access root node of the document, use the document itself, as if it was an xml_node.

Parameters
ChCharacter type to use.

Definition at line 140 of file rapidxml.hpp.

Constructor & Destructor Documentation

◆ xml_document()

xml_document ( )
inline

Constructs empty XML document.

Definition at line 1558 of file rapidxml.hpp.

Member Function Documentation

◆ clear()

void clear ( )
inline

Clears the document by deleting all nodes and clearing the memory pool.

All nodes owned by document pool are destroyed.

Definition at line 1617 of file rapidxml.hpp.

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

◆ parse()

void parse ( Ch *  text)
inline

Parses zero-terminated XML string according to given flags.

Passed string will be modified by the parser, unless rapidxml::parse_non_destructive flag is used. The string must persist for the lifetime of the document. In case of error, rapidxml::parse_error exception will be thrown.

If you want to parse contents of a file, you must first load the file into the memory, and pass pointer to its beginning. Make sure that data is zero-terminated.

Document can be parsed into multiple times. Each new call to parse removes previous nodes and attributes (if any), but does not clear memory pool.

Parameters
textXML data to parse; pointer is non-const to denote fact that this data may be modified by the parser.

Definition at line 1575 of file rapidxml.hpp.

+ Here is the caller graph for this function:

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