makVrv::DtDistributedEnvironmentSettingsManager Class Reference

Example Settings Manager. More...

Inheritance diagram for makVrv::DtDistributedEnvironmentSettingsManager:

Public Member Functions
virtual	~DtDistributedEnvironmentSettingsManager ()
	DTOR.
Setters/getters for settings
virtual void	setAllowSimEnvironmentEffectMessages (bool val)
	Sets whether to listen to sim environment effect messages or not.
virtual bool	allowSimEnvironmentEffectMessages () const
	Gets whether listening to sim environment effect messages or not.
Setting persistence methods
virtual void	setFromRecord (const makArchives::DtDistributedEnvironmentSettingsRecord &rec)
	Use the settings from the given settings record.
virtual void	getRecord (makArchives::DtDistributedEnvironmentSettingsRecord &rec) const
	Populate the given record with the current settings.
Public Member Functions inherited from makVrv::DtBaseSettingsManager< makArchives::DtDistributedEnvironmentSettingsRecord >
	DtBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
	CTOR.
virtual	~DtBaseSettingsManager ()
	Virtual DTOR.
virtual void	initializeBackup ()
	Creates a backup of the settings' current state.
Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtDistributedEnvironmentSettingsRecord >
	DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
	CTOR The name, displayName, and extension parameters are used for creating the settings object (DtDeSettings) and backup, and for constructing the filename when readin/writing the records to disk.
virtual	~DtCommonBaseSettingsManager ()
	Virtual DTOR.
virtual void	autoSaveIfNecessary ()
	Saves the current settings as defaults if autosave is enabled.
virtual void	setAutoSave (bool doit)
	Sets whether autosave is enabled for the settings manager.
virtual bool	autoSave () const
	Gets whether autosave is enabled for the settings manager.
virtual void	setUseDefaultSettingsRecord (bool useit)
	Sets whether setting initialization should check for a default record.
virtual bool	useDefaultSettingsRecord () const
	Gets whether setting initialization should check for a default record.
virtual DtDeSettings *	settings ()
	Accessor for the manager's DtDeSettings object.
virtual const DtDeSettings *	settings () const
	Accessor for the manager's DtDeSettings object (const).
virtual DtSettingsBackup *	settingsBackup ()
	Accessor for the manager's settings backup.
virtual const DtSettingsBackup *	settingsBackup () const
	Accessor for the manager's settings backup (const).
virtual void	loadDefaults ()
	Initializes the settings and creates a backup.
virtual void	saveDefaultSettings ()
	Saves the current settings' state as the default (on disk).
virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)
	Loads the default settings from disk.
virtual void	importSettings (const std::string &filePath)
	Load the settings' state from the given file.
virtual void	exportSettings (const std::string &filePath) const
	Save the current settings' state to the given file.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

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

Public Attributes
boost::signal< void(bool)>	signal_allowSimMessagesSet
	Boost signals for changed settings.

Protected Member Functions
	DtDistributedEnvironmentSettingsManager (DtDe &)
	Protected CTOR ( use instance(..) )

Protected Attributes
bool	myAllowSimEnvironmentEffectMessages

Friends
template<typename ManagerClass >
ManagerClass &	defaultManagerInstanceFunction (DtDe &, bool)
	Befriend the manager instance functions for instance retreival/creation.
template<typename ManagerClass >
void	defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *)
	Befriend the manager instance functions for instance retreival/creation.

Additional Inherited Members
Protected Types inherited from makVrv::DtBaseSettingsManager< makArchives::DtDistributedEnvironmentSettingsRecord >
typedef DtRecordSettingsBackup < DtBaseSettingsManager < makArchives::DtDistributedEnvironmentSettingsRecord > , makArchives::DtDistributedEnvironmentSettingsRecord >	RecordBackupType

Detailed Description

Example Settings Manager.

Constructor & Destructor Documentation

virtual makVrv::DtDistributedEnvironmentSettingsManager::~DtDistributedEnvironmentSettingsManager ( )

virtual

DTOR.

makVrv::DtDistributedEnvironmentSettingsManager::DtDistributedEnvironmentSettingsManager ( DtDe &  )

protected

Protected CTOR ( use instance(..) )

Member Function Documentation

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

static

Get an instance of the settings manager.

virtual void makVrv::DtDistributedEnvironmentSettingsManager::setAllowSimEnvironmentEffectMessages ( bool  val )

virtual

Sets whether to listen to sim environment effect messages or not.

virtual bool makVrv::DtDistributedEnvironmentSettingsManager::allowSimEnvironmentEffectMessages ( ) const

virtual

Gets whether listening to sim environment effect messages or not.

virtual void makVrv::DtDistributedEnvironmentSettingsManager::setFromRecord ( const makArchives::DtDistributedEnvironmentSettingsRecord &  rec )

virtual

Use the settings from the given settings record.

Implements makVrv::DtBaseSettingsManager< makArchives::DtDistributedEnvironmentSettingsRecord >.

virtual void makVrv::DtDistributedEnvironmentSettingsManager::getRecord ( makArchives::DtDistributedEnvironmentSettingsRecord &  rec ) const

virtual

Populate the given record with the current settings.

Implements makVrv::DtBaseSettingsManager< makArchives::DtDistributedEnvironmentSettingsRecord >.

Friends And Related Function Documentation

template<typename ManagerClass >

ManagerClass& defaultManagerInstanceFunction ( DtDe &  de, bool  allowedInSlave  )

friend

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

Befriend the manager instance functions for instance retreival/creation.

  Manager requirements:
  1) Static instance function
  2) Protected DtSignalConnectionManager named myConnections.
  3) Member functioned called loadDefaults which takes no arguments.
     and loads the default settings of the manager or factory from disk.
  4) define defaultManagerInstanceFunction as friend.
  5) define defaultManagerRegisterInstanceFunction as friend (see below).
  5) Protected Constructor which only takes a DtDe reference.
  @code 

class Manager { public: static Manager& instance(DtDe& de); void loadDefaults(); protected: template <typename managerclass>=""> friend ManagerClass& defaultManagerInstanceFunction(DtDe& de, bool); template <typename managerclass>=""> friend void defaultManagerRegisterInstanceFunction(DtDe& de, ManagerClass* mgr) Manager(DtDe&); DtSignalConnectionManager myConnections; };

  Then simply in the implementation of instance call 
  defaultManagerInstanceFunction with the de object and return the return
  value.
  @code 

Manager& Manager::instance(DtDe& de) { return defaultManagerInstanceFunction<Manager>(de); }

template<typename ManagerClass >

void defaultManagerRegisterInstanceFunction ( DtDe &  de, ManagerClass *  mgr  )

friend

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

Befriend the manager instance functions for instance retreival/creation.

  @code 

static void Manager::registerInstance(DtDe& de, Manager* mgr) { defaultManagerRegisterInstanceFunction(de,mgr); } ...else where call. // Assuming class NewManager : public Manager Manager::registerInstance(de,new NewManager(de));

Member Data Documentation

boost::signal<void (bool)> makVrv::DtDistributedEnvironmentSettingsManager::signal_allowSimMessagesSet

Boost signals for changed settings.

bool makVrv::DtDistributedEnvironmentSettingsManager::myAllowSimEnvironmentEffectMessages

protected

---

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

• include/vrvCore/DtDistributedEnvironmentSettingsManager.h