#include <aslParametersManager.h>
|
| Parameter (const char *key_, const char *description_, const char *units_="") |
|
| Parameter (T defaultValue, const char *key_, const char *description_, const char *units_="") |
|
const T & | v () const |
|
T & | v () |
|
std::shared_ptr< T > | p () |
|
| Parameter (const char *key_, const char *description_, const char *units_="") |
|
| Parameter (T defaultValue, const char *key_, const char *description_, const char *units_="") |
|
const T & | v () const |
|
T & | v () |
|
std::shared_ptr< T > | p () |
|
template<typename T>
class asl::Parameter< T >
This class stores parameter's value and the information needed to extract it from command line and/or parameters file. Important: declare Parameters only after declaring ParametersManager or ApplicationParametersManager instance and before calling ParametersManager::load() because each Parameter adds itself to the instance automatically!
- Examples:
- bus_wind.cc, compressor.cc, cubeGravity.cc, cubeIncompressibleGravity.cc, cubePoroelasticGravity.cc, jumpingBox.cc, levelSetBasic.cc, levelSetFacetedGrowth.cc, levelSetNormalGrowth.cc, locomotive.cc, locomotive_laminar.cc, locomotive_stability.cc, and poroelastic.cc.
Definition at line 44 of file aslParametersManager.h.
key_
- option key; is used to specify this parameter through command line and/or parameters file. description_
is used in the help output and as comment on parameters file generation. units_
- parameter units; is used to complement the option description mentioned above. Might be used for automatic unit conversion in future (to this end it is recommended to use the notation of the Boost::Units library). Since no default value is specified, the parameter is required to be specified in the parameters file or command line.
template<typename T>
asl::Parameter< T >::Parameter |
( |
T |
defaultValue, |
|
|
const char * |
key_, |
|
|
const char * |
description_, |
|
|
const char * |
units_ = "" |
|
) |
| |
defaultValue
- default parameter value. Since a default value is specified, the parameter is not required to be specified in the parameters file or command line. key_
- option key; is used to specify this parameter through command line and/or parameters file. description_
is used in the help output and as comment on parameters file generation. units_
- parameter units; is used to complement the option description mentioned above. Might be used for automatic unit conversion in future (to this end it is recommended to use the notation of the Boost::Units library).
key_
- option key; is used to specify this parameter through command line and/or parameters file. description_
is used in the help output and as comment on parameters file generation. units_
- parameter units; is used to complement the option description mentioned above. Might be used for automatic unit conversion in future (to this end it is recommended to use the notation of the Boost::Units library). Since no default value is specified, the parameter is required to be specified in the parameters file or command line.
template<typename T>
asl::Parameter< T >::Parameter |
( |
T |
defaultValue, |
|
|
const char * |
key_, |
|
|
const char * |
description_, |
|
|
const char * |
units_ = "" |
|
) |
| |
defaultValue
- default parameter value. Since a default value is specified, the parameter is not required to be specified in the parameters file or command line. key_
- option key; is used to specify this parameter through command line and/or parameters file. description_
is used in the help output and as comment on parameters file generation. units_
- parameter units; is used to complement the option description mentioned above. Might be used for automatic unit conversion in future (to this end it is recommended to use the notation of the Boost::Units library).
The documentation for this class was generated from the following file: