Public Member Functions | Private Attributes | List of all members
icl_core::config::ConfigPositionalParameter Class Reference

#include <ConfigPositionalParameter.h>

Inheritance diagram for icl_core::config::ConfigPositionalParameter:
Inheritance graph
[legend]

Public Member Functions

icl_core::String configKey () const
 
 ConfigPositionalParameter (const icl_core::String &name, const icl_core::String &config_key, const icl_core::String &help, const bool is_optional=false, const icl_core::String &default_value="")
 
icl_core::String defaultValue () const
 
bool hasDefaultValue () const
 
- Public Member Functions inherited from icl_core::config::GetoptPositionalParameter
 GetoptPositionalParameter (const icl_core::String &name, const icl_core::String &help, const bool is_optional=false)
 
icl_core::String help () const
 Get the help text. More...
 
bool isOptional () const
 Get if the parameter is optional. More...
 
icl_core::String name () const
 Get the option name. More...
 

Private Attributes

icl_core::String m_config_key
 
icl_core::String m_default_value
 

Detailed Description

Contains information about how to handle a specific positional commandline parameter and how to map it into a configuration parameter.

The option value is stored in the specified config key.

Definition at line 46 of file ConfigPositionalParameter.h.

Constructor & Destructor Documentation

icl_core::config::ConfigPositionalParameter::ConfigPositionalParameter ( const icl_core::String name,
const icl_core::String config_key,
const icl_core::String help,
const bool  is_optional = false,
const icl_core::String default_value = "" 
)

Create a new config postional parameter.

Parameters
nameThe name of the parameter.
config_keyThe configuration key in which the option value should be stored.
helpA help text that will be used in the generic help.
is_optionalIff the parameter is an optional parameter.
default_valueThe default value to be set, if it has neither been set in the config file and on the commandline.
See also
GetoptPositionalParameter

Definition at line 28 of file ConfigPositionalParameter.cpp.

Member Function Documentation

icl_core::String icl_core::config::ConfigPositionalParameter::configKey ( ) const
inline

Get the configuration key in which the option should be stored.

Definition at line 70 of file ConfigPositionalParameter.h.

icl_core::String icl_core::config::ConfigPositionalParameter::defaultValue ( ) const
inline

Get the default value of the configuration parameter.

Definition at line 78 of file ConfigPositionalParameter.h.

bool icl_core::config::ConfigPositionalParameter::hasDefaultValue ( ) const
inline

Check if a default value has been set.

Definition at line 74 of file ConfigPositionalParameter.h.

Member Data Documentation

icl_core::String icl_core::config::ConfigPositionalParameter::m_config_key
private

Definition at line 81 of file ConfigPositionalParameter.h.

icl_core::String icl_core::config::ConfigPositionalParameter::m_default_value
private

Definition at line 82 of file ConfigPositionalParameter.h.


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


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