CDictParameter< T > Class Template Reference
Dictionary parameter. More...
#include <mia/core/parameter.hh>
Inheritance diagram for CDictParameter< T >:
Collaboration diagram for CDictParameter< T >:
Public Member Functions | |
| CDictParameter (T &value, const TDictMap< T > &dict, const char *descr, bool required=false) | |
 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 CDictParameter< T >
Dictionary parameter.
The (templated) parameter that takes its value froma restricted Dictionary.
- Template Parameters
-
the enumerate that is used by the dictionary
Definition at line 364 of file parameter.hh.
Constructor & Destructor Documentation
◆ CDictParameter()
template<typename T >
| CDictParameter< T >::CDictParameter | ( | T & | value, |
| const TDictMap< T > & | dict, | ||
| const char * | descr, | ||
| bool | required = false |
||
| ) |
Constructor
- Parameters
-
value reference to the parameter handled by this parameter object dict dictionary for parameter translation descr a description of the parameter required set if this parameter must be set by the end user
Definition at line 674 of file parameter.hh.
Member Function Documentation
◆ do_descr()
template<typename T >
|
protectedvirtual |
the implementation of the description-function
Implements CParameter.
Definition at line 683 of file parameter.hh.
References CParameter::add_xmlhelp_attribute(), CParameter::add_xmlhelp_childnode(), CParameter::add_xmlhelp_text(), and TRACE_FUNCTION.
The documentation for this class was generated from the following file:
