DtVrfSettingsManager Class Reference

Inheritance diagram for DtVrfSettingsManager:

Public Member Functions
	DtVrfSettingsManager (DtVrfMessageInterface *msgIf, std::string simSettingsPath)
	Constructor. More...
	DtVrfSettingsManager (DtVrfMessageInterface *msgIf)
	Constructor. More...
	~DtVrfSettingsManager ()
	Destructor. More...
virtual void	init ()
	Registers for DtIfModifySetting and DtIfRequestSetting. More...
void	publishSetting (const std::string &settingName)
	Looks up (thereby implicity updating) the DtSettingsObject corresponding to the given name and if is found, publishes it on the network in a DtIfSetting message. More...
virtual bool	setSetting (const DtSettingsObject *settingsObject)
	Updates an existing DtSettingsObject from the one provided by using its setFrom method. More...
virtual void	registerConsumer (std::string name, DtSettingsConsumerFcn consumerFcn, void *usr=0)
	DtSettingsConsumerFcn's are called whenever a named DtSettingsObject changes. More...
virtual void	unregisterConsumer (std::string name, DtSettingsConsumerFcn consumerFcn, void *usr=0)
Public Member Functions inherited from DtSettingsManager
	DtSettingsManager (const std::string &filename)
	~DtSettingsManager ()
virtual bool	read ()
virtual bool	write ()
virtual const DtSettingsObject *	lookupSetting (const std::string &name)
virtual std::list< std::string >	settingsMapKeys ()
virtual void	registerProducer (const std::string &type, const std::string &name, DtSettingsProducerFcn producerFcn, void *usr=0)
virtual void	unregisterProducer (const std::string &type, const std::string &name, DtSettingsProducerFcn producerFcn, void *usr=0)
virtual void	registerConsumer (const std::string &name, DtSettingsConsumerFcn consumerFcn, void *usr=0)
virtual void	unregisterConsumer (const std::string &name, DtSettingsConsumerFcn consumerFcn, void *usr=0)
virtual void	addIndependentBool (const std::string &name, bool value)
virtual void	addIndependentInt (const std::string &name, int value)
virtual void	addIndependentDouble (const std::string &name, double value)
virtual void	addIndependentString (const std::string &name, const std::string &value)

Static Public Member Functions
static void	modifySettingCallback (DtSimMessage *msg, void *usr)
	Registered for receipt of DtIfModifySetting messages. More...
static void	requestSettingCallback (DtSimMessage *msg, void *usr)
	Registered for receipt of DtIfRequestSetting messages. More...
Static Public Member Functions inherited from DtSettingsManager
static DtSettingsObjectFactory *	factory ()
static void	setFactory (DtSettingsObjectFactory *factory)

Protected Attributes
DtVrfMessageInterface *	myMessageInterface
Protected Attributes inherited from DtSettingsManager
std::string	myFilename
DtSettingsMap	mySettingsMap
DtSettingsProducersMap	myProducersMap
DtSettingsConsumersMultiMap	myConsumersMultiMap
tbb::mutex	myConsumerMutex
tbb::recursive_mutex	myProducerMutex

Additional Inherited Members
Static Protected Attributes inherited from DtSettingsManager
static DtSettingsObjectFactory *	theSettingsObjectFactory

Constructor & Destructor Documentation

DtVrfSettingsManager::DtVrfSettingsManager	(	DtVrfMessageInterface *	msgIf,
		std::string	simSettingsPath
	)

Constructor.

DtVrfSettingsManager::DtVrfSettingsManager

(

DtVrfMessageInterface *

msgIf

)

Constructor.

DtVrfSettingsManager::~DtVrfSettingsManager

(

)

Destructor.

Member Function Documentation

virtual void DtVrfSettingsManager::init ( )

virtual

Registers for DtIfModifySetting and DtIfRequestSetting.

Calls down to DtSettingsManager::init().

Reimplemented from DtSettingsManager.

Reimplemented in DtVrfSimSettingsManager, and MySettingsManager.

static void DtVrfSettingsManager::modifySettingCallback ( DtSimMessage *  msg, void *  usr  )

static

Registered for receipt of DtIfModifySetting messages.

static void DtVrfSettingsManager::requestSettingCallback ( DtSimMessage *  msg, void *  usr  )

static

Registered for receipt of DtIfRequestSetting messages.

void DtVrfSettingsManager::publishSetting

(

const std::string &

settingName

)

Looks up (thereby implicity updating) the DtSettingsObject corresponding to the given name and if is found, publishes it on the network in a DtIfSetting message.

virtual void DtVrfSettingsManager::registerConsumer ( std::string  name, DtSettingsConsumerFcn  consumerFcn, void *  usr = 0  )

virtual

DtSettingsConsumerFcn's are called whenever a named DtSettingsObject changes.

The arguments are copied into a DtSettingsConsumer used to update the myConsumersMultiMap.

virtual void DtVrfSettingsManager::unregisterConsumer ( std::string  name, DtSettingsConsumerFcn  consumerFcn, void *  usr = 0  )

virtual

virtual bool DtVrfSettingsManager::setSetting ( const DtSettingsObject *  settingsObject )

virtual

Updates an existing DtSettingsObject from the one provided by using its setFrom method.

If there is no DtSettingsObject in the DtSettingsMap whose name corresponds to the name of the object provided, or if their types do not match, false is returned and the setting is left unchanged.

Reimplemented from DtSettingsManager.

Member Data Documentation

DtVrfMessageInterface* DtVrfSettingsManager::myMessageInterface

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfcore/vrfSettingsManager.h