XML Utilities Class. More...

#include <ored/utilities/xmlutils.hpp>

Collaboration diagram for XMLUtils:

Static Public Member Functions
static void	checkNode (XMLNode *n, const string &expectedName)

static XMLNode *	addChild (XMLDocument &doc, XMLNode *n, const string &name)

static void	addChild (XMLDocument &doc, XMLNode *n, const string &name, const string &value)

static void	addChildAsCdata (XMLDocument &doc, XMLNode *n, const string &name, const string &value)

static void	addChild (XMLDocument &doc, XMLNode *n, const string &name, const string &value, const string &attrName, const string &attr)

static void	addChild (XMLDocument &doc, XMLNode *n, const string &name, const string &value, const vector< string > &attrNames, const vector< string > &attrs)

static void	addChild (XMLDocument &doc, XMLNode n, const string &name, const char value)

static void	addChild (XMLDocument &doc, XMLNode *n, const string &name, Real value)

static void	addChild (XMLDocument &doc, XMLNode *n, const string &name, int value)

static void	addChild (XMLDocument &doc, XMLNode *n, const string &name, bool value)

static void	addChild (XMLDocument &doc, XMLNode *n, const string &name, const Period &value)

template<class T >
static void	addGenericChild (XMLDocument &doc, XMLNode n, const char name, const T &value)
	Adds `<Name>p1,p2,p3</Name>` More...

template<class T >
static void	addGenericChildAsList (XMLDocument &doc, XMLNode *n, const string &name, const vector< T > &values, const string &attrName="", const string &attr="")

template<class T = string>
static void	addChildren (XMLDocument &doc, XMLNode *n, const string &names, const string &name, const vector< T > &values)

static void	addChild (XMLDocument &doc, XMLNode *n, const string &name, const vector< Real > &values)
	Adds `<Name>v1,v2,v3</Name>` - the inverse of getChildrenValuesAsDoublesCompact. More...

template<class T = string>
static void	addChildrenWithAttributes (XMLDocument &doc, XMLNode *n, const string &names, const string &name, const vector< T > &values, const string &attrName, const vector< string > &attrs)

template<class T = string>
static void	addChildrenWithAttributes (XMLDocument &doc, XMLNode *n, const string &names, const string &name, const vector< T > &values, const vector< string > &attrNames, const vector< vector< string > > &attrs)

template<class T = string>
static void	addChildrenWithOptionalAttributes (XMLDocument &doc, XMLNode *n, const string &names, const string &name, const vector< T > &values, const string &attrName, const vector< string > &attrs)

template<class T = string>
static void	addChildrenWithOptionalAttributes (XMLDocument &doc, XMLNode *n, const string &names, const string &name, const vector< T > &values, const vector< string > &attrNames, const vector< vector< string > > &attrs)

static void	addChildren (XMLDocument &doc, XMLNode *n, const string &names, const string &name, const string &firstName, const string &secondName, const map< string, string > &values)

static string	getChildValue (XMLNode *node, const string &name, bool mandatory=false, const string &defaultValue=string())

static Real	getChildValueAsDouble (XMLNode *node, const string &name, bool mandatory=false, double defaultValue=0.0)

static int	getChildValueAsInt (XMLNode *node, const string &name, bool mandatory=false, int defaultValue=0)

static bool	getChildValueAsBool (XMLNode *node, const string &name, bool mandatory=false, bool defaultValue=true)

static Period	getChildValueAsPeriod (XMLNode node, const string &name, bool mandatory=false, const QuantLib::Period &defaultValue=0 QuantLib::Days)

static vector< string >	getChildrenValues (XMLNode *node, const string &names, const string &name, bool mandatory=false)

static vector< string >	getChildrenValuesWithAttributes (XMLNode *node, const string &names, const string &name, const string &attrName, vector< string > &attrs, bool mandatory=false)

static vector< string >	getChildrenValuesWithAttributes (XMLNode *node, const string &names, const string &name, const vector< string > &attrNames, const vector< std::reference_wrapper< vector< string > > > &attrs, bool mandatory=false)

template<class T >
static vector< T >	getChildrenValuesWithAttributes (XMLNode *node, const string &names, const string &name, const string &attrName, vector< string > &attrs, const std::function< T(string)> parser, bool mandatory=false)

template<class T >
static vector< T >	getChildrenValuesWithAttributes (XMLNode *node, const string &names, const string &name, const vector< string > &attrNames, const vector< std::reference_wrapper< vector< string > > > &attrs, const std::function< T(string)> parser, bool mandatory=false)

static vector< Real >	getChildrenValuesAsDoubles (XMLNode *node, const string &names, const string &name, bool mandatory=false)

static vector< Real >	getChildrenValuesAsDoublesCompact (XMLNode *node, const string &name, bool mandatory=false)

static vector< Period >	getChildrenValuesAsPeriods (XMLNode *node, const string &name, bool mandatory=false)

static vector< string >	getChildrenValuesAsStrings (XMLNode *node, const string &name, bool mandatory=false)

static map< string, string >	getChildrenValues (XMLNode *node, const string &names, const string &name, const string &firstName, const string &secondName, bool mandatory=false)

static map< string, string >	getChildrenAttributesAndValues (XMLNode *parent, const string &names, const string &attributeName, bool mandatory=false)

static XMLNode *	getChildNode (XMLNode *n, const string &name="")

static XMLNode *	locateNode (XMLNode *n, const string &name="")

static void	appendNode (XMLNode parent, XMLNode child)

static void	addAttribute (XMLDocument &doc, XMLNode *node, const string &attrName, const string &attrValue)

static string	getAttribute (XMLNode *node, const string &attrName)

static vector< XMLNode * >	getChildrenNodes (XMLNode *node, const string &name)
	Returns all the children with a given name. More...

static vector< XMLNode * >	getChildrenNodesWithAttributes (XMLNode *node, const string &names, const string &name, const string &attrName, vector< string > &attrs, bool mandatory=false)

static vector< XMLNode * >	getChildrenNodesWithAttributes (XMLNode *node, const string &names, const string &name, const vector< string > &attrNames, const vector< std::reference_wrapper< vector< string > > > &attrs, bool mandatory=false)

static string	getNodeName (XMLNode *n)
	Get and set a node's name. More...

static void	setNodeName (XMLDocument &doc, XMLNode *node, const string &name)

static XMLNode *	getNextSibling (XMLNode *node, const string &name="")
	Get a node's next sibling node. More...

static string	getNodeValue (XMLNode *node)
	Get a node's value. More...

static vector< Real >	getNodeValueAsDoublesCompact (XMLNode *node)
	Get a node's compact values as vector of doubles. More...

static string	toString (XMLNode *node)
	Write a node out as a string. More...

static string	convertToString (const Real value)

template<class T >
static string	convertToString (const T &value)

Detailed Description

XML Utilities Class.

Definition at line 119 of file xmlutils.hpp.

Member Function Documentation

◆ checkNode()

void checkNode	(	XMLNode *	n,
		const string &	expectedName
	)

static

Definition at line 175 of file xmlutils.cpp.

                                                                  {
    QL_REQUIRE(node, "XML Node is NULL (expected " << expectedName << ")");
    QL_REQUIRE(node->name() == expectedName,
               "XML Node name " << node->name() << " does not match expected name " << expectedName);
}

Here is the caller graph for this function:

◆ addChild() [1/10]

XMLNode * addChild	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	name
	)

static

Definition at line 181 of file xmlutils.cpp.

                                                                                 {
    QL_REQUIRE(parent, "XML Parent Node is NULL (adding Child " << name << ")");
    XMLNode* node = doc.allocNode(name);
    parent->insert_node(0, node);
    return node;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addChild() [2/10]

void addChild	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	name,
		const string &	value
	)

static

Definition at line 192 of file xmlutils.cpp.

                                                                                             {
    if (value.empty()) {
        addChild(doc, n, name);
    } else {
        XMLNode* node = doc.allocNode(name, value);
        QL_REQUIRE(n, "XML Node is NULL (adding " << name << ")");
        n->insert_node(0, node);
    }
}

Here is the call graph for this function:

◆ addChildAsCdata()

void addChildAsCdata	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	name,
		const string &	value
	)

static

Definition at line 202 of file xmlutils.cpp.

                                                                                                    {
    if (value.empty()) {
        addChild(doc, n, name);
    } else {
        QL_REQUIRE(n, "XML Node is NULL (adding " << name << ")");
        XMLNode* node = doc.allocNode(name);
        n->insert_node(0, node);
        XMLNode* cdata_node = doc.doc()->allocate_node(node_cdata);
        cdata_node->value(doc.allocString(value));
        QL_REQUIRE(cdata_node, "Failed to allocate cdata node for " << name);
        node->insert_node(0, cdata_node);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addChild() [3/10]

void addChild	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	name,
		const string &	value,
		const string &	attrName,
		const string &	attr
	)

static

Definition at line 216 of file xmlutils.cpp.

                                            {
    if (!attrName.empty() || !attr.empty()) {
        addChild(doc, n, name, value, std::vector<string>{attrName}, std::vector<string>{attr});
    } else {
        addChild(doc, n, name, value, std::vector<string>{}, std::vector<string>{});
    }
}

Here is the call graph for this function:

◆ addChild() [4/10]

void addChild	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	name,
		const string &	value,
		const vector< string > &	attrNames,
		const vector< string > &	attrs
	)

static

Definition at line 225 of file xmlutils.cpp.

                                                                                      {
    QL_REQUIRE(attrNames.size() == attrs.size(), "The size of attrNames should be the same as the size of attrs.");
    XMLNode* node;
    if (value.empty()) {
        node = addChild(doc, n, name);
    } else {
        node = doc.allocNode(name, value);
        QL_REQUIRE(n, "XML Node is NULL (adding " << name << ")");
        n->insert_node(0, node);
    }
    for (Size i = 0; i < attrNames.size(); ++i) {
        XMLUtils::addAttribute(doc, node, attrNames[i], attrs[i]);
    }
}

Here is the call graph for this function:

◆ addChild() [5/10]

void addChild	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	name,
		const char *	value
	)

static

Definition at line 188 of file xmlutils.cpp.

                                                                                           {
    addChild(doc, n, name, string(value));
}

Here is the call graph for this function:

◆ addChild() [6/10]

void addChild	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	name,
		Real	value
	)

static

Definition at line 241 of file xmlutils.cpp.

                                                                                    {
    addChild(doc, n, name, convertToString(value));
}

Here is the call graph for this function:

◆ addChild() [7/10]

void addChild	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	name,
		int	value
	)

static

Definition at line 245 of file xmlutils.cpp.

                                                                                   {
    addChild(doc, n, name, std::to_string(value));
}

Here is the call graph for this function:

◆ addChild() [8/10]

void addChild	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	name,
		bool	value
	)

static

Definition at line 249 of file xmlutils.cpp.

                                                                                    {
    string s = value ? "true" : "false";
    addChild(doc, n, name, s);
}

Here is the call graph for this function:

◆ addChild() [9/10]

void addChild	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	name,
		const Period &	value
	)

static

Definition at line 254 of file xmlutils.cpp.

                                                                                             {
    addChild(doc, n, name, ore::data::to_string(value));
}

Here is the call graph for this function:

◆ addGenericChild()

static void addGenericChild	(	XMLDocument &	doc,
		XMLNode *	n,
		const char *	name,
		const T &	value
	)

static

Adds <Name>p1,p2,p3</Name>

Definition at line 137 of file xmlutils.hpp.

                                                                                                                   {
        std::ostringstream oss;
        oss << value;
        addChild(doc, n, name, oss.str());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addGenericChildAsList()

static void addGenericChildAsList	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	name,
		const vector< T > &	values,
		const string &	attrName = `""`,
		const string &	attr = `""`
	)

static

Definition at line 144 of file xmlutils.hpp.

                                                                                            {
        std::ostringstream oss;
        if (values.size() == 0) {
            oss << "";
        } else {
            oss << values[0];
            for (Size i = 1; i < values.size(); i++) {
                oss << ", " << values[i];
            }
        }
        addChild(doc, n, name, oss.str(), attrName, attr);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addChildren() [1/2]

void addChildren	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	names,
		const string &	name,
		const vector< T > &	values
	)

static

Definition at line 502 of file xmlutils.cpp.

                                                    {
    XMLNode* node = addChild(doc, parent, names);
    for (Size i = 0; i < values.size(); i++)
        addChild(doc, node, name, values[i]);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addChild() [10/10]

void addChild	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	name,
		const vector< Real > &	values
	)

static

Adds <Name>v1,v2,v3</Name> - the inverse of getChildrenValuesAsDoublesCompact.

Definition at line 258 of file xmlutils.cpp.

                                                                                                         {
    vector<string> strings(values.size());
    std::transform(values.begin(), values.end(), strings.begin(), [](Real x) { return convertToString(x); });
    addChild(doc, parent, name, boost::algorithm::join(strings, ","));
}

Here is the call graph for this function:

◆ addChildrenWithAttributes() [1/2]

void addChildrenWithAttributes	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	names,
		const string &	name,
		const vector< T > &	values,
		const string &	attrName,
		const vector< string > &	attrs
	)

static

Definition at line 510 of file xmlutils.cpp.

                                                                                                                       {
    addChildrenWithAttributes(doc, parent, names, name, values, vector<string>{attrName},
                              vector<vector<string>>{attrs});
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addChildrenWithAttributes() [2/2]

void addChildrenWithAttributes	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	names,
		const string &	name,
		const vector< T > &	values,
		const vector< string > &	attrNames,
		const vector< vector< string > > &	attrs
	)

static

Definition at line 517 of file xmlutils.cpp.

                                                                              {
    QL_REQUIRE(attrNames.size() == attrs.size(),
               "attrNames size (" << attrNames.size() << ") must match attrs size (" << attrs.size() << ")");
    if (values.size() > 0) {
        for (auto const& attr : attrs) {
            QL_REQUIRE(values.size() == attr.size(), "Values / Attribute vector size mismatch");
        }
        QL_REQUIRE(parent, "XML Node is null (Adding " << names << ")");
        XMLNode* node = addChild(doc, parent, names);
        for (Size i = 0; i < values.size(); i++) {
            XMLNode* c = doc.allocNode(name, convertToString(values[i]));
            QL_REQUIRE(c, "XML AllocNode failure (" << name << ")");
            QL_REQUIRE(node, "XML Node is NULL (" << name << ")");
            node->insert_node(0, c);
            for (Size j = 0; j < attrs.size(); ++j) {
                if (attrs[j][i] != "")
                    addAttribute(doc, c, attrNames[j], attrs[j][i]);
            }
        }
    }
}

Here is the call graph for this function:

◆ addChildrenWithOptionalAttributes() [1/2]

void addChildrenWithOptionalAttributes	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	names,
		const string &	name,
		const vector< T > &	values,
		const string &	attrName,
		const vector< string > &	attrs
	)

static

Definition at line 542 of file xmlutils.cpp.

                                                                              {
    addChildrenWithOptionalAttributes(doc, n, names, name, values, vector<string>{attrName},
                                      vector<vector<string>>{attrs});
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addChildrenWithOptionalAttributes() [2/2]

void addChildrenWithOptionalAttributes	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	names,
		const string &	name,
		const vector< T > &	values,
		const vector< string > &	attrNames,
		const vector< vector< string > > &	attrs
	)

static

Definition at line 550 of file xmlutils.cpp.

                                                                                      {
    QL_REQUIRE(attrNames.size() == attrs.size(),
               "attrNames size (" << attrNames.size() << ") must match attrs size (" << attrs.size() << ")");
    for (auto const& attr : attrs)
        QL_REQUIRE(attr.empty() == attrs.front().empty(), "all attributes must be empty or non-empty at the same time");
    if (attrs.empty() || attrs.front().empty())
        XMLUtils::addChildren(doc, n, names, name, values);
    else
        XMLUtils::addChildrenWithAttributes(doc, n, names, name, values, attrNames, attrs);
}

Here is the call graph for this function:

◆ addChildren() [2/2]

void addChildren	(	XMLDocument &	doc,
		XMLNode *	n,
		const string &	names,
		const string &	name,
		const string &	firstName,
		const string &	secondName,
		const map< string, string > &	values
	)

static

Definition at line 264 of file xmlutils.cpp.

                                                                                                                 {
    QL_REQUIRE(parent, "XML Node is null (Adding " << names << ")");
    XMLNode* node = addChild(doc, parent, names);
    map<string, string>::const_iterator it;
    for (it = values.begin(); it != values.end(); ++it) {
        XMLNode* n = addChild(doc, node, name);
        QL_REQUIRE(n, "XML AllocNode failure (" << name << ")");
        addChild(doc, n, firstName, it->first);
        addChild(doc, n, secondName, it->second);
    }
}

Here is the call graph for this function:

◆ getChildValue()

string getChildValue	(	XMLNode *	node,
		const string &	name,
		bool	mandatory = `false`,
		const string &	defaultValue = `string()`
	)

static

Definition at line 277 of file xmlutils.cpp.

                                                                                                            {
    QL_REQUIRE(node, "XMLNode is NULL (was looking for child " << name << ")");
    xml_node<>* child = node->first_node(name.c_str());
    if (mandatory) {
        QL_REQUIRE(child, "Error: No XML Child Node " << name << " found.");
    }
    return child ? getNodeValue(child) : defaultValue;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildValueAsDouble()

Real getChildValueAsDouble	(	XMLNode *	node,
		const string &	name,
		bool	mandatory = `false`,
		double	defaultValue = `0.0`
	)

static

Definition at line 286 of file xmlutils.cpp.

                                                                                                           {
    string s = getChildValue(node, name, mandatory);
    return s == "" ? defaultValue : parseReal(s);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildValueAsInt()

int getChildValueAsInt	(	XMLNode *	node,
		const string &	name,
		bool	mandatory = `false`,
		int	defaultValue = `0`
	)

static

Definition at line 291 of file xmlutils.cpp.

                                                                                                    {
    string s = getChildValue(node, name, mandatory);
    return s == "" ? defaultValue : parseInteger(s);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildValueAsBool()

bool getChildValueAsBool	(	XMLNode *	node,
		const string &	name,
		bool	mandatory = `false`,
		bool	defaultValue = `true`
	)

static

Definition at line 296 of file xmlutils.cpp.

                                                                                                       {
    string s = getChildValue(node, name, mandatory);
    return s == "" ? defaultValue : parseBool(s);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildValueAsPeriod()

Period getChildValueAsPeriod	(	XMLNode *	node,
		const string &	name,
		bool	mandatory = `false`,
		const QuantLib::Period &	defaultValue = `0 * QuantLib::Days`
	)

static

Definition at line 301 of file xmlutils.cpp.

                                                                                                                    {
    string s = getChildValue(node, name, mandatory);
    return s == "" ? defaultValue : parsePeriod(s);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildrenValues() [1/2]

vector< string > getChildrenValues	(	XMLNode *	node,
		const string &	names,
		const string &	name,
		bool	mandatory = `false`
	)

static

Definition at line 306 of file xmlutils.cpp.

                                                                                                                   {
    vector<string> vec;
    xml_node<>* node = parent->first_node(names.c_str());
    if (mandatory) {
        QL_REQUIRE(node, "Error: No XML Node " << names << " found.");
    }
    if (node) {
        for (xml_node<>* child = node->first_node(name.c_str()); child; child = child->next_sibling(name.c_str()))
            vec.push_back(getNodeValue(child));
    }
    return vec;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildrenValuesWithAttributes() [1/4]

vector< string > getChildrenValuesWithAttributes	(	XMLNode *	node,
		const string &	names,
		const string &	name,
		const string &	attrName,
		vector< string > &	attrs,
		bool	mandatory = `false`
	)

static

Definition at line 563 of file xmlutils.cpp.

                                                                         {
    return getChildrenValuesWithAttributes<string>(
        parent, names, name, attrName, attrs, [](const string& x) { return x; }, mandatory);
}

Here is the caller graph for this function:

◆ getChildrenValuesWithAttributes() [2/4]

vector< string > getChildrenValuesWithAttributes	(	XMLNode *	node,
		const string &	names,
		const string &	name,
		const vector< string > &	attrNames,
		const vector< std::reference_wrapper< vector< string > > > &	attrs,
		bool	mandatory = `false`
	)

static

Definition at line 579 of file xmlutils.cpp.

                                                                         {
    return getChildrenValuesWithAttributes<string>(
        parent, names, name, attrNames, attrs, [](const string& x) { return x; }, mandatory);
}

◆ getChildrenValuesWithAttributes() [3/4]

vector< T > getChildrenValuesWithAttributes	(	XMLNode *	node,
		const string &	names,
		const string &	name,
		const string &	attrName,
		vector< string > &	attrs,
		const std::function< T(string)>	parser,
		bool	mandatory = `false`
	)

static

Definition at line 571 of file xmlutils.cpp.

                                                                                                         {
    std::vector<std::reference_wrapper<vector<string>>> attrs_v;
    attrs_v.push_back(attrs);
    return getChildrenValuesWithAttributes(parent, names, name, vector<string>{attrName}, attrs_v, parser, mandatory);
}

Here is the call graph for this function:

◆ getChildrenValuesWithAttributes() [4/4]

vector< T > getChildrenValuesWithAttributes	(	XMLNode *	node,
		const string &	names,
		const string &	name,
		const vector< string > &	attrNames,
		const vector< std::reference_wrapper< vector< string > > > &	attrs,
		const std::function< T(string)>	parser,
		bool	mandatory = `false`
	)

static

Definition at line 588 of file xmlutils.cpp.

                                                                                                         {
    QL_REQUIRE(parser, "XMLUtils::getChildrenValuesWithAttributes(): parser is null");
    QL_REQUIRE(attrNames.size() == attrs.size(),
               "attrNames size (" << attrNames.size() << ") must match attrs size (" << attrs.size() << ")");
    vector<T> vec;
    // if 'names' is not given, use the parent node directly
    rapidxml::xml_node<>* node = names.empty() ? parent : parent->first_node(names.c_str());
    if (mandatory) {
        QL_REQUIRE(node, "Error: No XML Node " << names << " found.");
    }
    if (node) {
        for (rapidxml::xml_node<>* child = node->first_node(name.c_str()); child;
             child = child->next_sibling(name.c_str())) {
 
            std::string vstr = getNodeValue(child);
            vec.push_back(parser(vstr));
 
            for (Size i = 0; i < attrNames.size(); ++i) {
                xml_attribute<>* attr = child->first_attribute(attrNames[i].c_str());
                if (attr && attr->value())
                    ((vector<string>&)attrs[i]).push_back(attr->value());
                else
                    ((vector<string>&)attrs[i]).push_back("");
            }
        }
    }
    return vec;
}

Here is the call graph for this function:

◆ getChildrenValuesAsDoubles()

vector< Real > getChildrenValuesAsDoubles	(	XMLNode *	node,
		const string &	names,
		const string &	name,
		bool	mandatory = `false`
	)

static

Definition at line 319 of file xmlutils.cpp.

                                                                  {
    vector<string> vecS = getChildrenValues(node, names, name, mandatory);
    vector<Real> vecD(vecS.size());
    std::transform(vecS.begin(), vecS.end(), vecD.begin(), parseReal);
    return vecD;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildrenValuesAsDoublesCompact()

vector< Real > getChildrenValuesAsDoublesCompact	(	XMLNode *	node,
		const string &	name,
		bool	mandatory = `false`
	)

static

Definition at line 327 of file xmlutils.cpp.

                                                                                                          {
    string s = getChildValue(node, name, mandatory);
    return parseListOfValues(s, std::function<Real(string)>(&parseReal));
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildrenValuesAsPeriods()

vector< Period > getChildrenValuesAsPeriods	(	XMLNode *	node,
		const string &	name,
		bool	mandatory = `false`
	)

static

Definition at line 337 of file xmlutils.cpp.

                                                                                                     {
    string s = getChildValue(node, name, mandatory);
    return parseListOfValues(s, std::function<Period(string)>(&parsePeriod));
}

Here is the call graph for this function:

◆ getChildrenValuesAsStrings()

vector< string > getChildrenValuesAsStrings	(	XMLNode *	node,
		const string &	name,
		bool	mandatory = `false`
	)

static

Definition at line 342 of file xmlutils.cpp.

                                                                                                     {
    string s = getChildValue(node, name, mandatory);
    return parseListOfValues(s);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildrenValues() [2/2]

map< string, string > getChildrenValues	(	XMLNode *	node,
		const string &	names,
		const string &	name,
		const string &	firstName,
		const string &	secondName,
		bool	mandatory = `false`
	)

static

Definition at line 347 of file xmlutils.cpp.

                                                                                                                   {
    map<string, string> res;
    xml_node<>* node = parent->first_node(names.c_str());
    if (mandatory) {
        QL_REQUIRE(node, "Error: No XML Node " << names << " found.");
    }
    if (node) {
        for (xml_node<>* child = node->first_node(name.c_str()); child; child = child->next_sibling(name.c_str())) {
            string first = getChildValue(child, firstName, mandatory);
            string second = getChildValue(child, secondName, mandatory);
            // res[first] = second;
            res.insert(pair<string, string>(first, second));
        }
    }
    return res;
}

Here is the call graph for this function:

◆ getChildrenAttributesAndValues()

map< string, string > getChildrenAttributesAndValues	(	XMLNode *	parent,
		const string &	names,
		const string &	attributeName,
		bool	mandatory = `false`
	)

static

Definition at line 365 of file xmlutils.cpp.

                                                                                                          {
    map<string, string> res;
    for (XMLNode* child = getChildNode(parent, names.c_str()); child;
         child = XMLUtils::getNextSibling(child, names.c_str())) {
        string first = getAttribute(child, attributeName);
        string second = getNodeValue(child);
        if (first.empty())
            continue;
        auto it = res.find(first);
        if (it != res.end())
            WLOG("XMLUtils::getChildrenAttributesAndValues: Duplicate entry " << first <<
                " in node " << names << ". Overwritting with value " << second << ".");
        res.insert(pair<string, string>(first, second));
    }
    if (mandatory) {
        QL_REQUIRE(!res.empty(), "Error: No XML Node " << names << " found.");
    }
    return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildNode()

XMLNode * getChildNode	(	XMLNode *	n,
		const string &	name = `""`
	)

static

Definition at line 387 of file xmlutils.cpp.

                                                              {
    QL_REQUIRE(n, "XMLUtils::getChildNode(" << name << "): XML Node is NULL");
    return n->first_node(name == "" ? nullptr : name.c_str());
}

Here is the caller graph for this function:

◆ locateNode()

XMLNode * locateNode	(	XMLNode *	n,
		const string &	name = `""`
	)

static

Definition at line 393 of file xmlutils.cpp.

                                                            {
    QL_REQUIRE(n, "XMLUtils::locateNode(" << name << "): XML Node is NULL");
    if (n->name() == name)
        return n;
    else {
        const char* p = name.empty() ? nullptr : name.c_str();
        XMLNode* node = n->first_node(p);
        QL_REQUIRE(node, "XML node with name " << name << " not found");
        return node;
    }
}

Here is the caller graph for this function:

◆ appendNode()

void appendNode	(	XMLNode *	parent,
		XMLNode *	child
	)

static

Definition at line 406 of file xmlutils.cpp.

                                                         {
    QL_REQUIRE(parent, "XMLUtils::appendNode() parent is NULL");
    QL_REQUIRE(child, "XMLUtils::appendNode() child is NULL");
    parent->append_node(child);
}

Here is the caller graph for this function:

◆ addAttribute()

void addAttribute	(	XMLDocument &	doc,
		XMLNode *	node,
		const string &	attrName,
		const string &	attrValue
	)

static

Definition at line 412 of file xmlutils.cpp.

                                                                                                            {
    QL_REQUIRE(node, "XMLUtils::appendAttribute(" << attrName << "," << attrName << ") node is NULL");
    char* name = doc.allocString(attrName.c_str());
    char* value = doc.allocString(attrValue.c_str());
    node->append_attribute(doc.doc()->allocate_attribute(name, value));
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAttribute()

string getAttribute	(	XMLNode *	node,
		const string &	attrName
	)

static

Definition at line 419 of file xmlutils.cpp.

                                                                   {
    QL_REQUIRE(node, "XMLUtils::getAttribute(" << attrName << ") node is NULL");
    xml_attribute<>* attr = node->first_attribute(attrName.c_str());
    if (attr && attr->value())
        return string(attr->value());
    else
        return "";
}

Here is the caller graph for this function:

◆ getChildrenNodes()

vector< XMLNode * > getChildrenNodes	(	XMLNode *	node,
		const string &	name
	)

static

Returns all the children with a given name.

Definition at line 428 of file xmlutils.cpp.

                                                                             {
    QL_REQUIRE(node, "XMLUtils::getChildrenNodes(" << name << ") node is NULL");
    vector<XMLNode*> res;
    const char* p = name.empty() ? nullptr : name.c_str();
    for (xml_node<>* c = node->first_node(p); c; c = c->next_sibling(p))
        res.push_back(c);
    return res;
}

Here is the caller graph for this function:

◆ getChildrenNodesWithAttributes() [1/2]

vector< XMLNode * > getChildrenNodesWithAttributes	(	XMLNode *	node,
		const string &	names,
		const string &	name,
		const string &	attrName,
		vector< string > &	attrs,
		bool	mandatory = `false`
	)

static

Definition at line 437 of file xmlutils.cpp.

                                                                          {
    std::vector<std::reference_wrapper<vector<string>>> attrs_v;
    attrs_v.push_back(attrs);
    return getChildrenNodesWithAttributes(parent, names, name, {attrName}, attrs_v, mandatory);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildrenNodesWithAttributes() [2/2]

vector< XMLNode * > getChildrenNodesWithAttributes	(	XMLNode *	node,
		const string &	names,
		const string &	name,
		const vector< string > &	attrNames,
		const vector< std::reference_wrapper< vector< string > > > &	attrs,
		bool	mandatory = `false`
	)

static

Definition at line 445 of file xmlutils.cpp.

                                                                          {
    QL_REQUIRE(attrNames.size() == attrs.size(),
               "attrNames size (" << attrNames.size() << ") must match attrs size (" << attrs.size() << ")");
    vector<XMLNode*> vec;
    // if names is empty, use the parent as the anchor node
    rapidxml::xml_node<>* node = names.empty() ? parent : parent->first_node(names.c_str());
    if (mandatory) {
        QL_REQUIRE(node, "Error: No XML Node " << names << " found.");
    }
    if (node) {
        for (rapidxml::xml_node<>* child = node->first_node(name.c_str()); child;
             child = child->next_sibling(name.c_str())) {
            vec.push_back(child);
            for (Size i = 0; i < attrNames.size(); ++i) {
                xml_attribute<>* attr = child->first_attribute(attrNames[i].c_str());
                if (attr && attr->value())
                    ((vector<string>&)attrs[i]).push_back(attr->value());
                else
                    ((vector<string>&)attrs[i]).push_back("");
            }
        }
    }
    return vec;
}

◆ getNodeName()

string getNodeName ( XMLNode * n )

static

Get and set a node's name.

Definition at line 473 of file xmlutils.cpp.

                                          {
    QL_REQUIRE(node, "XMLUtils::getNodeName(): XML Node is NULL");
    return node->name();
}

Here is the caller graph for this function:

◆ setNodeName()

void setNodeName	(	XMLDocument &	doc,
		XMLNode *	node,
		const string &	name
	)

static

Definition at line 478 of file xmlutils.cpp.

                                                                              {
    QL_REQUIRE(node, "XMLUtils::setNodeName(" << name << "): XML Node is NULL");
    char* nodeName = doc.allocString(name);
    node->name(nodeName);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNextSibling()

XMLNode * getNextSibling	(	XMLNode *	node,
		const string &	name = `""`
	)

static

Get a node's next sibling node.

Definition at line 484 of file xmlutils.cpp.

                                                                   {
    QL_REQUIRE(node, "XMLUtils::getNextSibling(" << name << "): XML Node is NULL");
    return node->next_sibling(name == "" ? nullptr : name.c_str());
}

Here is the caller graph for this function:

◆ getNodeValue()

string getNodeValue ( XMLNode * node )

static

Get a node's value.

Definition at line 489 of file xmlutils.cpp.

                                           {
    QL_REQUIRE(node, "XMLUtils::getNodeValue(): XML Node is NULL");
    // handle CDATA nodes
    XMLNode* n = node->first_node();
    if (n && n->type() == node_cdata)
        return n->value();
    // all other cases
    return node->value();
}

Here is the caller graph for this function:

◆ getNodeValueAsDoublesCompact()

vector< Real > getNodeValueAsDoublesCompact ( XMLNode * node )

static

Get a node's compact values as vector of doubles.

Definition at line 332 of file xmlutils.cpp.

                                                                 {
    string s = getNodeValue(node);
    return parseListOfValues(s, std::function<Real(string)>(&parseReal));
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString()

string toString ( XMLNode * node )

static

Write a node out as a string.

Definition at line 714 of file xmlutils.cpp.

                                       {
    string xml_as_string;
    rapidxml::print(std::back_inserter(xml_as_string), *node);
    return xml_as_string;
}

Here is the caller graph for this function:

◆ convertToString() [1/2]

string convertToString ( const Real value )

static

Definition at line 620 of file xmlutils.cpp.

                                                 {
    // We want to write out a double that conforms to xs:double, this means no
    // scientific notation, so we check for really small numbers here and explicitly set
    // to 16 decimal places
    string result;
    if (std::abs(value) < 1.0e-6) {
        std::ostringstream obj1;
        obj1.precision(16);
        obj1 << std::fixed << value;
        result = obj1.str();
    } else {
        // And here we just use boost::lexical_cast which is better
        // at precision than std::to_string()
        result = boost::lexical_cast<std::string>(value);
    }
    return result;
}

Here is the caller graph for this function:

◆ convertToString() [2/2]

string convertToString ( const T & value )

static

Definition at line 638 of file xmlutils.cpp.

638{ return boost::lexical_cast<std::string>(value); }

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ checkNode()

◆ addChild() [1/10]

◆ addChild() [2/10]

◆ addChildAsCdata()

◆ addChild() [3/10]

◆ addChild() [4/10]

◆ addChild() [5/10]

◆ addChild() [6/10]

◆ addChild() [7/10]

◆ addChild() [8/10]

◆ addChild() [9/10]

◆ addGenericChild()

◆ addGenericChildAsList()

◆ addChildren() [1/2]

◆ addChild() [10/10]

◆ addChildrenWithAttributes() [1/2]

◆ addChildrenWithAttributes() [2/2]

◆ addChildrenWithOptionalAttributes() [1/2]

◆ addChildrenWithOptionalAttributes() [2/2]

◆ addChildren() [2/2]

◆ getChildValue()

◆ getChildValueAsDouble()

◆ getChildValueAsInt()

◆ getChildValueAsBool()

◆ getChildValueAsPeriod()

◆ getChildrenValues() [1/2]

◆ getChildrenValuesWithAttributes() [1/4]

◆ getChildrenValuesWithAttributes() [2/4]

◆ getChildrenValuesWithAttributes() [3/4]

◆ getChildrenValuesWithAttributes() [4/4]

◆ getChildrenValuesAsDoubles()

◆ getChildrenValuesAsDoublesCompact()

◆ getChildrenValuesAsPeriods()

◆ getChildrenValuesAsStrings()

◆ getChildrenValues() [2/2]

◆ getChildrenAttributesAndValues()

◆ getChildNode()

◆ locateNode()

◆ appendNode()

◆ addAttribute()

◆ getAttribute()

◆ getChildrenNodes()

◆ getChildrenNodesWithAttributes() [1/2]

◆ getChildrenNodesWithAttributes() [2/2]

◆ getNodeName()

◆ setNodeName()

◆ getNextSibling()

◆ getNodeValue()

◆ getNodeValueAsDoublesCompact()

◆ toString()

◆ convertToString() [1/2]

◆ convertToString() [2/2]