DtObjectPublisher Class Reference

Instances of DtObjectPublisher are used for local or source simulations of objects, (i.e. More...

Inheritance diagram for DtObjectPublisher:

Collaboration diagram for DtObjectPublisher:

List of all members.

Public Member Functions
	DtObjectPublisher (DtExerciseConn *conn, DtStateRepository *stateRep, DtStateRepository *asSeenByRemote, bool okToDeleteStateRep=true)
	Constructor takes an DtExerciseConn which must have a lifetime greater than the ObjectPubliser.
virtual	~DtObjectPublisher ()
	Destructor.
virtual DtStateRepository *	stateRep ()
	Returns a pointer to the DtStateRepository - through which you can set or inspect current state information.
virtual DtStateRepository *	sr ()
	Returns a pointer to the DtStateRepository - through which you can set or inspect current state information.
virtual DtExerciseConn *	exerciseConn ()
	Get our exercise connection.
virtual const DtObjectId &	localId () const =0
	The localId is the same as the globalId, a DtEntityIdentifier unique to this object.
virtual const DtObjectId &	id () const =0
	The id is the same as the globalId, a DtEntityIdentifier unique to this object.
virtual const DtGlobalObjectDesignator &	globalId () const =0
	The entityIdentifier unique to this object.
virtual void	forceUpdate ()=0
	For publisher to send PDU on next tick.
virtual void	tick ()=0
	Tick (update) this object.
virtual void	setTimeThreshold (DtTime time)
	Set the heartbeat rate for this object.
virtual DtTime	timeThreshold () const
	The heartbeat rate for this object.
virtual DtStateRepository *	approximateRemoteStateRep ()
	Returns a pointer to the approximate remote DtStateRepository -- This state repository contains the contents of the last sent message.
virtual DtTime	lastTimeUpdated () const
	Returns the value of wallclock time at the time an update was last received for the entity.
virtual DtTime	lastSimTimeUpdated () const
	Returns the value of sim time at the time an update was last received for the entity.
Static Public Member Functions
static void	setDfltTimeThreshold (DtTime time)
	Set the default heartbeat rate.
static DtTime	dfltTimeThreshold ()
	The default heartbeat rate, see setDfltTimeThreshold().
Protected Member Functions
void	send (DtPdu *pdu) const
	Puts the PDU on the network and updates timestamps.
Protected Attributes
DtExerciseConn *	myExConn
DtStateRepository *	myStateRep
DtStateRepository *	myAsSeenByRemote
bool	myOkToDeleteStateRepFlag
DtTime	myTimeThreshold
DtTime	mySimTimeLastUpdate
	Set in const send() method.
DtTime	myRealTimeLastUpdate
	Set in const send() method.
Static Protected Attributes
static DtTime	theDfltTimeThreshold
Private Member Functions
	DtObjectPublisher (const DtObjectPublisher &orig)
	copy constructor -- not implemented
DtObjectPublisher &	operator= (const DtObjectPublisher &orig)
	assignment operator -- not implemented

---

Detailed Description

Instances of DtObjectPublisher are used for local or source simulations of objects, (i.e.

these objects are not dependent on data being produced elsewhere on the network for their existence). These object send data to the network.

---

Constructor & Destructor Documentation

DtObjectPublisher::DtObjectPublisher	(	DtExerciseConn *	conn,
		DtStateRepository *	stateRep,
		DtStateRepository *	asSeenByRemote,
		bool	okToDeleteStateRep = true
	)

Constructor takes an DtExerciseConn which must have a lifetime greater than the ObjectPubliser.

It also takes two DtStateRepositories, the stateRep which it destroys in the DTOR if the okToDeleteStateRep flag was set to true, and the asSeenByRemote which is destroyed in the dtor every time.

virtual DtObjectPublisher::~DtObjectPublisher

(

)

[virtual]

Destructor.

DtObjectPublisher::DtObjectPublisher

(

const DtObjectPublisher &

orig

)

[private]

copy constructor -- not implemented

---

Member Function Documentation

DtStateRepository * DtObjectPublisher::approximateRemoteStateRep

(

)

[inline, virtual]

Returns a pointer to the approximate remote DtStateRepository -- This state repository contains the contents of the last sent message.

VR-Link keeps this SR so it can ensure that object updates get sent only when their data have changed.

References myAsSeenByRemote.

static DtTime DtObjectPublisher::dfltTimeThreshold

(

)

[static]

The default heartbeat rate, see setDfltTimeThreshold().

DtExerciseConn * DtObjectPublisher::exerciseConn

(

)

[inline, virtual]

Get our exercise connection.

References myExConn.

virtual void DtObjectPublisher::forceUpdate

(

)

[pure virtual]

For publisher to send PDU on next tick.

Implemented in DtEntityPublisher, DtRadioTransmitterPublisher, DtEnvironmentProcessPublisher, DtRadioReceiverPublisher, DtGriddedDataPublisher, DtIffPublisher, DtDesignatorPublisher, DtAggregatePublisher, and DtEmitterSystemPublisher.

virtual const DtGlobalObjectDesignator& DtObjectPublisher::globalId

(

)

const [pure virtual]

The entityIdentifier unique to this object.

Implemented in DtEntityPublisher, DtIffPublisher, DtEnvironmentProcessPublisher, DtRadioTransmitterPublisher, DtAggregatePublisher, DtRadioReceiverPublisher, DtGriddedDataPublisher, DtEmitterSystemPublisher, and DtDesignatorPublisher.

virtual const DtObjectId& DtObjectPublisher::id

(

)

const [pure virtual]

The id is the same as the globalId, a DtEntityIdentifier unique to this object.

Implemented in DtEntityPublisher, DtIffPublisher, DtEnvironmentProcessPublisher, DtRadioTransmitterPublisher, DtAggregatePublisher, DtRadioReceiverPublisher, DtGriddedDataPublisher, DtEmitterSystemPublisher, and DtDesignatorPublisher.

Referenced by DtDesignatorPublisher::globalId(), and DtDesignatorPublisher::localId().

virtual DtTime DtObjectPublisher::lastSimTimeUpdated

(

)

const [virtual]

Returns the value of sim time at the time an update was last received for the entity.

virtual DtTime DtObjectPublisher::lastTimeUpdated

(

)

const [virtual]

Returns the value of wallclock time at the time an update was last received for the entity.

virtual const DtObjectId& DtObjectPublisher::localId

(

)

const [pure virtual]

The localId is the same as the globalId, a DtEntityIdentifier unique to this object.

Implemented in DtEntityPublisher, DtIffPublisher, DtEnvironmentProcessPublisher, DtRadioTransmitterPublisher, DtAggregatePublisher, DtRadioReceiverPublisher, DtGriddedDataPublisher, DtEmitterSystemPublisher, and DtDesignatorPublisher.

DtObjectPublisher& DtObjectPublisher::operator=

(

const DtObjectPublisher &

orig

)

[private]

assignment operator -- not implemented

void DtObjectPublisher::send

(

DtPdu *

pdu

)

const [protected]

Puts the PDU on the network and updates timestamps.

static void DtObjectPublisher::setDfltTimeThreshold

(

DtTime

time

)

[static]

Set the default heartbeat rate.

The time passed to this function is the number of seconds between heartbeats in published objects at rest. The default time is 5s.

virtual void DtObjectPublisher::setTimeThreshold

(

DtTime

time

)

[virtual]

Set the heartbeat rate for this object.

The default rate for all objects is configured by setDfltTimeThreshold().

DtStateRepository * DtObjectPublisher::sr

(

)

[inline, virtual]

Returns a pointer to the DtStateRepository - through which you can set or inspect current state information.

References myStateRep.

DtStateRepository * DtObjectPublisher::stateRep

(

)

[inline, virtual]

Returns a pointer to the DtStateRepository - through which you can set or inspect current state information.

References myStateRep.

Referenced by DtEntityPublisher::esr().

virtual void DtObjectPublisher::tick

(

)

[pure virtual]

Tick (update) this object.

Implemented in DtEntityPublisher, DtIffPublisher, DtEmitterSystemPublisher, DtAggregatePublisher, DtEnvironmentProcessPublisher, DtRadioTransmitterPublisher, DtRadioReceiverPublisher, DtGriddedDataPublisher, and DtDesignatorPublisher.

virtual DtTime DtObjectPublisher::timeThreshold

(

)

const [virtual]

The heartbeat rate for this object.

---

Member Data Documentation

DtStateRepository* DtObjectPublisher::myAsSeenByRemote [protected]

Referenced by approximateRemoteStateRep().

DtExerciseConn* DtObjectPublisher::myExConn [protected]

Referenced by exerciseConn().

bool DtObjectPublisher::myOkToDeleteStateRepFlag [protected]

DtTime DtObjectPublisher::myRealTimeLastUpdate [mutable, protected]

Set in const send() method.

DtTime DtObjectPublisher::mySimTimeLastUpdate [mutable, protected]

Set in const send() method.

DtStateRepository* DtObjectPublisher::myStateRep [protected]

Referenced by DtAggregatePublisher::asr(), DtDesignatorPublisher::dsr(), DtEnvironmentProcessPublisher::epsr(), DtEmitterSystemPublisher::esr(), DtGriddedDataPublisher::gdsr(), DtIffPublisher::isr(), DtRadioReceiverPublisher::rsr(), sr(), stateRep(), and DtRadioTransmitterPublisher::tsr().

DtTime DtObjectPublisher::myTimeThreshold [protected]

DtTime DtObjectPublisher::theDfltTimeThreshold [static, protected]

---

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

• dObjPub.h