makVrv::DtDeSettingsManager Class Reference

A manager of all of the settings. More...

Inheritance diagram for makVrv::DtDeSettingsManager:

Public Member Functions
virtual	~DtDeSettingsManager ()
	DTOR.
void	createSettings (const std::string &settingsType, const std::string &settingsExt)
	Create a settings object with a name and extension.
DtDeSettings *	findSettings (const std::string &settingsType)
	Get the settings object for a particular settings type.
DtDeSettings *	findSettingsByExtension (const std::string &settingsEx)
	Get the settings object for a particular settings type by it's extension.
void	registerSettings (DtDeSettings *settings)
	Register a settings object Use createSettings instead whenever possible; if it's absolutely necessary to use a custom DtDeSettings subclass, use this method to register it instead.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtDeSettingsManager &	instance (DtDe &de)
	Get an instance of the settings manager.

Protected Types
typedef std::map< std::string, DtDeSettings * >	SettingsMap
typedef std::map< std::string, std::string >	SettingsToFileMap

Protected Member Functions
	DtDeSettingsManager (DtDe &)
	CTOR.

Protected Attributes
DtDe &	myDe
SettingsMap	mySettings

Detailed Description

A manager of all of the settings.

Member Typedef Documentation

typedef std::map<std::string,DtDeSettings*> makVrv::DtDeSettingsManager::SettingsMap

protected

typedef std::map<std::string, std::string> makVrv::DtDeSettingsManager::SettingsToFileMap

protected

Constructor & Destructor Documentation

virtual makVrv::DtDeSettingsManager::~DtDeSettingsManager ( )

virtual

DTOR.

makVrv::DtDeSettingsManager::DtDeSettingsManager ( DtDe &  )

protected

CTOR.

Member Function Documentation

static DtDeSettingsManager& makVrv::DtDeSettingsManager::instance ( DtDe &  de )

static

Get an instance of the settings manager.

Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::DtCommonBaseSettingsManager(), makVrv::DtRecordSettingsBackupInterface::DtRecordSettingsBackupInterface(), and makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::settings().

void makVrv::DtDeSettingsManager::createSettings	(	const std::string &	settingsType,
		const std::string &	settingsExt
	)

Create a settings object with a name and extension.

Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::DtCommonBaseSettingsManager().

DtDeSettings* makVrv::DtDeSettingsManager::findSettings

(

const std::string &

settingsType

)

Get the settings object for a particular settings type.

If the Settings of the given type does not exist it returns a null pointer.

Warning

Do not delete this pointer.

Referenced by makVrv::DtRecordSettingsBackupInterface::DtRecordSettingsBackupInterface(), and makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::settings().

DtDeSettings* makVrv::DtDeSettingsManager::findSettingsByExtension

(

const std::string &

settingsEx

)

Get the settings object for a particular settings type by it's extension.

If the Settings of the given type does not exist it returns a null pointer.

Warning

Do not delete this pointer.

void makVrv::DtDeSettingsManager::registerSettings

(

DtDeSettings *

settings

)

Register a settings object Use createSettings instead whenever possible; if it's absolutely necessary to use a custom DtDeSettings subclass, use this method to register it instead.

Transfers ownership.

Member Data Documentation

DtDe& makVrv::DtDeSettingsManager::myDe

protected

SettingsMap makVrv::DtDeSettingsManager::mySettings

protected

---

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

• include/vrvCore/DtDeSettingsManager.h