makVrv::DtSettingsChangeManager Class Reference

makVrv::DtSettingsChangeManager class will manage change objects that listen to various system signals and perform changes to classes based on those signals. An example of this is the DtSchemaRenamedChange class. When a schema is renamed, this class will make sure to do the appropriate changes to the appropriate classes (e.g. rename the schema of a model definition). Each change class will have a type that other classes can use to hook into this manager for to get notified when something changes.

While this class is, itself, threadsafe. It might contain objects that are not (the schema renaming one, as an example).

Inheritance diagram for makVrv::DtSettingsChangeManager:

Public Types
typedef boost::function< bool(const std::string &, DtSettingsChangeObject::UseType, std::string &)>	DtSettingInUseFunction
typedef std::vector < DtSettingInUseFunction >	DtSettingsInUse
typedef std::vector < DtSettingsChangeObject * >	DtSettingsChangedList

Public Member Functions
virtual	~DtSettingsChangeManager ()
virtual void	addSettingsChangeObject (DtSettingsChangeObject *)
virtual void	removeSettingsChangeObject (DtSettingsChangeObject *)
virtual DtSettingsChangedList	changeObjectsFor (DtSettingsChangeObject::SettingsChangeType) const
virtual void	addSettingInUseCheck (const DtSettingInUseFunction &f)
virtual bool	settingInUse (const std::string &setting, DtSettingsChangeObject::UseType, std::string &inUse) const
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtSettingsChangeManager &	instance (DtDe &de)
static const std::string &	className ()

Protected Types
typedef std::map < DtSettingsChangeObject::SettingsChangeType, DtSettingsChangedList >	DtSettingsChangedMap

Protected Member Functions
virtual void	settingsObjectInvoked (DtSettingsChangeObject *)
	DtSettingsChangeManager (DtDe &)

Protected Attributes
DtSettingsChangedMap	mySettings
DtSettingsInUse	mySettingsInUseChecks
DtDe &	myDe
boost::mutex	myMonitor

Member Typedef Documentation

typedef boost::function<bool (const std::string&, DtSettingsChangeObject::UseType, std::string&)> makVrv::DtSettingsChangeManager::DtSettingInUseFunction

typedef std::vector<DtSettingInUseFunction> makVrv::DtSettingsChangeManager::DtSettingsInUse

typedef std::vector<DtSettingsChangeObject*> makVrv::DtSettingsChangeManager::DtSettingsChangedList

typedef std::map<DtSettingsChangeObject::SettingsChangeType, DtSettingsChangedList> makVrv::DtSettingsChangeManager::DtSettingsChangedMap

protected

Constructor & Destructor Documentation

virtual makVrv::DtSettingsChangeManager::~DtSettingsChangeManager ( )

virtual

makVrv::DtSettingsChangeManager::DtSettingsChangeManager ( DtDe &  )

protected

CTOR.

Member Function Documentation

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

static

Get an instance of the settings manager.

virtual void makVrv::DtSettingsChangeManager::addSettingsChangeObject ( DtSettingsChangeObject *  )

virtual

Once the new settings change type is added, this class will take ownership of the memory and will delete it if replaced by a like settings change type.

virtual void makVrv::DtSettingsChangeManager::removeSettingsChangeObject ( DtSettingsChangeObject *  )

virtual

Removes settings change object. Memory for that object will be freed.

virtual DtSettingsChangedList makVrv::DtSettingsChangeManager::changeObjectsFor ( DtSettingsChangeObject::SettingsChangeType  ) const

virtual

Returns a list of all objects of a given type.

static const std::string& makVrv::DtSettingsChangeManager::className ( )

static

virtual void makVrv::DtSettingsChangeManager::addSettingInUseCheck ( const DtSettingInUseFunction &  f )

virtual

When checking to see if a particular setting is in use, this function will be called as a check.

virtual bool makVrv::DtSettingsChangeManager::settingInUse ( const std::string &  setting, DtSettingsChangeObject::UseType  , std::string &  inUse  ) const

virtual

Checks all settings in use function and returns true on the first match with an optional argument to print messages if something is in use.

virtual void makVrv::DtSettingsChangeManager::settingsObjectInvoked ( DtSettingsChangeObject *  )

protectedvirtual

Called when a status object has been invoked, emit signal through signaler.

Member Data Documentation

DtSettingsChangedMap makVrv::DtSettingsChangeManager::mySettings

protected

DtSettingsInUse makVrv::DtSettingsChangeManager::mySettingsInUseChecks

protected

DtDe& makVrv::DtSettingsChangeManager::myDe

protected

boost::mutex makVrv::DtSettingsChangeManager::myMonitor

mutableprotected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtSettingsChangeManager.h