Simias::Client::Configuration Class Reference

Configuration class for simias components. More...

List of all members.

Public Member Functions
	Configuration ()
	Constructor.
XmlElement	GetElement (string key)
	Returns the XmlElement for the specified key. Creates the key if does not exist.
XmlElement	GetElement (string section, string key)
	Returns the XmlElement for the specified key.
string	Get (string key)
	Returns the value for the specified key.
string	Get (string section, string key)
	Returns the value for the specified key.
bool	Exists (string key)
	Checks for existence of a specified key.
bool	Exists (string section, string key)
	Checks for existence of a specified section and key.
Properties
string	ConfigPath [get]
	Called to get the path where Simias.config is installed.
string	StorePath [get]
	Called to get the path where simias is installed.

---

Detailed Description

Configuration class for simias components.

---

Constructor & Destructor Documentation

Simias::Client::Configuration::Configuration

(

)

[inline]

Constructor.

---

Member Function Documentation

XmlElement Simias::Client::Configuration::GetElement

(

string

key

)

[inline]

Returns the XmlElement for the specified key. Creates the key if does not exist.

Parameters:

key

The key to return.

Returns:

The key as an XmlElement.

XmlElement Simias::Client::Configuration::GetElement	(	string	section,
		string	key
	)			[inline]

Returns the XmlElement for the specified key.

Parameters:

	section	The section where the key is stored.
	key	The key to return.

Returns:

The key as an XmlElement or a null if the section or key does not exist.

string Simias::Client::Configuration::Get

(

string

key

)

[inline]

Returns the value for the specified key.

Parameters:

key

The key to get the value for.

Returns:

The value as a string or a null if the key does not exist.

string Simias::Client::Configuration::Get	(	string	section,
		string	key
	)			[inline]

Returns the value for the specified key.

Parameters:

	section	The section where the key exists.
	key	The key to get the value for.

Returns:

The value as a string or a null if the section and key do not exist.

bool Simias::Client::Configuration::Exists

(

string

key

)

[inline]

Checks for existence of a specified key.

Parameters:

key

The key to check for existence.

Returns:

True if the key exists, otherwise false is returned.

bool Simias::Client::Configuration::Exists	(	string	section,
		string	key
	)			[inline]

Checks for existence of a specified section and key.

Parameters:

	section	The section for the tuple
	key	The key to set.

Returns:

True if the section and key exists, otherwise false is returned.

---

Property Documentation

string Simias::Client::Configuration::ConfigPath [get]

Called to get the path where Simias.config is installed.

string Simias::Client::Configuration::StorePath [get]

Called to get the path where simias is installed.

---

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

• src/core/SimiasClient/Configuration.cs