Parameters Class Reference

Provides the input data and references to input files used in OREApp. More...

#include <orea/app/parameters.hpp>

Inheritance diagram for Parameters:

Collaboration diagram for Parameters:

Public Member Functions
	Parameters ()
void	clear ()
void	fromFile (const string &)
virtual void	fromXML (XMLNode *node) override
virtual XMLNode *	toXML (XMLDocument &doc) const override
bool	hasGroup (const string &groupName) const
bool	has (const string &groupName, const string &paramName) const
string	get (const string &groupName, const string &paramName, bool fail=true) const
const map< string, string > &	data (const string &groupName) const
const map< string, string > &	markets () const
void	log ()
Public Member Functions inherited from XMLSerializable
virtual	~XMLSerializable ()
virtual void	fromXML (XMLNode *node)=0
virtual XMLNode *	toXML (XMLDocument &doc) const=0
void	fromFile (const std::string &filename)
void	toFile (const std::string &filename) const
void	fromXMLString (const std::string &xml)
std::string	toXMLString () const

Private Attributes
map< string, map< string, string > >	data_

Detailed Description

Provides the input data and references to input files used in OREApp.

Definition at line 40 of file parameters.hpp.

Constructor & Destructor Documentation

Parameters()

Parameters

(

)

Definition at line 42 of file parameters.hpp.

{}

Member Function Documentation

clear()

void clear

(

)

Definition at line 73 of file parameters.cpp.

{ data_.clear(); }

Here is the caller graph for this function:

fromFile()

void fromFile

(

const string &

fileName

)

Definition at line 65 of file parameters.cpp.

                                                {
    LOG("load ORE configuration from " << fileName);
    clear();
    XMLDocument doc(fileName);
    fromXML(doc.getFirstNode("ORE"));
    LOG("load ORE configuration from " << fileName << " done.");
}

Here is the call graph for this function:

fromXML()

void fromXML ( XMLNode *  node )

overridevirtual

Implements XMLSerializable.

Definition at line 75 of file parameters.cpp.

                                      {
    XMLUtils::checkNode(node, "ORE");
 
    XMLNode* setupNode = XMLUtils::getChildNode(node, "Setup");
    QL_REQUIRE(setupNode, "node Setup not found in parameter file");
    map<string, string> setupMap;
    for (XMLNode* child = XMLUtils::getChildNode(setupNode); child; child = XMLUtils::getNextSibling(child)) {
        string key = XMLUtils::getAttribute(child, "name");
        string value = XMLUtils::getNodeValue(child);
        setupMap[key] = value;
    }
    data_["setup"] = setupMap;
 
    XMLNode* loggingNode = XMLUtils::getChildNode(node, "Logging");
    if (loggingNode) {
        map<string, string> loggingMap;
        for (XMLNode* child = XMLUtils::getChildNode(loggingNode); child; child = XMLUtils::getNextSibling(child)) {
            string key = XMLUtils::getAttribute(child, "name");
            string value = XMLUtils::getNodeValue(child);
            loggingMap[key] = value;
        }
        data_["logging"] = loggingMap;
    }
 
    XMLNode* marketsNode = XMLUtils::getChildNode(node, "Markets");
    if (marketsNode) {
        map<string, string> marketsMap;
        for (XMLNode* child = XMLUtils::getChildNode(marketsNode); child; child = XMLUtils::getNextSibling(child)) {
            string key = XMLUtils::getAttribute(child, "name");
            string value = XMLUtils::getNodeValue(child);
            marketsMap[key] = value;
        }
        data_["markets"] = marketsMap;
    }
 
    XMLNode* analyticsNode = XMLUtils::getChildNode(node, "Analytics");
    if (analyticsNode) {
        for (XMLNode* child = XMLUtils::getChildNode(analyticsNode); child; child = XMLUtils::getNextSibling(child)) {
            string groupName = XMLUtils::getAttribute(child, "type");
            map<string, string> analyticsMap;
            for (XMLNode* paramNode = XMLUtils::getChildNode(child); paramNode;
                 paramNode = XMLUtils::getNextSibling(paramNode)) {
                string key = XMLUtils::getAttribute(paramNode, "name");
                string value = XMLUtils::getNodeValue(paramNode);
                analyticsMap[key] = value;
            }
            data_[groupName] = analyticsMap;
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

toXML()

XMLNode * toXML ( XMLDocument &  doc ) const

overridevirtual

Implements XMLSerializable.

Definition at line 126 of file parameters.cpp.

                                                 {
    XMLNode* node = doc.allocNode("ORE");
    QL_FAIL("Parameters::toXML not implemented yet");
    return node;
}

Here is the call graph for this function:

hasGroup()

bool hasGroup

(

const string &

groupName

)

const

Definition at line 32 of file parameters.cpp.

{ return (data_.find(groupName) != data_.end()); }

Here is the caller graph for this function:

has()

bool has	(	const string &	groupName,
		const string &	paramName
	)		const

Definition at line 34 of file parameters.cpp.

                                                                           {
    QL_REQUIRE(hasGroup(groupName), "param group '" << groupName << "' not found");
    auto it = data_.find(groupName);
    return (it->second.find(paramName) != it->second.end());
}

Here is the call graph for this function:

Here is the caller graph for this function:

get()

string get	(	const string &	groupName,
		const string &	paramName,
		bool	fail = true
	)		const

Definition at line 40 of file parameters.cpp.

                                                                                        {
    if (fail) {    
        QL_REQUIRE(has(groupName, paramName), "parameter " << paramName << " not found in param group " << groupName);
        auto it = data_.find(groupName);
        return it->second.find(paramName)->second;
    } else {
        if (!hasGroup(groupName) || !has(groupName,paramName))
            return "";
        else {
            auto it = data_.find(groupName);
            return it->second.find(paramName)->second;
        }
    }
}

Here is the call graph for this function:

data()

const map< string, string > & data

(

const string &

groupName

)

const

Definition at line 55 of file parameters.cpp.

                                                                         {
    auto it = data_.find(groupName);
    QL_REQUIRE(it != data_.end(), "param group '" << groupName << "' not found");
    return it->second;
}

Here is the caller graph for this function:

markets()

const map< string, string > & markets

(

)

const

Definition at line 61 of file parameters.cpp.

                                                     {
    return data("markets");
}

Here is the call graph for this function:

log()

void log

(

)

Definition at line 132 of file parameters.cpp.

                     {
    LOG("Parameters:");
    for (auto p : data_)
        for (auto pp : p.second)
            LOG("group = " << p.first << " : " << pp.first << " = " << pp.second);
}

Member Data Documentation

data_

map<string, map<string, string> > data_

private

Definition at line 58 of file parameters.hpp.