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

A parameter that can assume any value of the given value type. More...

#include <mia/core/parameter.hh>

Inheritance diagram for TParameter< T >:
CParameter

Public Member Functions

 TParameter (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

virtual 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 TParameter< T >

A parameter that can assume any value of the given value type.

This parameter type is used for parameters that are only restricted by the value type T that must be streamable.

Template Parameters
Ttype of the parameter value

Definition at line 370 of file parameter.hh.

Constructor & Destructor Documentation

template<typename T >
TParameter< T >::TParameter ( T &  value,
bool  required,
const char *  descr 
)

Constructor

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

Definition at line 729 of file parameter.hh.

Member Function Documentation

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

the implementation of the description-function

Implements CParameter.

Definition at line 739 of file parameter.hh.


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