include/corelib/ncbi_param.hpp File Reference

#include <corelib/ncbiapp.hpp>
#include <corelib/ncbithr.hpp>
#include <corelib/impl/ncbi_param_impl.hpp>

Include dependency graph for ncbi_param.hpp:

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

Go to the source code of this file.

Classes
class	CParamException
	CParamException. More...
class	CParamParser< TDescription >
	CParamParser. More...
class	CParamBase
	CParamBase. More...
class	CParam< TDescription >
	CParam. More...
Defines
#define	X_NCBI_PARAM_DECLNAME(section, name)   SNcbiParamDesc_##section##_##name
	Parameter declaration and definition macros.
#define	X_NCBI_PARAM_DECLNAME_SCOPE(scope, section, name)   scope::SNcbiParamDesc_##section##_##name
#define	X_NCBI_PARAM_ENUMNAME(section, name)   s_EnumData_##section##_##name
#define	X_NCBI_PARAM_DESC_DECL(type, desctype)
#define	X_NCBI_PARAM_ENUM_PARSER_DECL(type)
#define	X_NCBI_PARAM_STATIC_DEF(type, descname, defval)
#define	NCBI_PARAM_TYPE(section, name)   CParam< X_NCBI_PARAM_DECLNAME(section, name) >
	Generate typename for a parameter from its {section, name} attributes.
#define	NCBI_PARAM_DECL(type, section, name)
	Parameter declaration.
#define	expname
#define	NCBI_PARAM_ENUM_DECL(type, section, name)
	Enum parameter declaration.
#define	expname
#define	NCBI_PARAM_DEF(type, section, name, default_value)
	Parameter definition.
#define	NCBI_PARAM_DEF_EX(type, section, name, default_value, flags, env)
	Definition of a parameter with additional flags.
#define	NCBI_PARAM_DEF_IN_SCOPE(type, section, name, default_value, scope)
	Similar to NCBI_PARAM_DEF except it adds "scope" (class name or namespace) to the parameter's type.
#define	NCBI_PARAM_ENUM_ARRAY(type, section, name)   static SEnumDescription< type > X_NCBI_PARAM_ENUMNAME(section, name)[] =
#define	NCBI_PARAM_ENUM_DEF(type, section, name, default_value)
	Enum parameter definition.
#define	NCBI_PARAM_ENUM_DEF_EX(type, section, name,default_value, flags, env)
	Definition of an enum parameter with additional flags.
Typedefs
typedef int	TNcbiParamFlags
Enumerations
enum	ENcbiParamFlags { eParam_Default = 0, eParam_NoLoad = 1 << 0, eParam_NoThread = 1 << 1 }
	ENcbiParamFlags. More...
enum	EParamCacheFlag { eParamCache_Force, eParamCache_Try, eParamCache_Defer }
	Caching default value on construction of a param. More...
Functions
string	g_GetConfigString (const char *section, const char *variable, const char *env_var_name, const char *default_value)
	Get string configuration value.
int	g_GetConfigInt (const char *section, const char *variable, const char *env_var_name, int default_value)
	Get integer configuration value.
bool	g_GetConfigFlag (const char *section, const char *variable, const char *env_var_name, bool default_value)
	Get boolean configuration value.

---