XMLAlgorithms(3)

Library Functions Manual

XMLAlgorithms(3)

NAME

XMLAlgorithms - The XMLAlgorithms class.

SYNOPSIS

#include <XMLAlgorithms.h>

Public Member Functions

XMLAlgorithms ()
XMLAlgorithms constructor.

Static Public Member Functions

static void searchElement (const std::vector< XMLElement > &elements, const std::string &element_name, std::vector< XMLElement * > &result)
Searches for XML elements. static void searchElement (const std::vector< XMLElement > &elements, const XMLElement::Type &element_type, std::vector< XMLElement * > &result)
Searches for XML elements. static void searchElement (const std::vector< XMLElement > &elements, const std::string &element_name, const std::string &attribute_id, std::vector< XMLElement * > &result)
Searches for XML elements. static void searchElement (const std::vector< XMLElement > &elements, const std::string &element_name, const std::string &attribute_id, const std::string &attribute_value, std::vector< XMLElement * > &result)
Searches for XML elements. static void searchElement (const std::vector< XMLElement * > &elements, const std::string &element_name, std::vector< XMLElement * > &result)
Searches for XML elements. static void searchElement (const std::vector< XMLElement * > &elements, const XMLElement::Type &element_type, std::vector< XMLElement * > &result)
Searches for XML elements. static void searchElement (const std::vector< XMLElement * > &elements, const std::string &element_name, const std::string &attribute_id, std::vector< XMLElement * > &result)
Searches for XML elements. static void searchElement (const std::vector< XMLElement * > &elements, const std::string &element_name, const std::string &attribute_id, const std::string &attribute_value, std::vector< XMLElement * > &result)
Searches for XML elements. static void searchElement (const std::vector< XMLElement > &elements, std::function< bool(const XMLElement &)> search_function, std::vector< XMLElement * > &result)
Searches for XML elements. static void searchElement (const std::vector< XMLElement * > &elements, std::function< bool(const XMLElement &)> search_function, std::vector< XMLElement * > &result)
Searches for XML elements. static void writeXML (const std::vector< XMLElement > &elements, std::string &result)
Writes XML elements to given string. static void writeXML (const std::vector< XMLElement * > &elements, std::string &result)
Writes XML elements to given string.

Detailed Description

The XMLAlgorithms class.

XMLAlgorithms class contains various methods for XMLElement processing.

Member Function Documentation

void XMLAlgorithms::searchElement (const std::vector< XMLElement * > & elements, const std::string & element_name, const std::string & attribute_id, const std::string & attribute_value, std::vector< XMLElement * > & result) [static]

Searches for XML elements. This method searches XML elements of given name containing attribute of given ID set to given value within vector of pointers to XMLElement provided. Search is carried out in subelements as well (see XMLElement documentation).

Parameters

elements Vector of pointers to XMLElement search to be carried out on.
element_name Desired XML element name.
attribute_id Desired XML element attribute name.
attribute_value Desired XML element attribute value.
result Vector of pointers to XMLElement search results to be appended to.

void XMLAlgorithms::searchElement (const std::vector< XMLElement * > & elements, const std::string & element_name, const std::string & attribute_id, std::vector< XMLElement * > & result) [static]

Searches for XML elements. This method searches XML elements of given name containing attribute of given ID within vector of pointers to XMLElement provided. Search is carried out in subelements as well (see XMLElement documentation).

Parameters

elements Vector of pointers to XMLElement search to be carried out on.
element_name Desired XML element name.
attribute_id Desired XML element attribute name.
result Vector of pointers to XMLElement search results to be appended to.

void XMLAlgorithms::searchElement (const std::vector< XMLElement * > & elements, const std::string & element_name, std::vector< XMLElement * > & result) [static]

Searches for XML elements. This method searches for XML elements of a given name within vector of pointers to XMLElement provided. Search is carried out in subelements as well (see XMLElement documentation).

Parameters

elements Vector of pointers to XMLElement search to be carried out on.
element_name Desired XML element name.
result Vector of pointers to XMLElement search results to be appended to.

void XMLAlgorithms::searchElement (const std::vector< XMLElement * > & elements, const XMLElement::Type & element_type, std::vector< XMLElement * > & result) [static]

Searches for XML elements. This method searches XML elements of given type within vector of poiters to XMLElement provided. Search is carried out in subelements as well (see XMLElement documentation).

Parameters

elements Vector of pointers to XMLElement search to be carried out on.
element_type Desired XML element type.
result Vector of pointers to XMLElement search results to be appended to.

void XMLAlgorithms::searchElement (const std::vector< XMLElement * > & elements, std::function< bool(const XMLElement &)> search_function, std::vector< XMLElement * > & result) [static]

Searches for XML elements. This method searches XML elements according to search_finction conditions.

Parameters

elements Vector of pointers to XMLElement search to be carried out on.
search_function Search function.
result Vector results of search to be put to.

void XMLAlgorithms::searchElement (const std::vector< XMLElement > & elements, const std::string & element_name, const std::string & attribute_id, const std::string & attribute_value, std::vector< XMLElement * > & result) [static]

Searches for XML elements. This method searches XML elements of given name containing attribute of given ID set to given value within vector of XMLElement provided. Search is carried out in subelements as well (see XMLElement documentation).

Warning