Framework for processing configuration files. More...

Namespaces
	impl
	Namespace for internal implementation details.

Classes
class	AttributeTree

class	ConfigEnum

class	ConfigEnumDefault

class	ConfigList

class	ConfigManager
	Class for handling configuration files. More...

class	ConfigObserver
	Interface for observing configuration changes. More...

class	ConfigParameter

class	ConfigPositionalParameter

class	ConfigValue

class	ConfigValueDefault

class	FilePath

class	Getopt
	Handles commandline parameters. More...

class	GetoptParameter

class	GetoptPositionalParameter

class	MemberEnum

class	MemberValue

class	MemberValue< bool, Q >
	Template specialization for boolean MemberValues. More...

class	SubTreeList

class	TConfigEnum

class	TConfigEnumDefault

class	TConfigValue

class	TConfigValueDefault

Typedefs
typedef icl_core::KeyValueDirectoryIterator< icl_core::String >	ConfigIterator

typedef icl_core::Vector< ConfigParameter >	ConfigParameterList

typedef icl_core::Vector< ConfigPositionalParameter >	ConfigPositionalParameterList

typedef std::list< impl::ConfigValueIface * >	ConfigValueList

typedef impl::ConfigValueIface *	ConfigValues[]

typedef icl_core::Vector< GetoptParameter >	GetoptParameterList

typedef icl_core::Vector< GetoptPositionalParameter >	GetoptPositionalParameterList

typedef ICL_CORE_VC_DEPRECATE AttributeTree tAttributeTree	ICL_CORE_GCC_DEPRECATE

Functions
void	activateExtraCmdParams (const icl_core::String &delimiter="--")

ICL_CORE_VC_DEPRECATE_STYLE void	ActivateExtraCmdParams (const icl_core::String &delimiter="--") ICL_CORE_GCC_DEPRECATE_STYLE

void	addParameter (const ConfigParameter &parameter)

void	addParameter (const ConfigParameterList &parameters)

void	addParameter (const ConfigPositionalParameter &parameter)

void	addParameter (const ConfigPositionalParameterList &parameters)

void	addParameter (const GetoptParameter &parameter)

void	addParameter (const GetoptParameterList &parameters)

void	addParameter (const GetoptPositionalParameter &parameter)

void	addParameter (const GetoptPositionalParameterList &parameters)

ICL_CORE_VC_DEPRECATE_STYLE void	AddParameter (const ConfigParameter &parameter) ICL_CORE_GCC_DEPRECATE_STYLE

ICL_CORE_VC_DEPRECATE_STYLE void	AddParameter (const ConfigParameterList &parameters) ICL_CORE_GCC_DEPRECATE_STYLE

ICL_CORE_VC_DEPRECATE_STYLE void	AddParameter (const GetoptParameter &parameter) ICL_CORE_GCC_DEPRECATE_STYLE

ICL_CORE_VC_DEPRECATE_STYLE void	AddParameter (const GetoptParameterList &parameters) ICL_CORE_GCC_DEPRECATE_STYLE

void	debugOutCommandLine (int argc, char *argv[])

ICL_CORE_VC_DEPRECATE_STYLE void	DebugOutCommandLine (int argc, char *argv[]) ICL_CORE_GCC_DEPRECATE_STYLE

void	dump ()

ICL_CORE_VC_DEPRECATE_STYLE void	Dump () ICL_CORE_GCC_DEPRECATE_STYLE

icl_core::String	extraCmdParam (size_t index)

ICL_CORE_VC_DEPRECATE_STYLE icl_core::String	ExtraCmdParam (size_t index) ICL_CORE_GCC_DEPRECATE_STYLE

size_t	extraCmdParamCount ()

ICL_CORE_VC_DEPRECATE_STYLE size_t	ExtraCmdParamCount () ICL_CORE_GCC_DEPRECATE_STYLE

ConfigIterator	find (const ::icl_core::String &query)

ICL_CORE_CONFIG_IMPORT_EXPORT ConfigIterator	find (const icl_core::String &query)

ICL_CORE_VC_DEPRECATE_STYLE ConfigIterator	Find (const icl_core::String &query) ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
bool	get (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToRef value)
	Gets the value for the specified key from the configuration. More...

template<typename T >
bool	get (const char *key, typename icl_core::ConvertToRef< T >::ToRef value)
	Gets the value for the specified key from the configuration. More...

template<typename T >
bool	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	get (const char key, typename icl_core::ConvertToRef< T >::ToRef value, const char descriptions[], const char *end_marker=NULL)

bool	get (const ConfigValues config_values, icl_core::logging::LogStream &log_stream, bool cleanup=true, bool report_error=true)

bool	get (std::string config_prefix, ConfigValueList config_values, icl_core::logging::LogStream &log_stream, bool cleanup=true, bool report_error=true)

bool	get (ConfigValueList config_values, icl_core::logging::LogStream &log_stream, bool cleanup=true, bool report_error=true)

template<typename T >
bool	Get (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToRef value) ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
bool	Get (const char *key, typename icl_core::ConvertToRef< T >::ToRef value) ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
ICL_CORE_VC_DEPRECATE_STYLE bool	Get (const char *key, typename icl_core::ConvertToRef< T >::ToRef value)

template<typename T >
ICL_CORE_VC_DEPRECATE_STYLE bool	Get (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToRef value)

template<typename T >
bool	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 >
ICL_CORE_VC_DEPRECATE_STYLE bool	Get (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToRef value, const char descriptions[], const char end_marker)

template<typename T >
bool	Get (const char key, typename icl_core::ConvertToRef< T >::ToRef value, const char descriptions[], const char *end_marker=NULL) ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
ICL_CORE_VC_DEPRECATE_STYLE bool	Get (const char key, typename icl_core::ConvertToRef< T >::ToRef value, const char descriptions[], const char *end_marker)

ICL_CORE_VC_DEPRECATE_STYLE bool	Get (const ConfigValues config_values, icl_core::logging::LogStream &log_stream, bool cleanup=true) ICL_CORE_GCC_DEPRECATE_STYLE

template<>
bool	get< bool > (const icl_core::String &key, bool &value)
	Template specialization for boolean values. More...

template<>
bool	Get< bool > (const icl_core::String &key, bool &value) ICL_CORE_GCC_DEPRECATE_STYLE

template<>
ICL_CORE_VC_DEPRECATE_STYLE bool	Get< bool > (const icl_core::String &key, bool &value)

template<>
bool	get< icl_core::String > (const icl_core::String &key, icl_core::String &value)
	Template specialization for icl_core::String. More...

template<>
bool	Get< icl_core::String > (const icl_core::String &key, icl_core::String &value) ICL_CORE_GCC_DEPRECATE_STYLE

template<>
ICL_CORE_VC_DEPRECATE_STYLE bool	Get< icl_core::String > (const icl_core::String &key, icl_core::String &value)

template<typename T >
T	getDefault (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToConstRef default_value)

template<typename T >
T	getDefault (const char *key, typename icl_core::ConvertToRef< T >::ToConstRef default_value)

template<typename T >
T	GetDefault (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToConstRef default_value) ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
ICL_CORE_VC_DEPRECATE_STYLE T	GetDefault (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToConstRef default_value)

template<typename T >
T	GetDefault (const char *key, typename icl_core::ConvertToRef< T >::ToConstRef default_value) ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
ICL_CORE_VC_DEPRECATE_STYLE T	GetDefault (const char *key, typename icl_core::ConvertToRef< T >::ToConstRef default_value)

template<>
icl_core::String	getDefault< icl_core::String > (const icl_core::String &key, const icl_core::String &default_value)

template<>
icl_core::String	GetDefault< icl_core::String > (const icl_core::String &key, const icl_core::String &default_value) ICL_CORE_GCC_DEPRECATE_STYLE

template<>
ICL_CORE_VC_DEPRECATE_STYLE icl_core::String	GetDefault< icl_core::String > (const icl_core::String &key, const icl_core::String &default_value)

bool	initialize (int &argc, char *argv[], bool remove_read_arguments)

bool	initialize (int &argc, char *argv[], Getopt::CommandLineCleaning cleanup, Getopt::ParameterRegistrationCheck registration_check)

ICL_CORE_VC_DEPRECATE_STYLE bool	Initialize (int &argc, char *argv[], bool remove_read_arguments) ICL_CORE_GCC_DEPRECATE_STYLE

ICL_CORE_VC_DEPRECATE_STYLE bool	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	paramNonOpt (size_t index, typename icl_core::ConvertToRef< T >::ToRef value)

template<typename T >
bool	paramNonOpt (size_t index, typename icl_core::ConvertToRef< T >::ToRef value, const char descriptions[], const char end_marker=NULL)

icl_core::String	paramNonOpt (size_t index)

template<typename T >
bool	ParamNonOpt (size_t index, typename icl_core::ConvertToRef< T >::ToRef value) ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
ICL_CORE_VC_DEPRECATE_STYLE bool	ParamNonOpt (size_t index, typename icl_core::ConvertToRef< T >::ToRef value)

template<typename T >
bool	ParamNonOpt (size_t index, typename icl_core::ConvertToRef< T >::ToRef value, const char descriptions[], const char end_marker=NULL) ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
ICL_CORE_VC_DEPRECATE_STYLE bool	ParamNonOpt (size_t index, typename icl_core::ConvertToRef< T >::ToRef value, const char descriptions[], const char end_marker)

ICL_CORE_VC_DEPRECATE_STYLE icl_core::String	ParamNonOpt (size_t index) ICL_CORE_GCC_DEPRECATE_STYLE

size_t	paramNonOptCount ()

ICL_CORE_VC_DEPRECATE_STYLE size_t	ParamNonOptCount () ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
bool	paramOpt (const icl_core::String &name, typename icl_core::ConvertToRef< T >::ToRef value)

template<typename T >
bool	paramOpt (const char *name, typename icl_core::ConvertToRef< T >::ToRef value)

template<typename T >
bool	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	paramOpt (const char name, typename icl_core::ConvertToRef< T >::ToRef value, const char descriptions[], const char *end_marker=NULL)

template<typename T >
bool	ParamOpt (const icl_core::String &name, typename icl_core::ConvertToRef< T >::ToRef value) ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
ICL_CORE_VC_DEPRECATE_STYLE bool	ParamOpt (const icl_core::String &name, typename icl_core::ConvertToRef< T >::ToRef value)

template<typename T >
bool	ParamOpt (const char *name, typename icl_core::ConvertToRef< T >::ToRef value) ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
ICL_CORE_VC_DEPRECATE_STYLE bool	ParamOpt (const char *name, typename icl_core::ConvertToRef< T >::ToRef value)

template<typename T >
bool	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 >
ICL_CORE_VC_DEPRECATE_STYLE bool	ParamOpt (const icl_core::String &name, typename icl_core::ConvertToRef< T >::ToRef value, const char descriptions[], const char end_marker)

template<typename T >
bool	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 >
ICL_CORE_VC_DEPRECATE_STYLE bool	ParamOpt (const char name, typename icl_core::ConvertToRef< T >::ToRef value, const char descriptions[], const char *end_marker)

template<typename T >
T	paramOptDefault (const icl_core::String &name, typename icl_core::ConvertToRef< T >::ToConstRef default_value)

template<typename T >
T	paramOptDefault (const char *name, typename icl_core::ConvertToRef< T >::ToConstRef default_value)

template<typename T >
T	ParamOptDefault (const icl_core::String &name, typename icl_core::ConvertToRef< T >::ToConstRef default_value) ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
ICL_CORE_VC_DEPRECATE_STYLE T	ParamOptDefault (const icl_core::String &name, typename icl_core::ConvertToRef< T >::ToConstRef default_value)

template<typename T >
T	ParamOptDefault (const char *name, typename icl_core::ConvertToRef< T >::ToConstRef default_value) ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
ICL_CORE_VC_DEPRECATE_STYLE T	ParamOptDefault (const char *name, typename icl_core::ConvertToRef< T >::ToConstRef default_value)

bool	paramOptPresent (const icl_core::String &name)

ICL_CORE_VC_DEPRECATE_STYLE bool	ParamOptPresent (const icl_core::String &name) ICL_CORE_GCC_DEPRECATE_STYLE

void	printHelp ()

ICL_CORE_VC_DEPRECATE_STYLE void	PrintHelp () ICL_CORE_GCC_DEPRECATE_STYLE

void	readNextLineInBuffer (istream &in)

void	setProgramDescription (icl_core::String const &description)

void	setProgramVersion (icl_core::String const &version)

template<typename T >
void	setValue (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToConstRef value)

template<typename T >
void	setValue (const char *key, typename icl_core::ConvertToRef< T >::ToConstRef value)

void	setValue (const icl_core::String &key, const icl_core::String &value)

template<typename T >
void	SetValue (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToConstRef value) ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
ICL_CORE_VC_DEPRECATE_STYLE void	SetValue (const icl_core::String &key, typename icl_core::ConvertToRef< T >::ToConstRef value)

template<typename T >
void	SetValue (const char *key, typename icl_core::ConvertToRef< T >::ToConstRef value) ICL_CORE_GCC_DEPRECATE_STYLE

template<typename T >
ICL_CORE_VC_DEPRECATE_STYLE void	SetValue (const char *key, typename icl_core::ConvertToRef< T >::ToConstRef value)

ICL_CORE_VC_DEPRECATE_STYLE void	SetValue (const icl_core::String &key, const icl_core::String &value) ICL_CORE_GCC_DEPRECATE_STYLE

Variables
static char	buffer [2000]

const char *	comment_end_str = "}_COMMENT_"

const char *	comment_str = comment_end_str + 1

const char *	CONFIGFILE_CONFIG_KEY = "/configfile"

const char	DSEP = '/'

const char	DSEP_OTHER = '\\'

int	file_name_str_len = 0

int	file_path_str_len = 0

const int	INCLUDE_OFFSET = 10

const char *	include_str = "_INCLUDE_"

Detailed Description

Framework for processing configuration files.

Typedef Documentation

typedef icl_core::KeyValueDirectoryIterator<icl_core::String> icl_core::config::ConfigIterator

Definition at line 62 of file ConfigIterator.h.

typedef icl_core::Vector<ConfigParameter> icl_core::config::ConfigParameterList

Definition at line 115 of file ConfigParameter.h.

typedef icl_core::Vector<ConfigPositionalParameter> icl_core::config::ConfigPositionalParameterList

Definition at line 85 of file ConfigPositionalParameter.h.

typedef std::list<impl::ConfigValueIface*> icl_core::config::ConfigValueList

Definition at line 45 of file ConfigValues.h.

typedef impl::ConfigValueIface* icl_core::config::ConfigValues[]

Definition at line 44 of file ConfigValues.h.

typedef icl_core::Vector<GetoptParameter> icl_core::config::GetoptParameterList

Definition at line 108 of file GetoptParameter.h.

typedef icl_core::Vector<GetoptPositionalParameter> icl_core::config::GetoptPositionalParameterList

Definition at line 61 of file GetoptPositionalParameter.h.

typedef ICL_CORE_VC_DEPRECATE GetoptParameter tGetoptParameter icl_core::config::ICL_CORE_GCC_DEPRECATE

Definition at line 33 of file tAttributeTree.h.

Function Documentation

void icl_core::config::activateExtraCmdParams ( const icl_core::String & delimiter = "--" )

inline

Definition at line 531 of file Config.h.

void icl_core::config::ActivateExtraCmdParams ( const icl_core::String & delimiter = "--" )

inline

Definition at line 860 of file Config.h.

void icl_core::config::addParameter ( const ConfigParameter & parameter )

inline

Definition at line 541 of file Config.h.

void icl_core::config::addParameter ( const ConfigParameterList & parameters )

inline

Definition at line 546 of file Config.h.

void icl_core::config::addParameter ( const ConfigPositionalParameter & parameter )

inline

Definition at line 551 of file Config.h.

void icl_core::config::addParameter ( const ConfigPositionalParameterList & parameters )

inline

Definition at line 556 of file Config.h.

void icl_core::config::addParameter ( const GetoptParameter & parameter )

inline

Definition at line 561 of file Config.h.

void icl_core::config::addParameter ( const GetoptParameterList & parameters )

inline

Definition at line 566 of file Config.h.

void icl_core::config::addParameter ( const GetoptPositionalParameter & parameter )

inline

Definition at line 571 of file Config.h.

void icl_core::config::addParameter ( const GetoptPositionalParameterList & parameters )

inline

Definition at line 576 of file Config.h.

void icl_core::config::AddParameter ( const ConfigParameter & parameter )

inline

Definition at line 872 of file Config.h.

void icl_core::config::AddParameter ( const ConfigParameterList & parameters )

inline

Definition at line 878 of file Config.h.

void icl_core::config::AddParameter ( const GetoptParameter & parameter )

inline

Definition at line 884 of file Config.h.

void icl_core::config::AddParameter ( const GetoptParameterList & parameters )

inline

Definition at line 890 of file Config.h.

ICL_CORE_CONFIG_IMPORT_EXPORT void icl_core::config::debugOutCommandLine	(	int	argc,
		char *	argv[]
	)

Definition at line 36 of file Config.cpp.

void icl_core::config::DebugOutCommandLine	(	int	argc,
		char *	argv[]
	)

inline

Definition at line 615 of file Config.h.

ICL_CORE_CONFIG_IMPORT_EXPORT void icl_core::config::dump ( )

Definition at line 31 of file Config.cpp.

void icl_core::config::Dump ( )

inline

Definition at line 609 of file Config.h.

icl_core::String icl_core::config::extraCmdParam ( size_t index )

inline

Definition at line 526 of file Config.h.

icl_core::String icl_core::config::ExtraCmdParam ( size_t index )

inline

Definition at line 854 of file Config.h.

size_t icl_core::config::extraCmdParamCount ( )

inline

Definition at line 521 of file Config.h.

size_t icl_core::config::ExtraCmdParamCount ( )

inline

Definition at line 848 of file Config.h.

ConfigIterator icl_core::config::find ( const ::icl_core::String & query )

Definition at line 45 of file Config.cpp.

ICL_CORE_CONFIG_IMPORT_EXPORT ConfigIterator icl_core::config::find ( const icl_core::String & query )

ConfigIterator icl_core::config::Find ( const icl_core::String & query )

inline

Definition at line 621 of file Config.h.

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.

Definition at line 90 of file Config.h.

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.

Definition at line 83 of file Config.h.

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`
	)

Definition at line 169 of file Config.h.

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`
	)

Definition at line 193 of file Config.h.

bool icl_core::config::get	(	const ConfigValues	config_values,
		icl_core::logging::LogStream &	log_stream,
		bool	cleanup = `true`,
		bool	report_error = `true`
	)

inline

Get configuration parameters in batch mode. Returns true on success. If report_error is true, writes an error message for each failed configuration parameter. Returns false if any parameter failed. Optionally deletes the contents of the config_values array.

Definition at line 241 of file Config.h.

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`
	)

inline

Get configuration parameters in batch mode. Returns true on success. If report_error is true, writes an error message for each failed configuration parameter. Returns false if any parameter failed. Optionally deletes the contents of the config_values array.

Definition at line 293 of file Config.h.

bool icl_core::config::get	(	ConfigValueList	config_values,
		icl_core::logging::LogStream &	log_stream,
		bool	cleanup = `true`,
		bool	report_error = `true`
	)

inline

Definition at line 353 of file Config.h.

template<typename T >

bool icl_core::config::Get	(	const icl_core::String &	key,
		typename icl_core::ConvertToRef< T >::ToRef	value
	)

inline

Gets the value for the specified key from the configuration.

Deprecated:: Obsolete coding style.

Gets the value for the specified key from the configuration.

Deprecated:: Obsolete coding style.

Definition at line 648 of file Config.h.

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.

Deprecated:: Obsolete coding style.

Definition at line 637 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE 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.

Deprecated:: Obsolete coding style.

Definition at line 637 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE bool icl_core::config::Get	(	const icl_core::String &	key,
		typename icl_core::ConvertToRef< T >::ToRef	value
	)

inline

Gets the value for the specified key from the configuration.

Deprecated:: Obsolete coding style.

Gets the value for the specified key from the configuration.

Deprecated:: Obsolete coding style.

Definition at line 648 of file Config.h.

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`
	)

Definition at line 681 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE bool icl_core::config::Get	(	const icl_core::String &	key,
		typename icl_core::ConvertToRef< T >::ToRef	value,
		const char *	descriptions[],
		const char *	end_marker
	)

Definition at line 681 of file Config.h.

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`
	)

Definition at line 694 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE bool icl_core::config::Get	(	const char *	key,
		typename icl_core::ConvertToRef< T >::ToRef	value,
		const char *	descriptions[],
		const char *	end_marker
	)

Definition at line 694 of file Config.h.

bool icl_core::config::Get	(	const ConfigValues	config_values,
		icl_core::logging::LogStream &	log_stream,
		bool	cleanup = `true`
	)

inline

Get configuration parameters in batch mode.

Deprecated:: Obsolete coding style.

Definition at line 735 of file Config.h.

template<>

bool icl_core::config::get< bool >	(	const icl_core::String &	key,
		bool &	value
	)

inline

Template specialization for boolean values.

Definition at line 122 of file Config.h.

template<>

bool icl_core::config::Get< bool >	(	const icl_core::String &	key,
		bool &	value
	)

inline

Template specialization for boolean values.

Deprecated:: Obsolete coding style.

Definition at line 671 of file Config.h.

template<>

ICL_CORE_VC_DEPRECATE_STYLE bool icl_core::config::Get< bool >	(	const icl_core::String &	key,
		bool &	value
	)

inline

Template specialization for boolean values.

Deprecated:: Obsolete coding style.

Definition at line 671 of file Config.h.

template<>

bool icl_core::config::get< icl_core::String >	(	const icl_core::String &	key,
		icl_core::String &	value
	)

inline

Template specialization for icl_core::String.

Definition at line 114 of file Config.h.

template<>

bool icl_core::config::Get< icl_core::String >	(	const icl_core::String &	key,
		icl_core::String &	value
	)

inline

Template specialization for icl_core::String.

Deprecated:: Obsolete coding style.

Definition at line 660 of file Config.h.

template<>

ICL_CORE_VC_DEPRECATE_STYLE bool icl_core::config::Get< icl_core::String >	(	const icl_core::String &	key,
		icl_core::String &	value
	)

inline

Template specialization for icl_core::String.

Deprecated:: Obsolete coding style.

Definition at line 660 of file Config.h.

template<typename T >

T icl_core::config::getDefault	(	const icl_core::String &	key,
		typename icl_core::ConvertToRef< T >::ToConstRef	default_value
	)

Definition at line 200 of file Config.h.

template<typename T >

T icl_core::config::getDefault	(	const char *	key,
		typename icl_core::ConvertToRef< T >::ToConstRef	default_value
	)

Definition at line 208 of file Config.h.

template<typename T >

T icl_core::config::GetDefault	(	const icl_core::String &	key,
		typename icl_core::ConvertToRef< T >::ToConstRef	default_value
	)

Definition at line 705 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE T icl_core::config::GetDefault	(	const icl_core::String &	key,
		typename icl_core::ConvertToRef< T >::ToConstRef	default_value
	)

Definition at line 705 of file Config.h.

template<typename T >

T icl_core::config::GetDefault	(	const char *	key,
		typename icl_core::ConvertToRef< T >::ToConstRef	default_value
	)

Definition at line 714 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE T icl_core::config::GetDefault	(	const char *	key,
		typename icl_core::ConvertToRef< T >::ToConstRef	default_value
	)

Definition at line 714 of file Config.h.

template<>

icl_core::String icl_core::config::getDefault< icl_core::String >	(	const icl_core::String &	key,
		const icl_core::String &	default_value
	)

inline

Definition at line 214 of file Config.h.

template<>

icl_core::String icl_core::config::GetDefault< icl_core::String >	(	const icl_core::String &	key,
		const icl_core::String &	default_value
	)

inline

Definition at line 724 of file Config.h.

template<>

ICL_CORE_VC_DEPRECATE_STYLE icl_core::String icl_core::config::GetDefault< icl_core::String >	(	const icl_core::String &	key,
		const icl_core::String &	default_value
	)

inline

Definition at line 724 of file Config.h.

ICL_CORE_CONFIG_IMPORT_EXPORT bool icl_core::config::initialize	(	int &	argc,
		char *	argv[],
		bool	remove_read_arguments
	)

Definition at line 50 of file Config.cpp.

ICL_CORE_CONFIG_IMPORT_EXPORT bool icl_core::config::initialize	(	int &	argc,
		char *	argv[],
		Getopt::CommandLineCleaning	cleanup,
		Getopt::ParameterRegistrationCheck	registration_check
	)

Definition at line 57 of file Config.cpp.

bool icl_core::config::Initialize	(	int &	argc,
		char *	argv[],
		bool	remove_read_arguments
	)

inline

Definition at line 902 of file Config.h.

bool icl_core::config::Initialize	(	int &	argc,
		char *	argv[],
		Getopt::CommandLineCleaning	cleanup = `Getopt::eCLC_None`,
		Getopt::ParameterRegistrationCheck	registration_check = `Getopt::ePRC_Strict`
	)

inline

Definition at line 910 of file Config.h.

template<typename T >

bool icl_core::config::paramNonOpt	(	size_t	index,
		typename icl_core::ConvertToRef< T >::ToRef	value
	)

Definition at line 470 of file Config.h.

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`
	)

Definition at line 492 of file Config.h.

icl_core::String icl_core::config::paramNonOpt ( size_t index )

inline

Definition at line 516 of file Config.h.

template<typename T >

bool icl_core::config::ParamNonOpt	(	size_t	index,
		typename icl_core::ConvertToRef< T >::ToRef	value
	)

Definition at line 826 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE bool icl_core::config::ParamNonOpt	(	size_t	index,
		typename icl_core::ConvertToRef< T >::ToRef	value
	)

Definition at line 826 of file Config.h.

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`
	)

Definition at line 835 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE bool icl_core::config::ParamNonOpt	(	size_t	index,
		typename icl_core::ConvertToRef< T >::ToRef	value,
		const char *	descriptions[],
		const char *	end_marker
	)

Definition at line 835 of file Config.h.

icl_core::String icl_core::config::ParamNonOpt ( size_t index )

inline

Definition at line 842 of file Config.h.

size_t icl_core::config::paramNonOptCount ( )

inline

Definition at line 536 of file Config.h.

size_t icl_core::config::ParamNonOptCount ( )

inline

Definition at line 866 of file Config.h.

template<typename T >

bool icl_core::config::paramOpt	(	const icl_core::String &	name,
		typename icl_core::ConvertToRef< T >::ToRef	value
	)

Definition at line 384 of file Config.h.

template<typename T >

bool icl_core::config::paramOpt	(	const char *	name,
		typename icl_core::ConvertToRef< T >::ToRef	value
	)

Definition at line 405 of file Config.h.

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`
	)

Definition at line 411 of file Config.h.

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`
	)

Definition at line 436 of file Config.h.

template<typename T >

bool icl_core::config::ParamOpt	(	const icl_core::String &	name,
		typename icl_core::ConvertToRef< T >::ToRef	value
	)

Definition at line 774 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE bool icl_core::config::ParamOpt	(	const icl_core::String &	name,
		typename icl_core::ConvertToRef< T >::ToRef	value
	)

Definition at line 774 of file Config.h.

template<typename T >

bool icl_core::config::ParamOpt	(	const char *	name,
		typename icl_core::ConvertToRef< T >::ToRef	value
	)

Definition at line 782 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE bool icl_core::config::ParamOpt	(	const char *	name,
		typename icl_core::ConvertToRef< T >::ToRef	value
	)

Definition at line 782 of file Config.h.

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`
	)

Definition at line 791 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE bool icl_core::config::ParamOpt	(	const icl_core::String &	name,
		typename icl_core::ConvertToRef< T >::ToRef	value,
		const char *	descriptions[],
		const char *	end_marker
	)

Definition at line 791 of file Config.h.

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`
	)

Definition at line 801 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE bool icl_core::config::ParamOpt	(	const char *	name,
		typename icl_core::ConvertToRef< T >::ToRef	value,
		const char *	descriptions[],
		const char *	end_marker
	)

Definition at line 801 of file Config.h.

template<typename T >

T icl_core::config::paramOptDefault	(	const icl_core::String &	name,
		typename icl_core::ConvertToRef< T >::ToConstRef	default_value
	)

Definition at line 443 of file Config.h.

template<typename T >

T icl_core::config::paramOptDefault	(	const char *	name,
		typename icl_core::ConvertToRef< T >::ToConstRef	default_value
	)

Definition at line 464 of file Config.h.

template<typename T >

T icl_core::config::ParamOptDefault	(	const icl_core::String &	name,
		typename icl_core::ConvertToRef< T >::ToConstRef	default_value
	)

Definition at line 810 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE T icl_core::config::ParamOptDefault	(	const icl_core::String &	name,
		typename icl_core::ConvertToRef< T >::ToConstRef	default_value
	)

Definition at line 810 of file Config.h.

template<typename T >

T icl_core::config::ParamOptDefault	(	const char *	name,
		typename icl_core::ConvertToRef< T >::ToConstRef	default_value
	)

Definition at line 818 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE T icl_core::config::ParamOptDefault	(	const char *	name,
		typename icl_core::ConvertToRef< T >::ToConstRef	default_value
	)

Definition at line 818 of file Config.h.

bool icl_core::config::paramOptPresent ( const icl_core::String & name )

inline

Definition at line 378 of file Config.h.

bool icl_core::config::ParamOptPresent ( const icl_core::String & name )

inline

Definition at line 766 of file Config.h.

void icl_core::config::printHelp ( )

inline

Definition at line 591 of file Config.h.

void icl_core::config::PrintHelp ( )

inline

Definition at line 896 of file Config.h.

void icl_core::config::readNextLineInBuffer ( istream & in )

Definition at line 63 of file AttributeTree.cpp.

void icl_core::config::setProgramDescription ( icl_core::String const & description )

inline

Definition at line 586 of file Config.h.

void icl_core::config::setProgramVersion ( icl_core::String const & version )

inline

Definition at line 581 of file Config.h.

template<typename T >

void icl_core::config::setValue	(	const icl_core::String &	key,
		typename icl_core::ConvertToRef< T >::ToConstRef	value
	)

Definition at line 360 of file Config.h.

template<typename T >

void icl_core::config::setValue	(	const char *	key,
		typename icl_core::ConvertToRef< T >::ToConstRef	value
	)

Definition at line 366 of file Config.h.

void icl_core::config::setValue	(	const icl_core::String &	key,
		const icl_core::String &	value
	)

inline

Definition at line 372 of file Config.h.

template<typename T >

void icl_core::config::SetValue	(	const icl_core::String &	key,
		typename icl_core::ConvertToRef< T >::ToConstRef	value
	)

Definition at line 744 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE void icl_core::config::SetValue	(	const icl_core::String &	key,
		typename icl_core::ConvertToRef< T >::ToConstRef	value
	)

Definition at line 744 of file Config.h.

template<typename T >

void icl_core::config::SetValue	(	const char *	key,
		typename icl_core::ConvertToRef< T >::ToConstRef	value
	)

Definition at line 753 of file Config.h.

template<typename T >

ICL_CORE_VC_DEPRECATE_STYLE void icl_core::config::SetValue	(	const char *	key,
		typename icl_core::ConvertToRef< T >::ToConstRef	value
	)

Definition at line 753 of file Config.h.

void icl_core::config::SetValue	(	const icl_core::String &	key,
		const icl_core::String &	value
	)

inline

Definition at line 760 of file Config.h.

Variable Documentation

char icl_core::config::buffer[2000]

static

Definition at line 61 of file AttributeTree.cpp.

const char* icl_core::config::comment_end_str = "}_COMMENT_"

Definition at line 52 of file AttributeTree.cpp.

const char* icl_core::config::comment_str = comment_end_str + 1

Definition at line 53 of file AttributeTree.cpp.

ICL_CORE_CONFIG_IMPORT_EXPORT const char * icl_core::config::CONFIGFILE_CONFIG_KEY = "/configfile"

Definition at line 29 of file Config.cpp.

const char icl_core::config::DSEP = '/'

Definition at line 48 of file AttributeTree.cpp.

const char icl_core::config::DSEP_OTHER = '\\'

Definition at line 49 of file AttributeTree.cpp.

int icl_core::config::file_name_str_len = 0

Definition at line 58 of file AttributeTree.cpp.

int icl_core::config::file_path_str_len = 0

Definition at line 57 of file AttributeTree.cpp.

const int icl_core::config::INCLUDE_OFFSET = 10

Definition at line 59 of file AttributeTree.cpp.

const char* icl_core::config::include_str = "_INCLUDE_"

Definition at line 54 of file AttributeTree.cpp.

Namespaces

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

Function Documentation

Variable Documentation