ASL
0.1.7
Advanced Simulation Library
|
#include <aslParametersManager.h>
Public Member Functions | |
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 () |
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!
Definition at line 44 of file aslParametersManager.h.
asl::Parameter< T >::Parameter | ( | const char * | key_, |
const char * | description_, | ||
const char * | units_ = "" |
||
) |
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. Use "" to provide a vector asl::AVec<T> through command line, e.g.: –size "30 20 50"
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).
|
inline |
Definition at line 190 of file aslParametersManager.h.
|
inline |
Definition at line 179 of file aslParametersManager.h.
|
inline |
Definition at line 185 of file aslParametersManager.h.