OpenMPCD::ImplementationDetails::Configuration::Setting Class Reference

Helper class to handle libconfig++ settings. More...

#include <Setting.hpp>

Static Public Member Functions
static void	createSetting (libconfig::Setting *const parent, const std::string &name, const bool value)
	Creates a new setting with the given value. More...
static void	createSetting (libconfig::Setting *const parent, const std::string &name, const int value)
	Creates a new setting with the given value. More...
static void	createSetting (libconfig::Setting *const parent, const std::string &name, const long long value)
	Creates a new setting with the given value. More...
static void	createSetting (libconfig::Setting *const parent, const std::string &name, const double value)
	Creates a new setting with the given value. More...
static void	createSetting (libconfig::Setting *const parent, const std::string &name, const std::string &value)
	Creates a new setting with the given value. More...
static void	createSetting (libconfig::Setting *const parent, const std::string &name, const char *const value)
	Creates a new setting with the given value. More...

Detailed Description

Helper class to handle libconfig++ settings.

Definition at line 29 of file Setting.hpp.

Member Function Documentation

createSetting() [1/6]

static void OpenMPCD::ImplementationDetails::Configuration::Setting::createSetting ( libconfig::Setting *const  parent, const std::string &  name, const bool  value  )

inlinestatic

Creates a new setting with the given value.

Exceptions

InvalidCallException

Throws if there already is an exception of the given name.

Parameters

[in,out]	parent	The parent setting.
[in]	name	The setting name.
[in]	value	The value for the new setting.

Definition at line 42 of file Setting.hpp.

createSetting() [2/6]

static void OpenMPCD::ImplementationDetails::Configuration::Setting::createSetting ( libconfig::Setting *const  parent, const std::string &  name, const char *const  value  )

inlinestatic

Creates a new setting with the given value.

Exceptions

InvalidCallException

Throws if there already is an exception of the given name.

Parameters

[in,out]	parent	The parent setting.
[in]	name	The setting name.
[in]	value	The value for the new setting.

Definition at line 117 of file Setting.hpp.

createSetting() [3/6]

static void OpenMPCD::ImplementationDetails::Configuration::Setting::createSetting ( libconfig::Setting *const  parent, const std::string &  name, const double  value  )

inlinestatic

Creates a new setting with the given value.

Exceptions

InvalidCallException

Throws if there already is an exception of the given name.

Parameters

[in,out]	parent	The parent setting.
[in]	name	The setting name.
[in]	value	The value for the new setting.

Definition at line 87 of file Setting.hpp.

createSetting() [4/6]

static void OpenMPCD::ImplementationDetails::Configuration::Setting::createSetting ( libconfig::Setting *const  parent, const std::string &  name, const int  value  )

inlinestatic

Creates a new setting with the given value.

Exceptions

InvalidCallException

Throws if there already is an exception of the given name.

Parameters

[in,out]	parent	The parent setting.
[in]	name	The setting name.
[in]	value	The value for the new setting.

Definition at line 57 of file Setting.hpp.

createSetting() [5/6]

static void OpenMPCD::ImplementationDetails::Configuration::Setting::createSetting ( libconfig::Setting *const  parent, const std::string &  name, const long long  value  )

inlinestatic

Creates a new setting with the given value.

Exceptions

InvalidCallException

Throws if there already is an exception of the given name.

Parameters

[in,out]	parent	The parent setting.
[in]	name	The setting name.
[in]	value	The value for the new setting.

Definition at line 72 of file Setting.hpp.

createSetting() [6/6]

static void OpenMPCD::ImplementationDetails::Configuration::Setting::createSetting ( libconfig::Setting *const  parent, const std::string &  name, const std::string &  value  )

inlinestatic

Creates a new setting with the given value.

Exceptions

InvalidCallException

Throws if there already is an exception of the given name.

Parameters

[in,out]	parent	The parent setting.
[in]	name	The setting name.
[in]	value	The value for the new setting.

Definition at line 102 of file Setting.hpp.

---

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

• Setting.hpp