DtObjectSensorMonitor Class Reference

Class which manages the sending of sensor contact information to the GUI from one particular sensor on an entity. More...

Public Member Functions
	DtObjectSensorMonitor (DtVrfObject *hostObject, const DtSensorContactInfoList *contactInfoList, const DtString &sensorName, int sensorType, DtObjectSensorPSR *psr)
	constructor More...
virtual	~DtObjectSensorMonitor ()
	destructor More...
virtual bool	init ()
	Calls registerMessageCallbacks(). More...
virtual void	setDeferMessageSending ()
	Configures monitor to use parallel tick to defer message sending. More...
virtual void	registerMessageCallbacks ()
	Registers for sensorDataRequest and sensorDataUnsubscribe messages. More...
virtual void	processSensorDataRequest (DtSimMessage *msg)
virtual void	processSensorDataUnsubscribe (DtSimMessage *msg)
virtual void	createAndSendSensorDataMessage ()
	Constructs a DtSensorData message based on the current state of the sensor PSR, and sends it to the network. More...
virtual void	notifyTargetsChanged ()
	Called by the object sensor whenever the target list in the PSR has changed. More...

Static Public Member Functions
static void	sensorDataRequestCallback (DtSimMessage *msg, void *usrData)
static void	sensorDataUnsubscribeCallback (DtSimMessage *msg, void *usrData)

Protected Types
typedef std::list < DtSimulationAddress >	DtSubscriberList

Protected Member Functions
virtual bool	onSubscriberList (const DtSimulationAddress &add) const
	Returns true if this address is on the current subscriber list. More...
virtual void	addToSubscriberList (const DtSimulationAddress &add)
virtual void	removeFromSubscriberList (const DtSimulationAddress &add)
virtual int	numberOfSubscribers ()
	returns the number of subscribers. More...

Protected Attributes
DtVrfObject *	myHostObject
DtObjectSensorPSR *	mySensorPSR
const DtSensorContactInfoList *	mySensorContactInfoList
int	mySensorType
DtString	mySensorName
DtSubscriberList	mySubscriberList
bool	myDeferMessageSend

Private Member Functions
	DtObjectSensorMonitor ()
	default constructor; not implemented More...
	DtObjectSensorMonitor (const DtObjectSensorMonitor &orig)
	copy constructor; not implemented More...
const DtObjectSensorMonitor &	operator= (const DtObjectSensorMonitor &orig)
	assignment operator; not implemented More...

Detailed Description

Class which manages the sending of sensor contact information to the GUI from one particular sensor on an entity.

Member Typedef Documentation

typedef std::list<DtSimulationAddress> DtObjectSensorMonitor::DtSubscriberList

protected

Constructor & Destructor Documentation

DtObjectSensorMonitor::DtObjectSensorMonitor ( )

private

default constructor; not implemented

DtObjectSensorMonitor::DtObjectSensorMonitor ( const DtObjectSensorMonitor &  orig )

private

copy constructor; not implemented

DtObjectSensorMonitor::DtObjectSensorMonitor	(	DtVrfObject *	hostObject,
		const DtSensorContactInfoList *	contactInfoList,
		const DtString &	sensorName,
		int	sensorType,
		DtObjectSensorPSR *	psr
	)

constructor

virtual DtObjectSensorMonitor::~DtObjectSensorMonitor ( )

virtual

destructor

Member Function Documentation

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

private

assignment operator; not implemented

virtual bool DtObjectSensorMonitor::init ( )

virtual

Calls registerMessageCallbacks().

virtual void DtObjectSensorMonitor::setDeferMessageSending ( )

virtual

Configures monitor to use parallel tick to defer message sending.

virtual void DtObjectSensorMonitor::registerMessageCallbacks ( )

virtual

Registers for sensorDataRequest and sensorDataUnsubscribe messages.

static void DtObjectSensorMonitor::sensorDataRequestCallback ( DtSimMessage *  msg, void *  usrData  )

static

virtual void DtObjectSensorMonitor::processSensorDataRequest ( DtSimMessage *  msg )

virtual

static void DtObjectSensorMonitor::sensorDataUnsubscribeCallback ( DtSimMessage *  msg, void *  usrData  )

static

virtual void DtObjectSensorMonitor::processSensorDataUnsubscribe ( DtSimMessage *  msg )

virtual

virtual void DtObjectSensorMonitor::createAndSendSensorDataMessage ( )

virtual

Constructs a DtSensorData message based on the current state of the sensor PSR, and sends it to the network.

virtual void DtObjectSensorMonitor::notifyTargetsChanged ( )

virtual

Called by the object sensor whenever the target list in the PSR has changed.

This triggers sensorData messages to be sent out, if anyone is currently subscribed.

virtual bool DtObjectSensorMonitor::onSubscriberList ( const DtSimulationAddress &  add ) const

protectedvirtual

Returns true if this address is on the current subscriber list.

virtual void DtObjectSensorMonitor::addToSubscriberList ( const DtSimulationAddress &  add )

protectedvirtual

virtual void DtObjectSensorMonitor::removeFromSubscriberList ( const DtSimulationAddress &  add )

protectedvirtual

virtual int DtObjectSensorMonitor::numberOfSubscribers ( )

protectedvirtual

returns the number of subscribers.

Member Data Documentation

DtVrfObject* DtObjectSensorMonitor::myHostObject

protected

DtObjectSensorPSR* DtObjectSensorMonitor::mySensorPSR

protected

const DtSensorContactInfoList* DtObjectSensorMonitor::mySensorContactInfoList

protected

int DtObjectSensorMonitor::mySensorType

protected

DtString DtObjectSensorMonitor::mySensorName

protected

DtSubscriberList DtObjectSensorMonitor::mySubscriberList

protected

bool DtObjectSensorMonitor::myDeferMessageSend

protected

---

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

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