Alsvinn  0.5.3
The fast FVM simulator with UQ support
Public Member Functions | Static Public Member Functions | List of all members
alsutils::parameters::Parameters Class Reference

Holds general parameters based on a boost::property tree. More...

#include <alsutils/parameters/Parameters.hpp>

Inheritance diagram for alsutils::parameters::Parameters:
alsuq::stats::StatisticsParameters

Public Member Functions

 Parameters (const boost::property_tree::ptree &ptree)
 
 Parameters (const std::map< std::string, std::string > &values)
 
double getDouble (const std::string &name) const
 
int getInteger (const std::string &name) const
 
std::string getString (const std::string &name) const
 
bool contains (const std::string &name) const
 
std::vector< std::string > getStringVectorFromString (const std::string &name) const
 
std::vector< std::string > getKeys () const
 
void addIntegerParameter (const std::string &name, int i)
 
void addDoubleParameter (const std::string &name, double i)
 
void addStringParameter (const std::string &name, std::string value)
 
void addVectorParameter (const std::string &name, const std::vector< std::string > &values)
 

Static Public Member Functions

static Parameters empty ()
 Returns an empty parameter instance, when you don't want to give any parameters. More...
 

Detailed Description

Holds general parameters based on a boost::property tree.

Constructor & Destructor Documentation

◆ Parameters() [1/2]

alsutils::parameters::Parameters::Parameters ( const boost::property_tree::ptree &  ptree)

◆ Parameters() [2/2]

alsutils::parameters::Parameters::Parameters ( const std::map< std::string, std::string > &  values)

Convenience constructor. Used mostly for unittesting.

Member Function Documentation

◆ addDoubleParameter()

void alsutils::parameters::Parameters::addDoubleParameter ( const std::string &  name,
double  i 
)

◆ addIntegerParameter()

void alsutils::parameters::Parameters::addIntegerParameter ( const std::string &  name,
int  i 
)

◆ addStringParameter()

void alsutils::parameters::Parameters::addStringParameter ( const std::string &  name,
std::string  value 
)

◆ addVectorParameter()

void alsutils::parameters::Parameters::addVectorParameter ( const std::string &  name,
const std::vector< std::string > &  values 
)

◆ contains()

bool alsutils::parameters::Parameters::contains ( const std::string &  name) const

◆ empty()

Parameters alsutils::parameters::Parameters::empty ( )
static

Returns an empty parameter instance, when you don't want to give any parameters.

◆ getDouble()

double alsutils::parameters::Parameters::getDouble ( const std::string &  name) const

◆ getInteger()

int alsutils::parameters::Parameters::getInteger ( const std::string &  name) const

◆ getKeys()

std::vector< std::string > alsutils::parameters::Parameters::getKeys ( ) const

◆ getString()

std::string alsutils::parameters::Parameters::getString ( const std::string &  name) const

◆ getStringVectorFromString()

std::vector< std::string > alsutils::parameters::Parameters::getStringVectorFromString ( const std::string &  name) const

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