|
Main Page Modules Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages
easylocal::ParameterBox Class Reference#include <EasyLocal.h>
Collaboration diagram for easylocal::ParameterBox:
[legend]List of all members.Public Methods
- void Put (std::string name, std::string type, ValueType value)
- void Put (std::string name, unsigned long value)
- void Put (std::string name, unsigned int value)
- void Put (std::string name, double value)
- void Get (std::string name, std::string type, ValueType &value) const
- void Get (std::string name, unsigned long &value) const
- void Get (std::string name, unsigned int &value) const
- void Get (std::string name, double &value) const
- void Clear ()
Protected Attributes
Detailed Description
A paramter box maintains a list of parameters that could be passed to a runner.
Definition at line 462 of file EasyLocal.h.
Member Function Documentation
void easylocal::ParameterBox::Clear (
|
)
|
|
|
Deletes all the parameters stored in the parameter box.
Definition at line 267 of file EasyLocal.cpp. |
void easylocal::ParameterBox::Get (
|
std::string name,
|
|
double & value ) const
|
|
|
Retrieves the value of a double parameter. -
Parameters:
-
name
|
the name of the parameter to be retrieved |
value
|
the value of the parameter |
Definition at line 251 of file EasyLocal.cpp. |
void easylocal::ParameterBox::Get (
|
std::string name,
|
|
unsigned int & value ) const
|
|
|
Retrieves the value of a unsigned int parameter. -
Parameters:
-
name
|
the name of the parameter to be retrieved |
value
|
the value of the parameter |
Definition at line 232 of file EasyLocal.cpp. |
void easylocal::ParameterBox::Get (
|
std::string name,
|
|
unsigned long & value ) const
|
|
|
Retrieves the value of a unsigned long parameter. -
Parameters:
-
name
|
the name of the parameter to be retrieved |
value
|
the value of the parameter |
Definition at line 213 of file EasyLocal.cpp. |
void easylocal::ParameterBox::Get (
|
std::string name,
|
|
std::string type,
|
|
ValueType & value ) const
|
|
|
Retrieves the value of the given parameter and checks whether it has the right type. -
Parameters:
-
name
|
the name of the parameter to be retrieved |
type
|
the type of the parameter to be retrieved |
value
|
the value of the retrieved parameter |
Definition at line 194 of file EasyLocal.cpp. |
void easylocal::ParameterBox::Put (
|
std::string name,
|
|
double value )
|
|
|
Adds a parameter of type double to a parameter box. -
Parameters:
-
name
|
the name of the parameter |
value
|
the value of the parameter |
Definition at line 179 of file EasyLocal.cpp. |
void easylocal::ParameterBox::Put (
|
std::string name,
|
|
unsigned int value )
|
|
|
Adds a parameter of type unsigned int to a parameter box. -
Parameters:
-
name
|
the name of the parameter |
value
|
the value of the parameter |
Definition at line 166 of file EasyLocal.cpp. |
void easylocal::ParameterBox::Put (
|
std::string name,
|
|
unsigned long value )
|
|
|
Adds a parameter of type unsigned long to a parameter box. -
Parameters:
-
name
|
the name of the parameter |
value
|
the value of the parameter |
Definition at line 153 of file EasyLocal.cpp. |
void easylocal::ParameterBox::Put (
|
std::string name,
|
|
std::string type,
|
|
ValueType value )
|
|
|
Adds a parameter of a given type to a parameter box. -
Parameters:
-
name
|
the name of the parameter |
type
|
the type of the parameter |
value
|
the value of the parameter |
Definition at line 144 of file EasyLocal.cpp. |
Member Data Documentation
std::list< ParameterData > easylocal::ParameterBox::parameters [protected]
|
|
|
The list of parameters contained in the parameter box.
Definition at line 475 of file EasyLocal.h. |
The documentation for this class was generated from the following files:
|