Public Member Functions | Private Attributes
icl_core::config::ConfigPositionalParameter Class Reference

#include <ConfigPositionalParameter.h>

Inheritance diagram for icl_core::config::ConfigPositionalParameter:
Inheritance graph

List of all members.

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

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.

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:

Definition at line 28 of file ConfigPositionalParameter.cpp.

Member Function Documentation

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

Definition at line 70 of file ConfigPositionalParameter.h.

Get the default value of the configuration parameter.

Definition at line 78 of file ConfigPositionalParameter.h.

Check if a default value has been set.

Definition at line 74 of file ConfigPositionalParameter.h.

Member Data Documentation

Definition at line 81 of file ConfigPositionalParameter.h.

Definition at line 82 of file ConfigPositionalParameter.h.

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

autogenerated on Tue Aug 8 2017 02:28:05