Tonido::Misc::IniConfigManager Class Reference

Manages Configuration Information. More...

List of all members.

Public Types
typedef boost::shared_ptr < IniConfigManager >	SharedPtr
Public Member Functions
	IniConfigManager (void)
	Ctor.
	~IniConfigManager (void)
	Dtor.
void	openDB (const std::string &a_database, const std::string &a_password)
	Opens the IniConfig DB.
std::string	getConfigValue (const std::string &a_key, const std::string &a_name, const std::string &a_defaultVal)
	Gets the config value associated with the specified key and name.
bool	doesConfigExist (const std::string &a_key, const std::string &a_name)
	Indicates if the given configuration setting exists for a given key, name.
void	setConfigValue (const std::string &a_key, const std::string &a_name, const std::string &a_value)
	Sets the config value associated with the specified key, name.
void	init ()
	inits the IniConfigManager. Must be called first after construction

---

Detailed Description

Manages Configuration Information.

---

Constructor & Destructor Documentation

Tonido::Misc::IniConfigManager::IniConfigManager

(

void

)

Ctor.

details if needed ...

Tonido::Misc::IniConfigManager::~IniConfigManager

(

void

)

Dtor.

details if needed ...

---

Member Function Documentation

bool Tonido::Misc::IniConfigManager::doesConfigExist	(	const std::string &	a_key,
		const std::string &	a_name
	)

Indicates if the given configuration setting exists for a given key, name.

Parameters:

[in]	a_key	represents the key part of the key, name pair used to identify a value
[in]	a_name	represents the name in the key, name pair

Returns:

true if the configuration associated with key, name exists, false otherwise

std::string Tonido::Misc::IniConfigManager::getConfigValue	(	const std::string &	a_key,
		const std::string &	a_name,
		const std::string &	a_defaultVal
	)

Gets the config value associated with the specified key and name.

Parameters:

[in]	a_key	represents the key part of the key, name pair used to identify a value
[in]	a_name	represents the name in the key, name pair
[in]	a_defaultVal	represents the default value if the setting cannot be found

Returns:

the configuration value associated with the key, name

void Tonido::Misc::IniConfigManager::init

(

)

inits the IniConfigManager. Must be called first after construction

Returns:

none

void Tonido::Misc::IniConfigManager::setConfigValue	(	const std::string &	a_key,
		const std::string &	a_name,
		const std::string &	a_value
	)

Sets the config value associated with the specified key, name.

Parameters:

[in]	a_key	represents the key part of the key, name pair used to identify a value
[in]	a_name	represents the name in the key, name pair
[in]	a_value	represents the value to be set

Returns:

none