An object that implements NameValuePairs.
More...
|
| AlgorithmParameters () |
| Construct a AlgorithmParameters. More...
|
|
| AlgorithmParameters (const AlgorithmParameters &x) |
|
AlgorithmParameters & | operator= (const AlgorithmParameters &x) |
|
template<class T > |
AlgorithmParameters & | operator() (const char *name, const T &value, bool throwIfNotUsed) |
|
template<class T > |
AlgorithmParameters & | operator() (const char *name, const T &value) |
| Appends a NameValuePair to a collection of NameValuePairs. More...
|
|
bool | GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const |
| Get a named value. More...
|
|
template<class T > |
bool | GetThisObject (T &object) const |
| Get a copy of this object or subobject. More...
|
|
template<class T > |
bool | GetThisPointer (T *&ptr) const |
| Get a pointer to this object. More...
|
|
template<class T > |
bool | GetValue (const char *name, T &value) const |
| Get a named value. More...
|
|
template<class T > |
T | GetValueWithDefault (const char *name, T defaultValue) const |
| Get a named value. More...
|
|
std::string | GetValueNames () const |
| Get a list of value names that can be retrieved. More...
|
|
bool | GetIntValue (const char *name, int &value) const |
| Get a named value with type int. More...
|
|
int | GetIntValueWithDefault (const char *name, int defaultValue) const |
| Get a named value with type int, with default. More...
|
|
template<class T > |
void | GetRequiredParameter (const char *className, const char *name, T &value) const |
| Retrieves a required name/value pair. More...
|
|
void | GetRequiredIntParameter (const char *className, const char *name, int &value) const |
| Retrieves a required name/value pair. More...
|
|
|
static void | ThrowIfTypeMismatch (const char *name, const std::type_info &stored, const std::type_info &retrieving) |
| Ensures an expected name and type is present. More...
|
|
An object that implements NameValuePairs.
- Note
- A NameValuePairs object containing an arbitrary number of name value pairs may be constructed by repeatedly using operator() on the object returned by MakeParameters, for example:
AlgorithmParameters parameters = MakeParameters(name1, value1)(name2, value2)(name3, value3);
Definition at line 419 of file algparam.h.
◆ AlgorithmParameters()
AlgorithmParameters::AlgorithmParameters |
( |
| ) |
|
Construct a AlgorithmParameters.
- Note
- A NameValuePairs object containing an arbitrary number of name value pairs may be constructed by repeatedly using operator() on the object returned by MakeParameters, for example:
AlgorithmParameters parameters = MakeParameters(name1, value1)(name2, value2)(name3, value3);
Definition at line 48 of file algparam.cpp.
◆ operator()() [1/2]
template<class T >
AlgorithmParameters& AlgorithmParameters::operator() |
( |
const char * |
name, |
|
|
const T & |
value, |
|
|
bool |
throwIfNotUsed |
|
) |
| |
|
inline |
- Template Parameters
-
- Parameters
-
name | the name of the object or value to retrieve |
value | reference to a variable that receives the value |
throwIfNotUsed | if true, the object will throw an exception if the value is not accessed |
Definition at line 460 of file algparam.h.
◆ operator()() [2/2]
Appends a NameValuePair to a collection of NameValuePairs.
- Template Parameters
-
- Parameters
-
name | the name of the object or value to retrieve |
value | reference to a variable that receives the value |
Definition at line 474 of file algparam.h.
◆ GetVoidValue()
bool AlgorithmParameters::GetVoidValue |
( |
const char * |
name, |
|
|
const std::type_info & |
valueType, |
|
|
void * |
pValue |
|
) |
| const |
|
virtual |
The documentation for this class was generated from the following files: