_Wolframe::config::Parser Class Reference

Configuration parser for parsing the tokens of the configuration. More...

#include <valueParser.hpp>

Classes
class	BaseTypeDomain
	Describes a domain without value restriction except the one given by the C++ value type itself. More...
class	BoolDomain
	Describes the value domain of a boolean value as enumeration of all possible values. More...
class	EnumDomain
	Describes a value domain for an enumerable fixed set of values. More...
struct	NonEmptyDomain
class	RangeDomain
	Describes a value domain for a range of values. More...

Public Types
typedef std::string	string

Static Public Member Functions
template<typename Value , class Domain >
static bool	getValue (const char *module, const char *name, const string &token, Value &value, const Domain &domain, bool *isDefined=0)
	Get the value of a configration token with a domain restriction that is checked. More...
template<typename Value >
static bool	getValue (const char *module, const char *name, const string &token, Value &value, bool *isDefined=0)
	Get the value of a configration token without additional domain restriction. More...
template<typename Value , class Domain >
static bool	getValue (const char *module, const std::pair< const std::string, const types::PropertyTree::Node > &decl, Value &value, const Domain &domain, bool *isDefined=0)
	Get the value of a configration token with a domain restriction that is checked. More...
template<typename Value >
static bool	getValue (const char *module, const std::pair< const std::string, const types::PropertyTree::Node > &decl, Value &value, bool *isDefined=0)
	Get the value of a configration token without additional domain restriction. More...

Static Private Member Functions
static const std::string	loggingScope (const char *scope)
	Return the header of a configuration parse error message issued, specifying the definition scope of the variable value parsed. More...

Detailed Description

Configuration parser for parsing the tokens of the configuration.

Member Typedef Documentation

typedef std::string _Wolframe::config::Parser::string

Member Function Documentation

template<typename Value , class Domain >

static bool _Wolframe::config::Parser::getValue ( const char *  module, const char *  name, const string &  token, Value &  value, const Domain &  domain, bool *  isDefined = 0  )

inlinestatic

Get the value of a configration token with a domain restriction that is checked.

Template Parameters

Value	type of the returned value
Domain	domain of the returned value to check

Parameters

[in]	module	identifier of the current configuration scope
[in]	name	name of the element in the configuration
[in]	token	string value of the element in the configuration
[out]	value	returned value of the token
[in]	domain	domain of the parsed value
[in,out]	isDefined	(optional) flag that is set when the value is defined.

Returns

bool true, if success, else false

template<typename Value >

static bool _Wolframe::config::Parser::getValue ( const char *  module, const char *  name, const string &  token, Value &  value, bool *  isDefined = 0  )

inlinestatic

Get the value of a configration token without additional domain restriction.

Template Parameters

Value

type of the returned value

Parameters

[in]	module	identifier of the current configuration scope
[in]	name	name of the element in the configuration
[in]	token	string value of the element in the configuration
[out]	value	returned value of the token
[in,out]	isDefined	(optional) flag that is set when the value is defined.

Returns

bool true, if success, else false

template<typename Value , class Domain >

static bool _Wolframe::config::Parser::getValue ( const char *  module, const std::pair< const std::string, const types::PropertyTree::Node > &  decl, Value &  value, const Domain &  domain, bool *  isDefined = 0  )

inlinestatic

Get the value of a configration token with a domain restriction that is checked.

Template Parameters

Value	type of the returned value
Domain	domain of the returned value to check

Parameters

[in]	module	identifier of the current configuration scope
[in]	decl	name,token tuple representing an element definition in the configuration
[out]	value	returned value of the token
[in]	domain	domain of the parsed value
[in,out]	isDefined	(optional) flag that is set when the value is defined.

Returns

bool true, if success, else false

template<typename Value >

static bool _Wolframe::config::Parser::getValue ( const char *  module, const std::pair< const std::string, const types::PropertyTree::Node > &  decl, Value &  value, bool *  isDefined = 0  )

inlinestatic

Get the value of a configration token without additional domain restriction.

Template Parameters

Value

type of the returned value

Parameters

[in]	module	identifier of the current configuration scope
[in]	decl	name,token tuple representing an element definition in the configuration
[out]	value	returned value of the token
[in,out]	isDefined	(optional) flag that is set when the value is defined.

Returns

bool true, if success, else false

static const std::string _Wolframe::config::Parser::loggingScope ( const char *  scope )

inlinestaticprivate

Return the header of a configuration parse error message issued, specifying the definition scope of the variable value parsed.

Parameters

[in]

scope

scope identifier

---

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

• include/config/valueParser.hpp