cee::ug::ResultCalculatorParams Class Reference

Parameters for a given result calculator. More...

Public Member Functions

 ResultCalculatorParams ()
 Constructor. More...
 
bool hasKey (const Str &key) const
 Returns true of if the given key is a parameter in the result calculator. More...
 
double value (const Str &key) const
 Returns the value of the parameter with the given key. More...
 
void setValue (const Str &key, double value)
 Sets the parameter with name key to the given value. More...
 
std::vector< StrkeyArray () const
 Returns an array with all the keys the result calculator supports. More...
 

Detailed Description

Parameters for a given result calculator.

Allows the user to specify parameters with a name (string) and a value (double) to a result calculator. The supported parameters from a result calculator will be exposed by the plugin and can be queried with the keyArray() method.

Constructor & Destructor Documentation

cee::ug::ResultCalculatorParams::ResultCalculatorParams ( )

Constructor.

Member Function Documentation

bool cee::ug::ResultCalculatorParams::hasKey ( const Str key) const

Returns true of if the given key is a parameter in the result calculator.

std::vector< Str > cee::ug::ResultCalculatorParams::keyArray ( ) const

Returns an array with all the keys the result calculator supports.

void cee::ug::ResultCalculatorParams::setValue ( const Str key,
double  value 
)

Sets the parameter with name key to the given value.

double cee::ug::ResultCalculatorParams::value ( const Str key) const

Returns the value of the parameter with the given key.

Will return cee::UNDEFINED_DOUBLE if key is not a parameter