makVrf::DtVrfBackendSettingsManager Class Reference

The Master DtVrfBackendSettingsManager. More...

Inheritance diagram for makVrf::DtVrfBackendSettingsManager:

Public Member Functions
	DtVrfBackendSettingsManager (makVrv::DtDe &)
virtual	~DtVrfBackendSettingsManager ()
virtual void	monitorBackendSetting (const std::string &)
	Sets up to monitor the particular setting.
virtual void	requestBackendSetting (const std::string &, bool sendRequest=false, const DtSimulationAddress &addr=DtSimSendToAll)
	Request the value of a back-end setting from the DtVrfSimSettingsManager.
virtual void	stopMonitoringBackendSetting (const std::string &)
	Stops monitoring. If this is the last request, will not send a changed signal.
virtual void	sendSettings (const DtSettingsObject *, const DtSimulationAddress &addr=DtSimSendToAll)
	Modify the value of a back-end settings object.
virtual void	setDRThresholds (double translation, double rotation)
	General settings that can be sent to the back-end.
virtual void	setSpotReportsGloballyEnabled (bool enabled)
	Sets the global state of spot reports - all entities set to use the global setting (which is the default) will obey this value.
virtual void	setTDLMessagesGloballyEnabled (bool enabled)
	Sets the global state of TDL messages - all entities set to use the global setting (which is the default) will obey this value.
virtual void	setEngagementReportsGloballyEnabled (bool enabled)
	Sets the global state of engagement reports - all entities set to use the global setting (which is the default) will obey this value.
virtual void	setCommModelSettings (bool useExternalComms)
	Set the comm model settings to be used by entities that have radios.
virtual void	setRoadDrivingSettings (bool driveOnLeft)
	Set which side of the road entities drive on.
virtual void	setAutomaticAggregationDisaggregationEnabled (bool enabled)
	Sets whether or not automatic aggregation/disaggregation should be enabled.
virtual void	setPublishAggregateFormationRoutes (bool yesNo)
	Sets whether or not aggregate formation-following routes should be published.
virtual void	setPeriodicSnapshotSettings (bool enabled, double period, int numberOfSnapshotsToKeep)
	Sets whether or not periodic snapshots are enabled and the time period (simulation time in seconds) for marking a checkpoint.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtVrfBackendSettingsManager &	instance (makVrv::DtDe &de)
	Returns instance of the messager.

Public Attributes
boost::signal< void(const std::string &, const DtVrfBackendState *)>	signal_settingReceived

Protected Member Functions
virtual void	processSettingMessage (DtSimMessage *)
virtual void	slot_processPendingRequests ()
	Called when initialized, process any pending requests.

Protected Attributes
makVrv::DtDe &	myDe
std::map< std::string, int >	myMonitoring
std::map< std::string, int >	myRequesting
std::set< std::string >	myPendingRequests
	If de not yet initialized, hold onto pending requests until initialized.

Detailed Description

The Master DtVrfBackendSettingsManager.

Constructor & Destructor Documentation

makVrf::DtVrfBackendSettingsManager::DtVrfBackendSettingsManager

(

makVrv::DtDe &

)

virtual makVrf::DtVrfBackendSettingsManager::~DtVrfBackendSettingsManager ( )

virtual

Member Function Documentation

static DtVrfBackendSettingsManager& makVrf::DtVrfBackendSettingsManager::instance ( makVrv::DtDe &  de )

static

Returns instance of the messager.

virtual void makVrf::DtVrfBackendSettingsManager::monitorBackendSetting ( const std::string &  )

virtual

Sets up to monitor the particular setting.

When the particular setting is received a signal is sent (signal_settingReceived) for that signal and the back-end that sent the message. Note this message might be sent for multiple back-ends

virtual void makVrf::DtVrfBackendSettingsManager::requestBackendSetting ( const std::string &  , bool  sendRequest = false, const DtSimulationAddress &  addr = DtSimSendToAll  )

virtual

Request the value of a back-end setting from the DtVrfSimSettingsManager.

By default the request is sent to all available back-ends, but it can also be targeted to individual back-ends. The request is added to myBackendSettingRequestMap and when responses for all the requested back-ends have been received the given DtBackEndSettingRequestCompleteCallbackFcn will be called with the given user data to indicate that the back-ends can now be interrogated for the setting.

virtual void makVrf::DtVrfBackendSettingsManager::stopMonitoringBackendSetting ( const std::string &  )

virtual

Stops monitoring. If this is the last request, will not send a changed signal.

virtual void makVrf::DtVrfBackendSettingsManager::sendSettings ( const DtSettingsObject *  , const DtSimulationAddress &  addr = DtSimSendToAll  )

virtual

Modify the value of a back-end settings object.

The object's name must exist on the back-end(s) receiving the modification message.

virtual void makVrf::DtVrfBackendSettingsManager::setDRThresholds ( double  translation, double  rotation  )

virtual

General settings that can be sent to the back-end.

Set the dead reckoning settings to be used by any entities that allow gui overrides. Note this does not set the aggregate dimension threshold.

virtual void makVrf::DtVrfBackendSettingsManager::setSpotReportsGloballyEnabled ( bool  enabled )

virtual

Sets the global state of spot reports - all entities set to use the global setting (which is the default) will obey this value.

virtual void makVrf::DtVrfBackendSettingsManager::setTDLMessagesGloballyEnabled ( bool  enabled )

virtual

Sets the global state of TDL messages - all entities set to use the global setting (which is the default) will obey this value.

virtual void makVrf::DtVrfBackendSettingsManager::setEngagementReportsGloballyEnabled ( bool  enabled )

virtual

Sets the global state of engagement reports - all entities set to use the global setting (which is the default) will obey this value.

virtual void makVrf::DtVrfBackendSettingsManager::setCommModelSettings ( bool  useExternalComms )

virtual

Set the comm model settings to be used by entities that have radios.

virtual void makVrf::DtVrfBackendSettingsManager::setRoadDrivingSettings ( bool  driveOnLeft )

virtual

Set which side of the road entities drive on.

virtual void makVrf::DtVrfBackendSettingsManager::setAutomaticAggregationDisaggregationEnabled ( bool  enabled )

virtual

Sets whether or not automatic aggregation/disaggregation should be enabled.

Default is false.

virtual void makVrf::DtVrfBackendSettingsManager::setPublishAggregateFormationRoutes ( bool  yesNo )

virtual

Sets whether or not aggregate formation-following routes should be published.

Turning off publishing of these routes can improve performance, if the aggregates are large (individual routes are generated for each member in an aggregate).

virtual void makVrf::DtVrfBackendSettingsManager::setPeriodicSnapshotSettings ( bool  enabled, double  period, int  numberOfSnapshotsToKeep  )

virtual

Sets whether or not periodic snapshots are enabled and the time period (simulation time in seconds) for marking a checkpoint.

virtual void makVrf::DtVrfBackendSettingsManager::processSettingMessage ( DtSimMessage *  )

protectedvirtual

virtual void makVrf::DtVrfBackendSettingsManager::slot_processPendingRequests ( )

protectedvirtual

Called when initialized, process any pending requests.

Member Data Documentation

boost::signal<void (const std::string&, const DtVrfBackendState*)> makVrf::DtVrfBackendSettingsManager::signal_settingReceived

makVrv::DtDe& makVrf::DtVrfBackendSettingsManager::myDe

protected

std::map<std::string, int> makVrf::DtVrfBackendSettingsManager::myMonitoring

protected

std::map<std::string, int> makVrf::DtVrfBackendSettingsManager::myRequesting

protected

std::set<std::string> makVrf::DtVrfBackendSettingsManager::myPendingRequests

protected

If de not yet initialized, hold onto pending requests until initialized.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfGuiCore/vrfBackendSettingsManager.h