Public Member Functions | Protected Attributes | List of all members
icl_core::config::ConfigEnum< T > Class Template Reference

#include <ConfigEnum.h>

Inheritance diagram for icl_core::config::ConfigEnum< T >:
Inheritance graph
[legend]

Public Member Functions

 ConfigEnum (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToRef value, const char *const *descriptions, const char *end_marker=NULL)
 
virtual bool get (std::string const &prefix, icl_core::logging::LogStream &log_stream) const
 
virtual icl_core::String key () const
 
virtual icl_core::String stringValue () const
 
virtual ~ConfigEnum ()
 
- Public Member Functions inherited from icl_core::config::impl::ConfigValueIface
virtual ~ConfigValueIface ()
 

Protected Attributes

const char *const * m_descriptions
 
const char * m_end_marker
 
icl_core::String m_key
 
icl_core::String m_str_value
 
icl_core::ConvertToRef< T >::ToRef m_value
 

Detailed Description

template<typename T>
class icl_core::config::ConfigEnum< T >

Typed "container" class for batch reading of configuration parameters.

Definition at line 42 of file ConfigEnum.h.

Constructor & Destructor Documentation

template<typename T >
icl_core::config::ConfigEnum< T >::ConfigEnum ( const icl_core::String key,
typename icl_core::ConvertToRef< T >::ToRef  value,
const char *const *  descriptions,
const char *  end_marker = NULL 
)
inline

Create a placeholder for later batch reading of configuration parameters.

Definition at line 48 of file ConfigEnum.h.

template<typename T >
virtual icl_core::config::ConfigEnum< T >::~ConfigEnum ( )
inlinevirtual

We need a virtual destructor!

Definition at line 60 of file ConfigEnum.h.

Member Function Documentation

template<typename T >
virtual bool icl_core::config::ConfigEnum< T >::get ( std::string const &  prefix,
icl_core::logging::LogStream log_stream 
) const
inlinevirtual

Actually read the configuration parameter.

Implements icl_core::config::impl::ConfigValueIface.

Reimplemented in icl_core::config::ConfigEnumDefault< T >.

Definition at line 64 of file ConfigEnum.h.

template<typename T >
virtual icl_core::String icl_core::config::ConfigEnum< T >::key ( ) const
inlinevirtual

Return the configuration key.

Implements icl_core::config::impl::ConfigValueIface.

Definition at line 87 of file ConfigEnum.h.

template<typename T >
virtual icl_core::String icl_core::config::ConfigEnum< T >::stringValue ( ) const
inlinevirtual

Return the value as string.

Implements icl_core::config::impl::ConfigValueIface.

Definition at line 94 of file ConfigEnum.h.

Member Data Documentation

template<typename T >
const char* const* icl_core::config::ConfigEnum< T >::m_descriptions
protected

Definition at line 103 of file ConfigEnum.h.

template<typename T >
const char* icl_core::config::ConfigEnum< T >::m_end_marker
protected

Definition at line 104 of file ConfigEnum.h.

template<typename T >
icl_core::String icl_core::config::ConfigEnum< T >::m_key
protected

Definition at line 100 of file ConfigEnum.h.

template<typename T >
icl_core::String icl_core::config::ConfigEnum< T >::m_str_value
mutableprotected

Definition at line 101 of file ConfigEnum.h.

template<typename T >
icl_core::ConvertToRef<T>::ToRef icl_core::config::ConfigEnum< T >::m_value
protected

Definition at line 102 of file ConfigEnum.h.


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


fzi_icl_core
Author(s):
autogenerated on Mon Jun 10 2019 13:17:59