BESXMLUtils Class Reference

Collaboration diagram for BESXMLUtils:

Static Public Member Functions
static xmlNode *	GetChild (xmlNode *node, const std::string &child_name, std::string &child_value, std::map< std::string, std::string > &child_props)
	get the element child node of the given node with the given name
static xmlNode *	GetFirstChild (xmlNode *node, std::string &child_name, std::string &child_value, std::map< std::string, std::string > &child_props)
	get the first element child node for the given node
static xmlNode *	GetNextChild (xmlNode *child_node, std::string &next_name, std::string &next_value, std::map< std::string, std::string > &next_props)
	get the next element child node after the given child node
static void	GetNodeInfo (xmlNode *node, std::string &name, std::string &value, std::map< std::string, std::string > &props)
	get the name, value if any, and any properties for the specified node
static void	GetProps (xmlNode *node, std::map< std::string, std::string > &props)
	given an xml node, build the map of properties (xml attributes) for that node
static void	XMLErrorFunc (void *context, const char *msg,...)
	error function used by libxml2 to report errors

Detailed Description

Definition at line 43 of file BESXMLUtils.h.

Member Function Documentation

GetChild()

xmlNode * BESXMLUtils::GetChild ( xmlNode * node, const std::string & child_name, std::string & child_value, std::map< std::string, std::string > & child_props )

static

get the element child node of the given node with the given name

Parameters

node	the xml node to get the named child node for
child_name	name of the child element node to get
child_value	parameter to store the value, if any, of the named child
child_props	parameter to store any properties of the named child

Definition at line 196 of file BESXMLUtils.cc.

GetFirstChild()

xmlNode * BESXMLUtils::GetFirstChild ( xmlNode * node, std::string & child_name, std::string & child_value, std::map< std::string, std::string > & child_props )

static

get the first element child node for the given node

Parameters

node	the xml node to get the first element child from
child_name	parameter to store the name of the first child
child_value	parameter to store the value, if any, of the first child
child_props	parameter to store any properties of the first child

Definition at line 143 of file BESXMLUtils.cc.

GetNextChild()

xmlNode * BESXMLUtils::GetNextChild ( xmlNode * child_node, std::string & next_name, std::string & next_value, std::map< std::string, std::string > & next_props )

static

get the next element child node after the given child node

Parameters

child_node	get the next child after this child
next_name	parameter to store the name of the next child
next_value	parameter to store the value, if any, of the next child
next_props	parameter to store any properties of the next child

Definition at line 170 of file BESXMLUtils.cc.

GetNodeInfo()

void BESXMLUtils::GetNodeInfo ( xmlNode * node, std::string & name, std::string & value, std::map< std::string, std::string > & props )

static

get the name, value if any, and any properties for the specified node

Parameters

node	the xml node to get the information for
name	value-result parameter: the name of the node
value	v-r parameter: the content of the node, if this is a text node, else the empty string
props	v-r parameter to store any properties of the node

Definition at line 109 of file BESXMLUtils.cc.

GetProps()

void BESXMLUtils::GetProps ( xmlNode * node, std::map< std::string, std::string > & props )

static

given an xml node, build the map of properties (xml attributes) for that node

Properties (xml attributes) can have multiple values, hence the need for a map of string keys and a list of values.

Parameters

node	xml node to retrieve properties from
props	map to store the property name and values in

Definition at line 74 of file BESXMLUtils.cc.

XMLErrorFunc()

void BESXMLUtils::XMLErrorFunc ( void * context, const char * msg, ... )

static

error function used by libxml2 to report errors

libxml2 has a default error function which simply displays the errors to stderr or stdout, whichever. This function can be used to replace the default function and store the error strings in a vector of strings

Parameters

context	vector<string> pointer to list of error strings
msg	the error message format string
...	the arguments to the error message format string

Definition at line 54 of file BESXMLUtils.cc.

---

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

• BESXMLUtils.h
• BESXMLUtils.cc