Public Types | Public Member Functions
Tonido::Data::ConfigManager Class Reference

Manages the database to store configuration data. More...

List of all members.

Public Types

typedef boost::shared_ptr
< ConfigManager
SharedPtr

Public Member Functions

std::string getConfigValue (const std::string &a_key, const std::string &a_name, const std::string &a_defaultVal)
 getConfigValue
bool doesConfigExist (const std::string &a_key, const std::string &a_name)
 doesConfigExist
void setConfigValue (const std::string &a_key, const std::string &a_name, const std::string &a_value)
 setConfigValue

Detailed Description

Manages the database to store configuration data.


Member Function Documentation

bool Tonido::Data::ConfigManager::doesConfigExist ( const std::string &  a_key,
const std::string &  a_name 
)

doesConfigExist

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

Parameters:
[in]a_keyrepresents the key part of the key, name pair used to identify a value
[in]a_namerepresents the name in the key, name pair
Returns:
true if the configuration associated with key, name exists, false otherwise
std::string Tonido::Data::ConfigManager::getConfigValue ( const std::string &  a_key,
const std::string &  a_name,
const std::string &  a_defaultVal 
)

getConfigValue

Gets the config value associated with the specified key and name

Parameters:
[in]a_keyrepresents the key part of the key, name pair used to identify a value
[in]a_namerepresents the name in the key, name pair
[in]a_defaultValrepresents the default value if the setting cannot be found
Returns:
the configuration value associated with the key, name
void Tonido::Data::ConfigManager::setConfigValue ( const std::string &  a_key,
const std::string &  a_name,
const std::string &  a_value 
)

setConfigValue

Sets the config value associated with the specified key, name

Parameters:
[in]a_keyrepresents the key part of the key, name pair used to identify a value
[in]a_namerepresents the name in the key, name pair
[in]a_valuerepresents the value to be set
Returns:
none

Generated on Wed Oct 12 2011 21:46:53. © CodeLathe LLC 2007-2011. All Rights Reserved.