Classes | Public Member Functions | Static Public Member Functions

zeus::TSettingsManager Class Reference

#include <SettingsManager.h>

Inheritance diagram for zeus::TSettingsManager:
zeus::TZObject zeus::ISettingsManager zeus::IZUnknown zeus::IPropertyAccess zeus::IZUnknown

List of all members.

Classes

class  TUserData

Public Member Functions

TUserData & getUserData ()
void setPropertyInterface (IPropertyAccess &rIface)
Retval setUserXMLFile (const IString &rFileName)
Retval setUserXMLFile (TXMLFile &rFile)
void releaseSourceInterfaces ()
void releasePropertyInterfaces ()
void releaseUserXMLFile ()
void releaseDelegationInterface ()
void setDelegationInterface (ISettingsManager &rIface)
TString completePathProperty (const TString &strPropName, const TString &strBasePath, bool bCreate=false)
Retval readBoolProperty (const IString &rKey, bool &rValue, bool bDefault=false)
Retval readIntProperty (const IString &rKey, Int &rValue, Int iDefault=0)
Retval readUintProperty (const IString &rKey, Uint &rValue, Uint uiDefault=0)
Retval readFloatProperty (const IString &rKey, Float &rValue, Float fDefault=0.0)
Retval readStringProperty (const IString &rKey, IString &rValue, TString strDefault=L"")
Retval readBoolProperty (const wchar_t *pKey, bool &rValue, bool bDefault=false)
Retval readIntProperty (const wchar_t *pKey, Int &rValue, Int iDefault=0)
Retval readUintProperty (const wchar_t *pKey, Uint &rValue, Uint uiDefault=0)
Retval readFloatProperty (const wchar_t *pKey, Float &rValue, Float fDefault=0.0)
Retval readStringProperty (const wchar_t *pKey, IString &rValue, TString strDefault=L"")
Retval writeBoolProperty (const IString &rKey, bool bValue)
Retval writeIntProperty (const IString &rKey, Int iValue)
Retval writeUintProperty (const IString &rKey, Uint uiValue)
Retval writeFloatProperty (const IString &rKey, Float fValue)
Retval writeStringProperty (const IString &rKey, const IString &rValue)
Retval writeBoolProperty (const wchar_t *pKey, bool bValue)
Retval writeIntProperty (const wchar_t *pKey, Int iValue)
Retval writeUintProperty (const wchar_t *pKey, Uint uiValue)
Retval writeFloatProperty (const wchar_t *pKey, Float fValue)
Retval writeStringProperty (const wchar_t *pKey, const IString &rValue)
virtual Retval MQUALIFIER getUserDocument (NAMESPACE_Zeus::IXMLDocument *&rpDocument) const
virtual void MQUALIFIER notifyObservers ()
virtual void MQUALIFIER attach (INotifyObserver &rObserver)
virtual void MQUALIFIER detach (INotifyObserver &rObserver)
virtual Retval MQUALIFIER addProperty (const IString &rName, const IString &rValue)
virtual bool MQUALIFIER existsProperty (const IString &rName) const
virtual void MQUALIFIER getPropertyNames (IStringList &rList) const
virtual void MQUALIFIER getPropertyNamesByNameSpace (const IString &rNameSpace, IStringList &rList) const
virtual Retval MQUALIFIER getPropertyValue (const IString &rName, IString &rValue) const
virtual Retval MQUALIFIER setPropertyValue (const IString &rName, const IString &rValue)
virtual Retval MQUALIFIER getPropertyPathValue (const IString &rName, IString &rValue) const
virtual Retval MQUALIFIER getPropertyFileValue (const IString &rName, IString &rValue) const
virtual Retval MQUALIFIER askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)
virtual void MQUALIFIER addRef () const
virtual void MQUALIFIER release () const

Static Public Member Functions

static TSettingsManager & getInstance ()

Detailed Description

Der SettingManager implementiert ein Singleton Pattern und dient der Kapslung der Systemeinstellungen

Member Function Documentation

Retval MQUALIFIER TSettingsManager::addProperty ( const IString &  rName,
const IString &  rValue 
) [virtual]
See also:
IPropertyAccess::addProperty

Implements zeus::IPropertyAccess.

virtual void MQUALIFIER zeus::TSettingsManager::addRef (  ) const [virtual]
See also:
IZUnknown::addRef

Reimplemented from zeus::TZObject.

virtual Retval MQUALIFIER zeus::TSettingsManager::askForInterface ( const InterfaceID &  rInterfaceID,
IZUnknown *&  rpIface 
) [virtual]
See also:
IZUnknown::askForInterface

Reimplemented from zeus::TZObject.

void MQUALIFIER TSettingsManager::attach ( INotifyObserver &  rObserver ) [virtual]
See also:
ISettingsManager::attach

Implements zeus::ISettingsManager.

TString TSettingsManager::completePathProperty ( const TString &  strPropName,
const TString &  strBasePath,
bool  bCreate = false 
)

Completes a directory property

Parameters:
strPropName: Name of the property
strBasePath: Base path of the relative directory
bCreate,:If flag is set and the path does not exists -> create path
void MQUALIFIER TSettingsManager::detach ( INotifyObserver &  rObserver ) [virtual]
See also:
ISettingsManager::detach

Implements zeus::ISettingsManager.

bool MQUALIFIER TSettingsManager::existsProperty ( const IString &  rName ) const [virtual]
See also:
IPropertyAccess::existsProperty

Implements zeus::IPropertyAccess.

TSettingsManager & zeus::TSettingsManager::getInstance (  ) [inline, static]

Returns the singleton Object

Retval MQUALIFIER TSettingsManager::getPropertyFileValue ( const IString &  rName,
IString &  rValue 
) const [virtual]
See also:
IPropertyAccess::getPropertyFileValue

Implements zeus::IPropertyAccess.

void MQUALIFIER TSettingsManager::getPropertyNames ( IStringList &  rList ) const [virtual]
See also:
IPropertyAccess::getPropertyNames

Implements zeus::IPropertyAccess.

void MQUALIFIER TSettingsManager::getPropertyNamesByNameSpace ( const IString &  rNameSpace,
IStringList &  rList 
) const [virtual]
See also:
IPropertyAccess::getPropertyNames

Implements zeus::IPropertyAccess.

Retval MQUALIFIER TSettingsManager::getPropertyPathValue ( const IString &  rName,
IString &  rValue 
) const [virtual]
See also:
IPropertyAccess::getPropertyPathValue

Implements zeus::IPropertyAccess.

Retval MQUALIFIER TSettingsManager::getPropertyValue ( const IString &  rName,
IString &  rValue 
) const [virtual]
See also:
IPropertyAccess::getPropertyValue

Implements zeus::IPropertyAccess.

TSettingsManager::TUserData & zeus::TSettingsManager::getUserData (  ) [inline]

Returns the user data object

Retval MQUALIFIER TSettingsManager::getUserDocument ( NAMESPACE_Zeus::IXMLDocument *&  rpDocument ) const [virtual]
See also:
ISettingsManager::getUserDocument

Implements zeus::ISettingsManager.

void MQUALIFIER TSettingsManager::notifyObservers (  ) [virtual]
See also:
ISettingsManager::notifyObservers

Implements zeus::ISettingsManager.

Retval zeus::TSettingsManager::readBoolProperty ( const wchar_t *  pKey,
bool &  rValue,
bool  bDefault = false 
) [inline]
Retval zeus::TSettingsManager::readBoolProperty ( const IString &  rKey,
bool &  rValue,
bool  bDefault = false 
) [inline]

reads a bool value out of the property file

Parameters:
rKey: Key to read
rValue: return parameter
bDefault: Default value
Return values:
RET_NOERROR: Value assigned
RET_REQUEST_FAILED: Could not assign value (default assigned)
Retval zeus::TSettingsManager::readFloatProperty ( const wchar_t *  pKey,
Float &  rValue,
Float  fDefault = 0.0 
) [inline]
Retval zeus::TSettingsManager::readFloatProperty ( const IString &  rKey,
Float &  rValue,
Float  fDefault = 0.0 
) [inline]

reads a float value out of the property file

Parameters:
rKey: Key to read
rValue: return parameter
fDefault: Default value
Return values:
RET_NOERROR: Value assigned
RET_REQUEST_FAILED: Could not assign value (default assigned)
Retval zeus::TSettingsManager::readIntProperty ( const wchar_t *  pKey,
Int &  rValue,
Int  iDefault = 0 
) [inline]
Retval zeus::TSettingsManager::readIntProperty ( const IString &  rKey,
Int &  rValue,
Int  iDefault = 0 
) [inline]

reads an integer value out of the property file

Parameters:
rKey: Key to read
rValue: return parameter
iDefault: Default value
Return values:
RET_NOERROR: Value assigned
RET_REQUEST_FAILED: Could not assign value (default assigned)
Retval TSettingsManager::readStringProperty ( const IString &  rKey,
IString &  rValue,
TString  strDefault = L"" 
)

reads a string value out of the property file

Parameters:
rKey: Key to read
rValue: return parameter
strDefault: Default value
Return values:
RET_NOERROR: Value assigned
RET_REQUEST_FAILED: Could not assign value (default assigned)
Retval zeus::TSettingsManager::readStringProperty ( const wchar_t *  pKey,
IString &  rValue,
TString  strDefault = L"" 
) [inline]
Retval zeus::TSettingsManager::readUintProperty ( const wchar_t *  pKey,
Uint &  rValue,
Uint  uiDefault = 0 
) [inline]
Retval zeus::TSettingsManager::readUintProperty ( const IString &  rKey,
Uint &  rValue,
Uint  uiDefault = 0 
) [inline]

reads an unsigned integer value out of the property file

Parameters:
rKey: Key to read
rValue: return parameter
uiDefault: Default value
Return values:
RET_NOERROR: Value assigned
RET_REQUEST_FAILED: Could not assign value (default assigned)
virtual void MQUALIFIER zeus::TSettingsManager::release (  ) const [virtual]
See also:
IZUnknown::release

Reimplemented from zeus::TZObject.

void TSettingsManager::releaseDelegationInterface (  )

releases a delegation interface

void TSettingsManager::releasePropertyInterfaces (  )

releases the property source interface

void TSettingsManager::releaseSourceInterfaces (  )

releases all source interfaces (xml file and property file

void TSettingsManager::releaseUserXMLFile (  )

releases the user data file

void TSettingsManager::setDelegationInterface ( ISettingsManager &  rIface )

Sets a new delegation interface and initializes the user data object

void TSettingsManager::setPropertyInterface ( IPropertyAccess &  rIface )

Sets the property source interface. This could be a PropertyFile instance

Retval MQUALIFIER TSettingsManager::setPropertyValue ( const IString &  rName,
const IString &  rValue 
) [virtual]
See also:
IPropertyAccess::setPropertyValue

Implements zeus::IPropertyAccess.

Retval TSettingsManager::setUserXMLFile ( TXMLFile &  rFile )

Sets the user data xml file. This method can be called for the base singleton only

Parameters:
rFile: sets an external XML file containing the user data
Return values:
RET_NOERROR: file successfully set
RET_REQUEST_FAILED: could not set the file to a delegated manager.
Retval TSettingsManager::setUserXMLFile ( const IString &  rFileName )

Sets the user data xml file. This method can be called for the base singleton only

Parameters:
rFileName: file name of the user data file.
Return values:
RET_NOERROR: file successfully set
RET_REQUEST_FAILED: could not set the file to a delegated manager.
Retval zeus::TSettingsManager::writeBoolProperty ( const wchar_t *  pKey,
bool  bValue 
) [inline]
Retval zeus::TSettingsManager::writeBoolProperty ( const IString &  rKey,
bool  bValue 
) [inline]

writes a bool value to the property file

Parameters:
rKey: Key to read
bValue: Value to set
Return values:
RET_NOERROR: Value set
RET_REQUEST_FAILED: Could not set value
Retval zeus::TSettingsManager::writeFloatProperty ( const IString &  rKey,
Float  fValue 
) [inline]

writes a float value to the property file

Parameters:
rKey: Key to read
fValue: Value to set
Return values:
RET_NOERROR: Value set
RET_REQUEST_FAILED: Could not set value
Retval zeus::TSettingsManager::writeFloatProperty ( const wchar_t *  pKey,
Float  fValue 
) [inline]
Retval zeus::TSettingsManager::writeIntProperty ( const wchar_t *  pKey,
Int  iValue 
) [inline]
Retval zeus::TSettingsManager::writeIntProperty ( const IString &  rKey,
Int  iValue 
) [inline]

writes an integer value to the property file

Parameters:
rKey: Key to read
iValue: Value to set
Return values:
RET_NOERROR: Value set
RET_REQUEST_FAILED: Could not set value
Retval zeus::TSettingsManager::writeStringProperty ( const IString &  rKey,
const IString &  rValue 
) [inline]

writes a string value to the property file

Parameters:
rKey: Key to read
rValue: Value to set
Return values:
RET_NOERROR: Value set
RET_REQUEST_FAILED: Could not set value
Retval zeus::TSettingsManager::writeStringProperty ( const wchar_t *  pKey,
const IString &  rValue 
) [inline]
Retval zeus::TSettingsManager::writeUintProperty ( const wchar_t *  pKey,
Uint  uiValue 
) [inline]
Retval zeus::TSettingsManager::writeUintProperty ( const IString &  rKey,
Uint  uiValue 
) [inline]

writes an unsigned integer value to the property file

Parameters:
rKey: Key to read
uiValue: Value to set
Return values:
RET_NOERROR: Value set
RET_REQUEST_FAILED: Could not set value
The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Sun Jan 22 2012 15:28:40