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:

Public Types
typedef DtAttributePdu *(*	DtNonCoupledAttributePduCreator )(const DtPduWithAttributeRecordSets *, void *)
	Function prototype for functions that create DtAggregateStateRepositories. More...

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. More...
virtual	~DtObjectPublisher ()
	Destructor. More...
virtual DtStateRepository *	stateRep ()
	Returns a pointer to the DtStateRepository - through which you can set or inspect current state information. More...
virtual DtStateRepository *	sr ()
	Returns a pointer to the DtStateRepository - through which you can set or inspect current state information. More...
virtual DtExerciseConn *	exerciseConn ()
	Get our exercise connection. More...
virtual const DtObjectId &	localId () const =0
	The localId is the same as the globalId, a DtEntityIdentifier unique to this object. More...
virtual const DtObjectId &	id () const =0
	The id is the same as the globalId, a DtEntityIdentifier unique to this object. More...
virtual const DtGlobalObjectDesignator &	globalId () const =0
	The entityIdentifier unique to this object. More...
virtual void	forceUpdate ()=0
	For publisher to send PDU on next tick. More...
virtual void	tick ()=0
	Tick (update) this object. More...
virtual void	parallelTick ()
	Tick (update) this object in parallel threads. More...
virtual void	setTimeThreshold (DtTime time)
	Set the heartbeat rate for this object. More...
virtual DtTime	timeThreshold () const
	The heartbeat rate for this object. More...
virtual void	setRelLocTimeThreshold (DtTime time)
	Set the heartbeat rate of relative location updates for this object. More...
virtual DtTime	relLocTimeThreshold () const
	The relative location heartbeat rate for this object. More...
virtual DtStateRepository *	approximateRemoteStateRep ()
	Returns a pointer to the approximate remote DtStateRepository – This state repository contains the contents of the last sent message. More...
virtual DtTime	lastTimeUpdated () const
	Returns the value of wallclock time at the time an update was last received for the entity. More...
virtual DtTime	lastTimeAttrUpdated () const
virtual DtTime	lastSimTimeUpdated () const
	Returns the value of sim time at the time an update was last received for the entity. More...
virtual void	setUseCustomThreshold (bool useCustom)
	Sets whether or not this object will use a custom threshold value, or the default. More...
virtual bool	useCustomThreshold ()
	Returns whether or not this object will use a custom threshold value, or the default. More...
virtual void	setAttributePduStrategy (DtAttributePduStrategy strat)
	Sets/Gets whether to couple the attribute PDU. More...
virtual DtAttributePduStrategy	attributePduStrategy () const
virtual void	encodeExtensions (DtStateRepository *stateRep, const DtStateRepository &asSeenByRemote)
	Encode State Repository Extensions. Extensions should be added to stateRep attributeRecords. More...
virtual void	decodeExtensions (DtPdu *pdu, const DtStateRepository &stateRep)
	Decode State Repository Extensions. More...
DtNonCoupledAttributePduCreator	setNonCoupledAttributePduCreator (DtNonCoupledAttributePduCreator creator)
	Give us a function to be used for creating non-coupled Attribute PDUs. More...
DtNonCoupledAttributePduCreator	nonCoupledAttributePduCreator (void)

Static Public Member Functions
static void	setDfltTimeThreshold (DtTime time)
	Set the default heartbeat rate. More...
static DtTime	dfltTimeThreshold ()
	The default heartbeat rate, see setDfltTimeThreshold(). More...
static void	setDfltRelLocTimeThreshold (DtTime time)
	Set the default heartbeat rate for relative location updates. More...
static DtTime	dfltRelLocTimeThreshold ()
	The default heartbeat rate for relative location updates, see setDfltRelLocTimeThreshold() More...
static DtNonCoupledAttributePduCreator	setDefaultNonCoupledAttributePduCreator (DtNonCoupledAttributePduCreator creator)
	Give us a function to be used for creating non-coupled Attribute PDUs. More...
static DtNonCoupledAttributePduCreator	defaultNonCoupledAttributePduCreator (void)

Protected Member Functions
virtual void	send (DtPdu *pdu) const
	Puts the PDU on the network and updates timestamps. More...

Protected Attributes
DtExerciseConn *	myExConn
DtStateRepository *	myStateRep
DtStateRepository *	myAsSeenByRemote
bool	myOkToDeleteStateRepFlag
bool	myUseCustomThreshold
DtTime	myTimeThreshold
	Time threshold for the heartbeat rate. More...
DtTime	myRelLocTimeThreshold
	Time threshold for heartbeat rate of relative location updates (only for embarked/attached entities) More...
DtTime	mySimTimeLastUpdate
	Set in const send() method. More...
DtTime	myRealTimeLastUpdate
	Set in const send() method. More...
DtTime	myRealTimeLastAttrUpdate
DtNonCoupledAttributePduCreator	myNonCoupledAttributePduCreator
DtAttributePduStrategy	myAttributePduStrategy
std::vector < DtStateRepositoryExtensionEncoder * >	myStateRepositoryExtensionEncoderList
std::vector < DtStateRepositoryExtensionDecoder * >	myStateRepositoryExtensionDecoderList

Static Protected Attributes
static DtNonCoupledAttributePduCreator	theDefaultNonCoupledAttributePduCreator
static DtTime	theDfltTimeThreshold
static DtTime	theDfltRelLocTimeThreshold

Private Member Functions
	DtObjectPublisher (const DtObjectPublisher &orig)
	copy constructor – not implemented More...
DtObjectPublisher &	operator= (const DtObjectPublisher &orig)
	assignment operator – not implemented More...

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.

Member Typedef Documentation

typedef DtAttributePdu*(* DtObjectPublisher::DtNonCoupledAttributePduCreator)(const DtPduWithAttributeRecordSets *, void *)

Function prototype for functions that create DtAggregateStateRepositories.

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 ( )

inlinevirtual

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.

virtual DtAttributePduStrategy DtObjectPublisher::attributePduStrategy ( ) const

virtual

virtual void DtObjectPublisher::decodeExtensions ( DtPdu *  pdu, const DtStateRepository &  stateRep  )

virtual

Decode State Repository Extensions.

Called after sendPdu to update the As Seen By Remote State Repository

static DtNonCoupledAttributePduCreator DtObjectPublisher::defaultNonCoupledAttributePduCreator ( void  )

static

static DtTime DtObjectPublisher::dfltRelLocTimeThreshold ( )

static

The default heartbeat rate for relative location updates, see setDfltRelLocTimeThreshold()

static DtTime DtObjectPublisher::dfltTimeThreshold ( )

static

The default heartbeat rate, see setDfltTimeThreshold().

virtual void DtObjectPublisher::encodeExtensions ( DtStateRepository *  stateRep, const DtStateRepository &  asSeenByRemote  )

virtual

Encode State Repository Extensions. Extensions should be added to stateRep attributeRecords.

DtExerciseConn * DtObjectPublisher::exerciseConn ( )

inlinevirtual

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, DtArealObjectPublisher, DtLinearObjectPublisher, DtPointObjectPublisher, DtDesignatorPublisher, DtDirectedEnergyFirePublisher, DtAggregatePublisher, DtEmitterSystemPublisher, DtActiveSonarPublisher, DtAdditionalPassiveActivitiesPublisher, DtPropulsionNoisePublisher, and DtUnderwaterAcousticsPublisher.

virtual const DtGlobalObjectDesignator& DtObjectPublisher::globalId ( ) const

pure virtual

The entityIdentifier unique to this object.

Implemented in DtEntityPublisher, DtIffPublisher, DtEnvironmentProcessPublisher, DtRadioTransmitterPublisher, DtAggregatePublisher, DtDirectedEnergyFirePublisher, DtRadioReceiverPublisher, DtGriddedDataPublisher, DtEmitterSystemPublisher, DtArealObjectPublisher, DtLinearObjectPublisher, DtPointObjectPublisher, DtDesignatorPublisher, DtActiveSonarPublisher, DtAdditionalPassiveActivitiesPublisher, DtPropulsionNoisePublisher, and DtUnderwaterAcousticsPublisher.

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, DtDirectedEnergyFirePublisher, DtEnvironmentProcessPublisher, DtRadioTransmitterPublisher, DtAggregatePublisher, DtRadioReceiverPublisher, DtGriddedDataPublisher, DtEmitterSystemPublisher, DtArealObjectPublisher, DtLinearObjectPublisher, DtPointObjectPublisher, DtDesignatorPublisher, DtActiveSonarPublisher, DtAdditionalPassiveActivitiesPublisher, DtPropulsionNoisePublisher, and DtUnderwaterAcousticsPublisher.

Referenced by DtDesignatorPublisher::globalId(), DtArealObjectPublisher::globalId(), DtPointObjectPublisher::globalId(), DtLinearObjectPublisher::globalId(), DtDesignatorPublisher::localId(), DtArealObjectPublisher::localId(), DtLinearObjectPublisher::localId(), and DtPointObjectPublisher::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::lastTimeAttrUpdated ( ) const

virtual

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, DtDirectedEnergyFirePublisher, DtRadioReceiverPublisher, DtGriddedDataPublisher, DtEmitterSystemPublisher, DtArealObjectPublisher, DtLinearObjectPublisher, DtPointObjectPublisher, DtDesignatorPublisher, DtActiveSonarPublisher, DtAdditionalPassiveActivitiesPublisher, DtPropulsionNoisePublisher, and DtUnderwaterAcousticsPublisher.

DtNonCoupledAttributePduCreator DtObjectPublisher::nonCoupledAttributePduCreator

(

void

)

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

private

assignment operator – not implemented

virtual void DtObjectPublisher::parallelTick ( )

virtual

Tick (update) this object in parallel threads.

virtual DtTime DtObjectPublisher::relLocTimeThreshold ( ) const

virtual

The relative location heartbeat rate for this object.

virtual void DtObjectPublisher::send ( DtPdu *  pdu ) const

protectedvirtual

Puts the PDU on the network and updates timestamps.

virtual void DtObjectPublisher::setAttributePduStrategy ( DtAttributePduStrategy  strat )

virtual

Sets/Gets whether to couple the attribute PDU.

static DtNonCoupledAttributePduCreator DtObjectPublisher::setDefaultNonCoupledAttributePduCreator ( DtNonCoupledAttributePduCreator  creator )

static

Give us a function to be used for creating non-coupled Attribute PDUs.

static void DtObjectPublisher::setDfltRelLocTimeThreshold ( DtTime  time )

static

Set the default heartbeat rate for relative location updates.

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.

DtNonCoupledAttributePduCreator DtObjectPublisher::setNonCoupledAttributePduCreator

(

DtNonCoupledAttributePduCreator

creator

)

Give us a function to be used for creating non-coupled Attribute PDUs.

virtual void DtObjectPublisher::setRelLocTimeThreshold ( DtTime  time )

virtual

Set the heartbeat rate of relative location updates for this object.

The default rate of relative location updates for all objects is configured by setDfltRelLocTimeThreshold().

virtual void DtObjectPublisher::setTimeThreshold ( DtTime  time )

virtual

Set the heartbeat rate for this object.

The default rate for all objects is configured by setDfltTimeThreshold(). If this is set, the customThreshold is also set to true;

virtual void DtObjectPublisher::setUseCustomThreshold ( bool  useCustom )

virtual

Sets whether or not this object will use a custom threshold value, or the default.

DtStateRepository * DtObjectPublisher::sr ( )

inlinevirtual

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

References myStateRep.

DtStateRepository * DtObjectPublisher::stateRep ( )

inlinevirtual

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, DtActiveSonarPublisher, DtAdditionalPassiveActivitiesPublisher, DtGriddedDataPublisher, DtPropulsionNoisePublisher, DtUnderwaterAcousticsPublisher, DtArealObjectPublisher, DtLinearObjectPublisher, DtPointObjectPublisher, DtDirectedEnergyFirePublisher, and DtDesignatorPublisher.

virtual DtTime DtObjectPublisher::timeThreshold ( ) const

virtual

The heartbeat rate for this object.

virtual bool DtObjectPublisher::useCustomThreshold ( )

virtual

Returns whether or not this object will use a custom threshold value, or the default.

Member Data Documentation

DtStateRepository* DtObjectPublisher::myAsSeenByRemote

protected

Referenced by approximateRemoteStateRep().

DtAttributePduStrategy DtObjectPublisher::myAttributePduStrategy

protected

DtExerciseConn* DtObjectPublisher::myExConn

protected

Referenced by exerciseConn().

DtNonCoupledAttributePduCreator DtObjectPublisher::myNonCoupledAttributePduCreator

protected

bool DtObjectPublisher::myOkToDeleteStateRepFlag

protected

DtTime DtObjectPublisher::myRealTimeLastAttrUpdate

mutableprotected

DtTime DtObjectPublisher::myRealTimeLastUpdate

mutableprotected

Set in const send() method.

DtTime DtObjectPublisher::myRelLocTimeThreshold

protected

Time threshold for heartbeat rate of relative location updates (only for embarked/attached entities)

DtTime DtObjectPublisher::mySimTimeLastUpdate

mutableprotected

Set in const send() method.

DtStateRepository* DtObjectPublisher::myStateRep

protected

Referenced by DtArealObjectPublisher::aosr(), DtActiveSonarPublisher::asr(), DtAdditionalPassiveActivitiesPublisher::asr(), DtAggregatePublisher::asr(), DtDirectedEnergyFirePublisher::defr(), DtDesignatorPublisher::dsr(), DtEnvironmentProcessPublisher::epsr(), DtEmitterSystemPublisher::esr(), DtGriddedDataPublisher::gdsr(), DtIffPublisher::isr(), DtLinearObjectPublisher::losr(), DtPointObjectPublisher::posr(), DtPropulsionNoisePublisher::psr(), DtRadioReceiverPublisher::rsr(), sr(), stateRep(), DtRadioTransmitterPublisher::tsr(), and DtUnderwaterAcousticsPublisher::usr().

std::vector<DtStateRepositoryExtensionDecoder*> DtObjectPublisher::myStateRepositoryExtensionDecoderList

protected

std::vector<DtStateRepositoryExtensionEncoder*> DtObjectPublisher::myStateRepositoryExtensionEncoderList

protected

DtTime DtObjectPublisher::myTimeThreshold

protected

Time threshold for the heartbeat rate.

bool DtObjectPublisher::myUseCustomThreshold

protected

DtNonCoupledAttributePduCreator DtObjectPublisher::theDefaultNonCoupledAttributePduCreator

staticprotected

DtTime DtObjectPublisher::theDfltRelLocTimeThreshold

staticprotected

DtTime DtObjectPublisher::theDfltTimeThreshold

staticprotected

---

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

• objectPublisherDIS.h