Scalar parameter with an expected value range. More...
#include <mia/core/parameter.hh>
Inheritance diagram for TRangeParameter< T >:
Public Member Functions | |
| TRangeParameter (T &value, T min, T max, bool required, const char *descr) | |
 Public Member Functions inherited from CTParameter< T > | |
| CTParameter (T &value, bool required, const char *descr) | |
| Public Member Functions inherited from CParameter | |
| void | add_dependend_handler (HandlerHelpMap &handler_map) const |
| CParameter (const char type[], bool required, const char *descr) | |
| void | descr (std::ostream &os) const |
| std::string | get_default_value () const |
| const char * | get_descr () const |
| void | get_help_xml (xmlpp::Element &root) const |
| std::string | get_value_as_string () const |
| virtual void | post_set () |
| bool | required_set () const |
| void | reset () |
| bool | set (const std::string &str_value) |
| const char * | type () const |
| void | value (std::ostream &os) const |
| virtual | ~CParameter () |
Protected Member Functions | |
| void | do_descr (std::ostream &os) const |
| Protected Member Functions inherited from CParameter | |
| const std::string | errmsg (const std::string &err_value) const |
| create an error message by using the given value that raises the error More... | |
Detailed Description
template<typename T>
class TRangeParameter< T >
Scalar parameter with an expected value range.
A scalar parameter that supports a bracketing range. If the user tries to set the parameter to a value outside the range, the set method will throw an invalid_argument exception
Definition at line 197 of file parameter.hh.
Constructor & Destructor Documentation
template<typename T >
| TRangeParameter< T >::TRangeParameter | ( | T & | value, |
| T | min, | ||
| T | max, | ||
| bool | required, | ||
| const char * | descr | ||
| ) |
Constructor
- Parameters
-
value reference to the parameter handled by this parameter object min minimum of the parameter value range max maximum of the parameter value range required set to true if the parameter has to be set by the user descr a description of the parameter
Member Function Documentation
template<typename T >
|
protectedvirtual |
the implementation of the description-function
Reimplemented from CTParameter< T >.
The documentation for this class was generated from the following file:
