Public Member Functions | Protected Member Functions
TRangeParameter< T > Class Template Reference

Scalar parameter with an expected value range. More...

#include <mia/core/parameter.hh>

Inheritance diagram for TRangeParameter< T >:
CTParameter< T > CParameter

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
 

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,
min,
max,
bool  required,
const char *  descr 
)

Constructor

Parameters
valuereference to the parameter handled by this parameter object
minminimum of the parameter value range
maxmaximum of the parameter value range
requiredset to true if the parameter has to be set by the user
descra description of the parameter

Member Function Documentation

template<typename T >
void TRangeParameter< T >::do_descr ( std::ostream &  os) const
protectedvirtual

the implementation of the description-function

Reimplemented from CTParameter< T >.


The documentation for this class was generated from the following file: