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:

List of all members.

Public Types
typedef DtEnvironmentProcessRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtEnvironmentProcessRepositories.
Public Member Functions
	DtEnvironmentProcessPublisher (DtEnvironmentProcessRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	constructor
	DtEnvironmentProcessPublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	constructor
virtual	~DtEnvironmentProcessPublisher ()
	destructor
virtual void	tick ()
	This function should be called once per frame for each environment process object.
virtual DtEnvironmentProcessRepository *	environmentProcessStateRep ()
	Returns a pointer to the EnvironmentProcessRepository - through which you can set or inspect current state information.
virtual DtEnvironmentProcessRepository *	epsr ()
	Synonym for environmentProcessStateRep().
virtual DtEnvironmentProcessDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.
virtual DtEnvironmentProcessEncoder *	encoder ()
	Returns a pointer to the Encoder being used to encode current state into an entity state PDU.
virtual const DtObjectId &	id () const
	Get the environment process's identifier.
virtual const DtObjectId &	localId () const
	Get the environment process's localId - same as id for DIS.
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the global object designator - same as id for DIS.
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.
virtual void	forceUpdate ()
	Force a state update to be sent during the next call to tick, even if nothing would normally cause a send.
Static Public Member Functions
static void	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs.
static DtStateRepCreator	stateRepCreator (void)
static void	setClassDfltTimeThreshold (DtTime threshold)
Protected Member Functions
void	sendFinalPdu ()
	Not virtual since called from destructor.
void	init (const DtEntityIdentifier &vehId)
	Not virtual since called from constructor.
	DtEnvironmentProcessPublisher (const DtEnvironmentProcessPublisher &orig)
DtEnvironmentProcessPublisher &	operator= (const DtEnvironmentProcessPublisher &orig)
	copy constructor -- not implemented
Protected Attributes
DtObjectId	myId
DtEnvironmentProcessDecoder *	myDecoder
DtEnvironmentProcessEncoder *	myEncoder
bool	mySendFinalInDtor
Static Protected Attributes
static DtStateRepCreator	theStateRepCreator
static DtTime	theClassDfltTimeThreshold
static bool	theClassDfltIsSetFlag

---

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

(

)

[inline, virtual]

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

References myDecoder.

DtEnvironmentProcessEncoder * DtEnvironmentProcessPublisher::encoder

(

)

[inline, virtual]

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

References myEncoder.

DtEnvironmentProcessRepository * DtEnvironmentProcessPublisher::environmentProcessStateRep

(

)

[inline, virtual]

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

References epsr().

DtEnvironmentProcessRepository * DtEnvironmentProcessPublisher::epsr

(

)

[inline, virtual]

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 [inline, virtual]

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 [inline, virtual]

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

)

[inline, virtual]

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 void 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.

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 [static, protected]

DtTime DtEnvironmentProcessPublisher::theClassDfltTimeThreshold [static, protected]

DtStateRepCreator DtEnvironmentProcessPublisher::theStateRepCreator [static, protected]

---

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

• dEnvProcPub.h