DtEnvironmentProcessPublisher Class Reference

Instances of DtEnvironmentProcessPublisher are used for local or source simulations of environment processes, (i.e. More...

Inheritance diagram for DtEnvironmentProcessPublisher:

Collaboration diagram for DtEnvironmentProcessPublisher:

Public Types
typedef DtEnvironmentProcessRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtEnvironmentProcessRepositories. More...
Public Types inherited from DtObjectPublisher
typedef DtAttributePdu *(*	DtNonCoupledAttributePduCreator )(const DtPduWithAttributeRecordSets *, void *)
	Function prototype for functions that create DtAggregateStateRepositories. More...

Public Member Functions
	DtEnvironmentProcessPublisher (DtEnvironmentProcessRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	constructor More...
	DtEnvironmentProcessPublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	constructor More...
virtual	~DtEnvironmentProcessPublisher ()
	destructor More...
virtual bool	tick ()
	This function should be called once per frame for each environment process object. More...
virtual DtEnvironmentProcessRepository *	environmentProcessStateRep ()
	Returns a pointer to the EnvironmentProcessRepository - through which you can set or inspect current state information. More...
virtual DtEnvironmentProcessRepository *	epsr ()
	Synonym for environmentProcessStateRep(). More...
virtual DtEnvironmentProcessDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR. More...
virtual DtEnvironmentProcessEncoder *	encoder ()
	Returns a pointer to the Encoder being used to encode current state into an entity state PDU. More...
virtual const DtObjectId &	id () const
	Get the environment process's identifier. More...
virtual const DtObjectId &	localId () const
	Get the environment process's localId - same as id for DIS. More...
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the global object designator - same as id for DIS. More...
virtual void	sendFinalPduOnDestruction (bool onOff)
	Set flag indicating whether to send a final PDU with the "FinalPdu" appearance bit set, from within the DtEnvironmentProcessPublisher destructor. More...
virtual void	forceUpdate ()
	Force a state update to be sent during the next call to tick, even if nothing would normally cause a send. More...
Public Member Functions inherited from DtObjectPublisher
	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 bool	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...
virtual void	setUpdateRateWarningThreshold (unsigned short updatesPerSecond)
	Overrides the default (static) updates per second for a specific instance Sets/Gets for private member. More...
virtual unsigned short	updateRateWarningThreshold () const
virtual void	checkForUpdateRateWarning () const
	Helper function that determines whether or not to trigger a spam warning. 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	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs. More...
static DtStateRepCreator	stateRepCreator (void)
static void	setClassDfltTimeThreshold (DtTime threshold)
Static Public Member Functions inherited from DtObjectPublisher
static void	setDfltTimeThreshold (DtTime time)
	Set the default heartbeat rate. More...
static DtTime	dfltTimeThreshold ()
	The default heartbeat rate, see setDfltTimeThreshold(). More...
static void	setDfltUpdateRateWarningThreshold (unsigned short updatesPerSecond)
	Sets the default (static) updates per second for any instance. More...
static unsigned short	dfltUpdateRateWarningThreshold ()
	Return the value of theDfltUpdateRateWarningThreshold. 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
void	sendFinalPdu ()
	Not virtual since called from destructor. More...
void	init (const DtEntityIdentifier &vehId)
	Not virtual since called from constructor. More...
	DtEnvironmentProcessPublisher (const DtEnvironmentProcessPublisher &orig)
DtEnvironmentProcessPublisher &	operator= (const DtEnvironmentProcessPublisher &orig)
	copy constructor – not implemented More...
Protected Member Functions inherited from DtObjectPublisher
virtual void	send (DtPdu *pdu) const
	Puts the PDU on the network and updates timestamps. More...

Protected Attributes
DtObjectId	myId
DtEnvironmentProcessDecoder *	myDecoder
DtEnvironmentProcessEncoder *	myEncoder
bool	mySendFinalInDtor
Protected Attributes inherited from DtObjectPublisher
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
DtTime	myLastSpamCheckTime
	Set in constructor. More...
unsigned short	myNumberOfPdusPerSecond
	Set in constructor. More...
unsigned short	myUpdateRateWarningThreshold
	Set in constructor. More...
bool	myCanWarn
	Set in constructor. More...
DtNonCoupledAttributePduCreator	myNonCoupledAttributePduCreator
DtAttributePduStrategy	myAttributePduStrategy
std::vector < DtStateRepositoryExtensionEncoder * >	myStateRepositoryExtensionEncoderList
std::vector < DtStateRepositoryExtensionDecoder * >	myStateRepositoryExtensionDecoderList

Static Protected Attributes
static DtStateRepCreator	theStateRepCreator
static DtTime	theClassDfltTimeThreshold
static bool	theClassDfltIsSetFlag
Static Protected Attributes inherited from DtObjectPublisher
static DtNonCoupledAttributePduCreator	theDefaultNonCoupledAttributePduCreator
static DtTime	theDfltTimeThreshold
static DtTime	theDfltRelLocTimeThreshold
static unsigned short	theDfltUpdateRateWarningThreshold

Detailed Description

Instances of DtEnvironmentProcessPublisher are used for local or source simulations of environment processes, (i.e.

these entities are not dependent on data being produced elsewhere on the network for their existence).

Examples: Environmental Process Example

Member Typedef Documentation

typedef DtEnvironmentProcessRepository*(* DtEnvironmentProcessPublisher::DtStateRepCreator)()

Function prototype for functions that create DtEnvironmentProcessRepositories.

Constructor & Destructor Documentation

DtEnvironmentProcessPublisher::DtEnvironmentProcessPublisher	(	DtEnvironmentProcessRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	id = DtObjectId::defaultId()
	)

constructor

DtEnvironmentProcessPublisher::DtEnvironmentProcessPublisher	(	DtExerciseConn *	conn,
		const DtObjectId &	id = DtObjectId::defaultId()
	)

constructor

virtual DtEnvironmentProcessPublisher::~DtEnvironmentProcessPublisher ( )

virtual

destructor

DtEnvironmentProcessPublisher::DtEnvironmentProcessPublisher ( const DtEnvironmentProcessPublisher &  orig )

protected

Member Function Documentation

DtEnvironmentProcessDecoder * DtEnvironmentProcessPublisher::decoder ( )

inlinevirtual

Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.

References myDecoder.

DtEnvironmentProcessEncoder * DtEnvironmentProcessPublisher::encoder ( )

inlinevirtual

Returns a pointer to the Encoder being used to encode current state into an entity state PDU.

References myEncoder.

DtEnvironmentProcessRepository * DtEnvironmentProcessPublisher::environmentProcessStateRep ( )

inlinevirtual

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

References epsr().

DtEnvironmentProcessRepository * DtEnvironmentProcessPublisher::epsr ( )

inlinevirtual

Synonym for environmentProcessStateRep().

References DtObjectPublisher::myStateRep.

Referenced by environmentProcessStateRep().

virtual void DtEnvironmentProcessPublisher::forceUpdate ( )

virtual

Force a state update to be sent during the next call to tick, even if nothing would normally cause a send.

Implements DtObjectPublisher.

virtual const DtGlobalObjectDesignator& DtEnvironmentProcessPublisher::globalId ( ) const

virtual

Get the global object designator - same as id for DIS.

Implements DtObjectPublisher.

const DtObjectId & DtEnvironmentProcessPublisher::id ( ) const

inlinevirtual

Get the environment process's identifier.

Implements DtObjectPublisher.

References myId.

Referenced by localId().

void DtEnvironmentProcessPublisher::init ( const DtEntityIdentifier &  vehId )

protected

Not virtual since called from constructor.

const DtObjectId & DtEnvironmentProcessPublisher::localId ( ) const

inlinevirtual

Get the environment process's localId - same as id for DIS.

Implements DtObjectPublisher.

References id().

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

protected

copy constructor – not implemented

void DtEnvironmentProcessPublisher::sendFinalPdu ( )

protected

Not virtual since called from destructor.

void DtEnvironmentProcessPublisher::sendFinalPduOnDestruction ( bool  onOff )

inlinevirtual

Set flag indicating whether to send a final PDU with the "FinalPdu" appearance bit set, from within the DtEnvironmentProcessPublisher destructor.

References mySendFinalInDtor.

static void DtEnvironmentProcessPublisher::setClassDfltTimeThreshold ( DtTime  threshold )

static

static void DtEnvironmentProcessPublisher::setStateRepCreator ( DtStateRepCreator  creator )

static

Give us a function to be used for creating SRs.

static DtStateRepCreator DtEnvironmentProcessPublisher::stateRepCreator ( void  )

static

virtual bool DtEnvironmentProcessPublisher::tick ( )

virtual

This function should be called once per frame for each environment process object.

It determines if any data needs to be sent to the other exercise participants, and sends that data. Will return true if data was sent.

Implements DtObjectPublisher.

Member Data Documentation

DtEnvironmentProcessDecoder* DtEnvironmentProcessPublisher::myDecoder

protected

Referenced by decoder().

DtEnvironmentProcessEncoder* DtEnvironmentProcessPublisher::myEncoder

protected

Referenced by encoder().

DtObjectId DtEnvironmentProcessPublisher::myId

protected

Referenced by id().

bool DtEnvironmentProcessPublisher::mySendFinalInDtor

protected

Referenced by sendFinalPduOnDestruction().

bool DtEnvironmentProcessPublisher::theClassDfltIsSetFlag

staticprotected

DtTime DtEnvironmentProcessPublisher::theClassDfltTimeThreshold

staticprotected

DtStateRepCreator DtEnvironmentProcessPublisher::theStateRepCreator

staticprotected

---

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

• environmentProcessPublisherDIS.h