DtVrfStatusPublisher Class Reference

Instances of DtVrfStatusPublisher are used to send information about a VR-Forces simulation engine to remote front ends or other control applications.

Public Member Functions
	DtVrfStatusPublisher (DtVrfMessageInterface *messageIf, DtLocalObjectManager *mgr)
virtual	~DtVrfStatusPublisher ()
virtual const DtSimulationAddress &	address ()
virtual void	setAddress (const DtSimulationAddress &address)
virtual const DtTime &	lastResponseTime ()
virtual void	setLastResponseTime (const DtTime &time)
virtual void	sendStatus (const DtSimulationAddress &address)
virtual void	sendFinalStatus ()
virtual void	sendStatusToAll ()
virtual void	setHeartbeatInterval (int heartbeatInterval)
virtual int	heartbeatInterval ()
virtual DtInetAddr	ipAddress () const
virtual void	setIpAddress (const DtInetAddr &addr)
virtual unsigned int	port () const
virtual void	setPort (unsigned int p)
virtual int	appIdRangeMax () const
virtual void	setAppIdRangeMax (int p)
virtual int	controlState () const
virtual void	setControlState (int state)
virtual void	clear ()
virtual void	tick ()
virtual void	processStatusRequestMessage (DtSimMessage *msg)
virtual bool	isLoaded () const
virtual void	setIsLoaded (bool loaded)
virtual void	setScenarioRunId (int)
virtual int	scenarioRunId () const
virtual bool	isActive () const
virtual void	setIsActive (bool active)
virtual bool	canSimulate () const
virtual void	setCanSimulate (bool canSimulate)
virtual DtTime	exerciseStartTime () const
virtual void	setExerciseStartTime (DtTime time)
virtual DtTime	simTime () const
virtual void	setSimTime (DtTime time)
virtual DtTime	runDurationTime () const
virtual void	setRunDurationTime (DtTime)
virtual DtTime	simStartSimTime () const
virtual void	setSimStartSimTime (DtTime time)
virtual double	timeMultiplier () const
virtual void	setTimeMultiplier (double timeMultiplier)
virtual void	setLoadingScenario (bool)
virtual bool	loadingScenario () const
virtual void	setSavingScenario (bool)
virtual bool	savingScenario () const
virtual void	setImportingScenario (bool)
virtual bool	importingScenario () const
virtual void	setReinitializingScenario (bool)
virtual bool	reinitializingScenario () const
virtual void	setHostingDynamicTerrainServer (bool)
virtual bool	hostingDynamicTerrainServer () const
virtual void	setCreatingSimulationObjectGroup (bool)
virtual bool	creatingSimulationObjectGroup () const
virtual void	setClosingScenario (bool)
virtual bool	closingScenario () const
virtual void	setRollingBackScenario (bool)
virtual bool	rollingBackScenario () const
virtual void	setLoadedNewScenario (bool)
virtual bool	loadedNewScenario () const
virtual bool	isCurrentParameterDb () const
virtual void	setIsCurrentParameterDb (bool isCurrentParameterDb)
virtual bool	isResourceMonitorEnabled () const
virtual void	setIsResourceMonitorEnabled (bool isEnabled)
virtual void	setIsTimeManaged (bool yesNo)
virtual bool	isTimeManaged () const
virtual void	setSendStatusOnChange (bool)
virtual bool	sendStatusOnChange () const
virtual void	addLocalObject (int kind, int domain)
virtual void	removeLocalObject (int kind, int domain)
virtual DtU32	scenarioCapabilities () const
virtual void	setScenarioCapabilities (DtU32 v)
virtual void	setScenarioCapability (DtU32 v, bool b)
virtual DtString	applicationType () const
virtual void	setApplicationType (const DtString &type)

Static Public Member Functions
static void	statusRequestCallback (DtSimMessage *msg, void *usr)

Protected Member Functions
virtual void	processSimObjectAdded (const DtLocalObject *)
virtual void	processSimObjectAboutToBeRemoved (const DtLocalObject *)
virtual void	processSimObjectConvertedToRemote (const DtLocalObject *)
	DtVrfStatusPublisher (const DtVrfStatusPublisher &orig)
DtVrfStatusPublisher &	operator= (const DtVrfStatusPublisher &orig)

Static Protected Member Functions
static void	simObjectAdded (const DtLocalObject *, void *usr)
static void	simObjectAboutToBeRemoved (const DtLocalObject *, void *usr)
static void	simObjectConvertedToRemote (const DtLocalObject *, void *usr)

Protected Attributes
DtVrfMessageInterface *	myMessageIf
int	myHeartbeatInterval
DtSimulationAddress	myAddress
bool	myIsActive
bool	myCanSimulate
DtTime	myLastResponseTime
bool	myIsOldParameterDb
bool	myHasBeenModified
bool	mySendStatusOnChange
bool	myLoadedNewScenario
DtLocalObjectManager *	myObjectManager
DtIfStatus *	myStatus
tbb::spin_mutex	myStatusMutex

Constructor & Destructor Documentation

DtVrfStatusPublisher::DtVrfStatusPublisher	(	DtVrfMessageInterface *	messageIf,
		DtLocalObjectManager *	mgr
	)

constructor

virtual DtVrfStatusPublisher::~DtVrfStatusPublisher ( )

virtual

destructor

DtVrfStatusPublisher::DtVrfStatusPublisher ( const DtVrfStatusPublisher &  orig )

protected

copy constructor

Member Function Documentation

virtual const DtSimulationAddress& DtVrfStatusPublisher::address ( )

virtual

virtual void DtVrfStatusPublisher::setAddress ( const DtSimulationAddress &  address )

virtual

virtual const DtTime& DtVrfStatusPublisher::lastResponseTime ( )

virtual

virtual void DtVrfStatusPublisher::setLastResponseTime ( const DtTime &  time )

virtual

virtual void DtVrfStatusPublisher::sendStatus ( const DtSimulationAddress &  address )

virtual

virtual void DtVrfStatusPublisher::sendFinalStatus ( )

virtual

virtual void DtVrfStatusPublisher::sendStatusToAll ( )

virtual

virtual void DtVrfStatusPublisher::setHeartbeatInterval ( int  heartbeatInterval )

virtual

This value determines how often to send out a status message.

virtual int DtVrfStatusPublisher::heartbeatInterval ( )

virtual

virtual DtInetAddr DtVrfStatusPublisher::ipAddress ( ) const

virtual

Get IP address of this backend.

virtual void DtVrfStatusPublisher::setIpAddress ( const DtInetAddr &  addr )

virtual

virtual unsigned int DtVrfStatusPublisher::port ( ) const

virtual

Get/Set our port number for file transferring.

virtual void DtVrfStatusPublisher::setPort ( unsigned int  p )

virtual

virtual int DtVrfStatusPublisher::appIdRangeMax ( ) const

virtual

Get/Set our app id range max.

virtual void DtVrfStatusPublisher::setAppIdRangeMax ( int  p )

virtual

virtual int DtVrfStatusPublisher::controlState ( ) const

virtual

Get/Set control state (e.g. paused, running)

virtual void DtVrfStatusPublisher::setControlState ( int  state )

virtual

virtual void DtVrfStatusPublisher::clear ( )

virtual

Clears out objects that are in the scenario.

virtual void DtVrfStatusPublisher::tick ( )

virtual

Ticked by the simulation manager.

virtual void DtVrfStatusPublisher::processStatusRequestMessage ( DtSimMessage *  msg )

virtual

Process status request messages from other status managers.

static void DtVrfStatusPublisher::statusRequestCallback ( DtSimMessage *  msg, void *  usr  )

static

Handle status request messages from other status managers.

virtual bool DtVrfStatusPublisher::isLoaded ( ) const

virtual

If true, this backend has been loaded with a scenario.

virtual void DtVrfStatusPublisher::setIsLoaded ( bool  loaded )

virtual

virtual void DtVrfStatusPublisher::setScenarioRunId ( int  )

virtual

Sets the scenario run id.

virtual int DtVrfStatusPublisher::scenarioRunId ( ) const

virtual

virtual bool DtVrfStatusPublisher::isActive ( ) const

virtual

The following functions are obsolete.

virtual void DtVrfStatusPublisher::setIsActive ( bool  active )

virtual

virtual bool DtVrfStatusPublisher::canSimulate ( ) const

virtual

virtual void DtVrfStatusPublisher::setCanSimulate ( bool  canSimulate )

virtual

virtual DtTime DtVrfStatusPublisher::exerciseStartTime ( ) const

virtual

exercise start simulation time in seconds (defaults to 0.0).

virtual void DtVrfStatusPublisher::setExerciseStartTime ( DtTime  time )

virtual

virtual DtTime DtVrfStatusPublisher::simTime ( ) const

virtual

simulation time (simulation time elapsed since start of simulation) in seconds (defaults to 0.0).

virtual void DtVrfStatusPublisher::setSimTime ( DtTime  time )

virtual

virtual DtTime DtVrfStatusPublisher::runDurationTime ( ) const

virtual

Duration the scenario is scheduled to run. 0 means run until user presses pause.

virtual void DtVrfStatusPublisher::setRunDurationTime ( DtTime  )

virtual

virtual DtTime DtVrfStatusPublisher::simStartSimTime ( ) const

virtual

simulation time at start of simulation (defaults to 0.0).

virtual void DtVrfStatusPublisher::setSimStartSimTime ( DtTime  time )

virtual

virtual double DtVrfStatusPublisher::timeMultiplier ( ) const

virtual

Set faster or slower than real-time operation (defaults to 1.0).

virtual void DtVrfStatusPublisher::setTimeMultiplier ( double  timeMultiplier )

virtual

virtual void DtVrfStatusPublisher::setLoadingScenario ( bool  )

virtual

Only sent once. Will be set when the scenario is being loaded.

virtual bool DtVrfStatusPublisher::loadingScenario ( ) const

virtual

virtual void DtVrfStatusPublisher::setSavingScenario ( bool  )

virtual

Only sent once. Will be set when the scenario is being saved.

virtual bool DtVrfStatusPublisher::savingScenario ( ) const

virtual

virtual void DtVrfStatusPublisher::setImportingScenario ( bool  )

virtual

Will be set when a scenario is being imported.

virtual bool DtVrfStatusPublisher::importingScenario ( ) const

virtual

virtual void DtVrfStatusPublisher::setReinitializingScenario ( bool  )

virtual

Will be set when a scenario is being reinitialized.

virtual bool DtVrfStatusPublisher::reinitializingScenario ( ) const

virtual

virtual void DtVrfStatusPublisher::setHostingDynamicTerrainServer ( bool  )

virtual

Will be set when a back-end is hosting a dynamic terrain server.

virtual bool DtVrfStatusPublisher::hostingDynamicTerrainServer ( ) const

virtual

virtual void DtVrfStatusPublisher::setCreatingSimulationObjectGroup ( bool  )

virtual

Will be set when a simulation object group is being created.

virtual bool DtVrfStatusPublisher::creatingSimulationObjectGroup ( ) const

virtual

virtual void DtVrfStatusPublisher::setClosingScenario ( bool  )

virtual

Only sent once. Will be set when the scenario is being closed.

virtual bool DtVrfStatusPublisher::closingScenario ( ) const

virtual

virtual void DtVrfStatusPublisher::setRollingBackScenario ( bool  )

virtual

Only sent once. Will be set when the scenario is being rolled back.

virtual bool DtVrfStatusPublisher::rollingBackScenario ( ) const

virtual

virtual void DtVrfStatusPublisher::setLoadedNewScenario ( bool  )

virtual

Only sent once. Will be set then, once set, unset to signal a new scenario has just been loaded.

virtual bool DtVrfStatusPublisher::loadedNewScenario ( ) const

virtual

virtual bool DtVrfStatusPublisher::isCurrentParameterDb ( ) const

virtual

Flag indicating whether parameter database is old file format or not.

Flag indicating if parameter database is current file format or not.

virtual void DtVrfStatusPublisher::setIsCurrentParameterDb ( bool  isCurrentParameterDb )

virtual

virtual bool DtVrfStatusPublisher::isResourceMonitorEnabled ( ) const

virtual

Flag indicating if resource manager is enabled. When setting, if flag is different, status is published immediately.

virtual void DtVrfStatusPublisher::setIsResourceMonitorEnabled ( bool  isEnabled )

virtual

virtual void DtVrfStatusPublisher::setIsTimeManaged ( bool  yesNo )

virtual

virtual bool DtVrfStatusPublisher::isTimeManaged ( ) const

virtual

virtual void DtVrfStatusPublisher::setSendStatusOnChange ( bool  )

virtual

If true (default) will send status message when anything changes. If false, will set myHasBeenModified to true, and, if this is reset to true, will send message if if the myHasBeenModified flag is also true.

virtual bool DtVrfStatusPublisher::sendStatusOnChange ( ) const

virtual

virtual void DtVrfStatusPublisher::addLocalObject ( int  kind, int  domain  )

virtual

Adds/removes local objects. This will not send out an immediate message.

virtual void DtVrfStatusPublisher::removeLocalObject ( int  kind, int  domain  )

virtual

virtual DtU32 DtVrfStatusPublisher::scenarioCapabilities ( ) const

virtual

virtual void DtVrfStatusPublisher::setScenarioCapabilities ( DtU32  v )

virtual

virtual void DtVrfStatusPublisher::setScenarioCapability ( DtU32  v, bool  b  )

virtual

virtual DtString DtVrfStatusPublisher::applicationType ( ) const

virtual

virtual void DtVrfStatusPublisher::setApplicationType ( const DtString &  type )

virtual

static void DtVrfStatusPublisher::simObjectAdded ( const DtLocalObject *  , void *  usr  )

staticprotected

Calls for when objects are added/removed. Update object kind/domain count in status message.

virtual void DtVrfStatusPublisher::processSimObjectAdded ( const DtLocalObject *  )

protectedvirtual

static void DtVrfStatusPublisher::simObjectAboutToBeRemoved ( const DtLocalObject *  , void *  usr  )

staticprotected

virtual void DtVrfStatusPublisher::processSimObjectAboutToBeRemoved ( const DtLocalObject *  )

protectedvirtual

static void DtVrfStatusPublisher::simObjectConvertedToRemote ( const DtLocalObject *  , void *  usr  )

staticprotected

virtual void DtVrfStatusPublisher::processSimObjectConvertedToRemote ( const DtLocalObject *  )

protectedvirtual

DtVrfStatusPublisher& DtVrfStatusPublisher::operator= ( const DtVrfStatusPublisher &  orig )

protected

assignment operator

Member Data Documentation

DtVrfMessageInterface* DtVrfStatusPublisher::myMessageIf

protected

Status of this node.

int DtVrfStatusPublisher::myHeartbeatInterval

protected

DtSimulationAddress DtVrfStatusPublisher::myAddress

protected

bool DtVrfStatusPublisher::myIsActive

protected

bool DtVrfStatusPublisher::myCanSimulate

protected

DtTime DtVrfStatusPublisher::myLastResponseTime

protected

bool DtVrfStatusPublisher::myIsOldParameterDb

protected

bool DtVrfStatusPublisher::myHasBeenModified

protected

bool DtVrfStatusPublisher::mySendStatusOnChange

protected

bool DtVrfStatusPublisher::myLoadedNewScenario

protected

DtLocalObjectManager* DtVrfStatusPublisher::myObjectManager

protected

DtIfStatus* DtVrfStatusPublisher::myStatus

protected

tbb::spin_mutex DtVrfStatusPublisher::myStatusMutex

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfcgf/vrfStatusPublisher.h