Public Member Functions | Protected Member Functions
CTParameter< T > Class Template Reference
Command line and parameter parsing

Generic type of a complex paramter. More...

#include <mia/core/parameter.hh>

Inheritance diagram for CTParameter< T >:
[legend]
Collaboration diagram for CTParameter< T >:
[legend]

Public Member Functions

 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 (CXMLElement &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
void add_xmlhelp_attribute (CXMLElement &node, const std::string &tag, const std::string &value) const
 
CXMLElement & add_xmlhelp_childnode (CXMLElement &parent, const std::string &tag) const
 
void add_xmlhelp_text (CXMLElement &node, const std::string &value) const
 
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 CTParameter< T >

Generic type of a complex paramter.

The (templated) typed parameter. There needs to be defined an operator << (istream& is, T& x) for the do_set method to work.

Definition at line 169 of file parameter.hh.

Constructor & Destructor Documentation

◆ CTParameter()

template<typename T>
CTParameter< T >::CTParameter ( 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

Member Function Documentation

◆ do_descr()

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

the implementation of the description-function

Implements CParameter.

Reimplemented in TBoundedParameter< T >.

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