Config.h File Reference

Base header file for the configuration framework. More...

#include <boost/foreach.hpp>
#include <icl_core/BaseTypes.h>
#include <icl_core/EnumHelper.h>
#include <icl_core/StringHelper.h>
#include <icl_core/TemplateHelper.h>
#include <icl_core_logging/Logging.h>
#include "icl_core_config/ImportExport.h"
#include "icl_core_config/ConfigIterator.h"
#include "icl_core_config/ConfigManager.h"
#include "icl_core_config/ConfigParameter.h"
#include "icl_core_config/ConfigValues.h"
#include "icl_core_config/GetoptParser.h"
#include "icl_core_config/GetoptParameter.h"
#include "icl_core_config/Util.h"

Include dependency graph for Config.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	icl_core
namespace	icl_core::config
	Framework for processing configuration files.
Functions
void	icl_core::config::activateExtraCmdParams (const icl_core::String &delimiter="--")
ICL_CORE_VC_DEPRECATE_STYLE void	icl_core::config::ActivateExtraCmdParams (const icl_core::String &delimiter="--") ICL_CORE_GCC_DEPRECATE_STYLE
void	icl_core::config::addParameter (const ConfigParameter &parameter)
void	icl_core::config::addParameter (const ConfigParameterList &parameters)
void	icl_core::config::addParameter (const ConfigPositionalParameter &parameter)
void	icl_core::config::addParameter (const GetoptParameter &parameter)
void	icl_core::config::addParameter (const GetoptPositionalParameter &parameter)
ICL_CORE_VC_DEPRECATE_STYLE void	icl_core::config::AddParameter (const ConfigParameter &parameter) ICL_CORE_GCC_DEPRECATE_STYLE
ICL_CORE_VC_DEPRECATE_STYLE void	icl_core::config::AddParameter (const ConfigParameterList &parameters) ICL_CORE_GCC_DEPRECATE_STYLE
ICL_CORE_VC_DEPRECATE_STYLE void	icl_core::config::AddParameter (const GetoptParameter &parameter) ICL_CORE_GCC_DEPRECATE_STYLE
void	icl_core::config::debugOutCommandLine (int argc, char *argv[])
ICL_CORE_VC_DEPRECATE_STYLE void	icl_core::config::DebugOutCommandLine (int argc, char *argv[]) ICL_CORE_GCC_DEPRECATE_STYLE
void	icl_core::config::dump ()
ICL_CORE_VC_DEPRECATE_STYLE void	icl_core::config::Dump () ICL_CORE_GCC_DEPRECATE_STYLE
icl_core::String	icl_core::config::extraCmdParam (size_t index)
ICL_CORE_VC_DEPRECATE_STYLE icl_core::String	icl_core::config::ExtraCmdParam (size_t index) ICL_CORE_GCC_DEPRECATE_STYLE
size_t	icl_core::config::extraCmdParamCount ()
ICL_CORE_VC_DEPRECATE_STYLE size_t	icl_core::config::ExtraCmdParamCount () ICL_CORE_GCC_DEPRECATE_STYLE
ICL_CORE_CONFIG_IMPORT_EXPORT ConfigIterator	icl_core::config::find (const icl_core::String &query)
ICL_CORE_VC_DEPRECATE_STYLE ConfigIterator	icl_core::config::Find (const icl_core::String &query) ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
bool	icl_core::config::get (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToRef value)
	Gets the value for the specified key from the configuration.
template<typename T >
bool	icl_core::config::get (const char *key, typename icl_core::ConvertToRef< T >::ToRef value)
	Gets the value for the specified key from the configuration.
template<typename T >
bool	icl_core::config::get (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToRef value, const char *descriptions[], const char *end_marker=NULL)
template<typename T >
bool	icl_core::config::get (const char *key, typename icl_core::ConvertToRef< T >::ToRef value, const char *descriptions[], const char *end_marker=NULL)
bool	icl_core::config::get (const ConfigValues config_values, icl_core::logging::LogStream &log_stream, bool cleanup=true, bool report_error=true)
bool	icl_core::config::get (std::string config_prefix, ConfigValueList config_values, icl_core::logging::LogStream &log_stream, bool cleanup=true, bool report_error=true)
bool	icl_core::config::get (ConfigValueList config_values, icl_core::logging::LogStream &log_stream, bool cleanup=true, bool report_error=true)
template<typename T >
bool	icl_core::config::Get (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToRef value) ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
bool	icl_core::config::Get (const char *key, typename icl_core::ConvertToRef< T >::ToRef value) ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
bool	icl_core::config::Get (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToRef value, const char *descriptions[], const char *end_marker=NULL) ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
bool	icl_core::config::Get (const char *key, typename icl_core::ConvertToRef< T >::ToRef value, const char *descriptions[], const char *end_marker=NULL) ICL_CORE_GCC_DEPRECATE_STYLE
ICL_CORE_VC_DEPRECATE_STYLE bool	icl_core::config::Get (const ConfigValues config_values, icl_core::logging::LogStream &log_stream, bool cleanup=true) ICL_CORE_GCC_DEPRECATE_STYLE
template<>
bool	icl_core::config::get< bool > (const icl_core::String &key, bool &value)
	Template specialization for boolean values.
template<>
bool	icl_core::config::Get< bool > (const icl_core::String &key, bool &value) ICL_CORE_GCC_DEPRECATE_STYLE
template<>
bool	icl_core::config::get< icl_core::String > (const icl_core::String &key, icl_core::String &value)
	Template specialization for icl_core::String.
template<>
bool	icl_core::config::Get< icl_core::String > (const icl_core::String &key, icl_core::String &value) ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
T	icl_core::config::getDefault (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToConstRef default_value)
template<typename T >
T	icl_core::config::getDefault (const char *key, typename icl_core::ConvertToRef< T >::ToConstRef default_value)
template<typename T >
T	icl_core::config::GetDefault (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToConstRef default_value) ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
T	icl_core::config::GetDefault (const char *key, typename icl_core::ConvertToRef< T >::ToConstRef default_value) ICL_CORE_GCC_DEPRECATE_STYLE
template<>
icl_core::String	icl_core::config::getDefault< icl_core::String > (const icl_core::String &key, const icl_core::String &default_value)
template<>
icl_core::String	icl_core::config::GetDefault< icl_core::String > (const icl_core::String &key, const icl_core::String &default_value) ICL_CORE_GCC_DEPRECATE_STYLE
bool	icl_core::config::initialize (int &argc, char *argv[], bool remove_read_arguments)
bool	icl_core::config::initialize (int &argc, char *argv[], Getopt::CommandLineCleaning cleanup, Getopt::ParameterRegistrationCheck registration_check)
ICL_CORE_VC_DEPRECATE_STYLE bool	icl_core::config::Initialize (int &argc, char *argv[], bool remove_read_arguments) ICL_CORE_GCC_DEPRECATE_STYLE
ICL_CORE_VC_DEPRECATE_STYLE bool	icl_core::config::Initialize (int &argc, char *argv[], Getopt::CommandLineCleaning cleanup=Getopt::eCLC_None, Getopt::ParameterRegistrationCheck registration_check=Getopt::ePRC_Strict) ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
bool	icl_core::config::paramNonOpt (size_t index, typename icl_core::ConvertToRef< T >::ToRef value)
template<typename T >
bool	icl_core::config::paramNonOpt (size_t index, typename icl_core::ConvertToRef< T >::ToRef value, const char *descriptions[], const char *end_marker=NULL)
icl_core::String	icl_core::config::paramNonOpt (size_t index)
template<typename T >
bool	icl_core::config::ParamNonOpt (size_t index, typename icl_core::ConvertToRef< T >::ToRef value) ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
bool	icl_core::config::ParamNonOpt (size_t index, typename icl_core::ConvertToRef< T >::ToRef value, const char *descriptions[], const char *end_marker=NULL) ICL_CORE_GCC_DEPRECATE_STYLE
ICL_CORE_VC_DEPRECATE_STYLE icl_core::String	icl_core::config::ParamNonOpt (size_t index) ICL_CORE_GCC_DEPRECATE_STYLE
size_t	icl_core::config::paramNonOptCount ()
ICL_CORE_VC_DEPRECATE_STYLE size_t	icl_core::config::ParamNonOptCount () ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
bool	icl_core::config::paramOpt (const icl_core::String &name, typename icl_core::ConvertToRef< T >::ToRef value)
template<typename T >
bool	icl_core::config::paramOpt (const char *name, typename icl_core::ConvertToRef< T >::ToRef value)
template<typename T >
bool	icl_core::config::paramOpt (const icl_core::String &name, typename icl_core::ConvertToRef< T >::ToRef value, const char *descriptions[], const char *end_marker=NULL)
template<typename T >
bool	icl_core::config::paramOpt (const char *name, typename icl_core::ConvertToRef< T >::ToRef value, const char *descriptions[], const char *end_marker=NULL)
template<typename T >
bool	icl_core::config::ParamOpt (const icl_core::String &name, typename icl_core::ConvertToRef< T >::ToRef value) ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
bool	icl_core::config::ParamOpt (const char *name, typename icl_core::ConvertToRef< T >::ToRef value) ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
bool	icl_core::config::ParamOpt (const icl_core::String &name, typename icl_core::ConvertToRef< T >::ToRef value, const char *descriptions[], const char *end_marker=NULL) ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
bool	icl_core::config::ParamOpt (const char *name, typename icl_core::ConvertToRef< T >::ToRef value, const char *descriptions[], const char *end_marker=NULL) ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
T	icl_core::config::paramOptDefault (const icl_core::String &name, typename icl_core::ConvertToRef< T >::ToConstRef default_value)
template<typename T >
T	icl_core::config::paramOptDefault (const char *name, typename icl_core::ConvertToRef< T >::ToConstRef default_value)
template<typename T >
T	icl_core::config::ParamOptDefault (const icl_core::String &name, typename icl_core::ConvertToRef< T >::ToConstRef default_value) ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
T	icl_core::config::ParamOptDefault (const char *name, typename icl_core::ConvertToRef< T >::ToConstRef default_value) ICL_CORE_GCC_DEPRECATE_STYLE
bool	icl_core::config::paramOptPresent (const icl_core::String &name)
ICL_CORE_VC_DEPRECATE_STYLE bool	icl_core::config::ParamOptPresent (const icl_core::String &name) ICL_CORE_GCC_DEPRECATE_STYLE
void	icl_core::config::printHelp ()
ICL_CORE_VC_DEPRECATE_STYLE void	icl_core::config::PrintHelp () ICL_CORE_GCC_DEPRECATE_STYLE
void	icl_core::config::setProgramDescription (icl_core::String const &description)
void	icl_core::config::setProgramVersion (icl_core::String const &version)
template<typename T >
void	icl_core::config::setValue (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToConstRef value)
template<typename T >
void	icl_core::config::setValue (const char *key, typename icl_core::ConvertToRef< T >::ToConstRef value)
void	icl_core::config::setValue (const icl_core::String &key, const icl_core::String &value)
template<typename T >
void	icl_core::config::SetValue (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToConstRef value) ICL_CORE_GCC_DEPRECATE_STYLE
template<typename T >
void	icl_core::config::SetValue (const char *key, typename icl_core::ConvertToRef< T >::ToConstRef value) ICL_CORE_GCC_DEPRECATE_STYLE
ICL_CORE_VC_DEPRECATE_STYLE void	icl_core::config::SetValue (const icl_core::String &key, const icl_core::String &value) ICL_CORE_GCC_DEPRECATE_STYLE

---

Detailed Description

Base header file for the configuration framework.

Author:

Klaus Uhl <uhl@fzi.de>

Date:

2008-11-01

Contains convenience functions to access the ConfigManager singleton's functionality.

Definition in file Config.h.