DtGriddedDataPublisher Class Reference

Inheritance diagram for DtGriddedDataPublisher:

Collaboration diagram for DtGriddedDataPublisher:

List of all members.

Public Types
typedef DtGriddedDataRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtGriddedDataRepositories.
Public Member Functions
	DtGriddedDataPublisher (DtGriddedDataRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	Constructor.
	DtGriddedDataPublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	Constructor.
virtual	~DtGriddedDataPublisher ()
	destructor
virtual void	tick ()
	This function should be called once per frame for each gridded data object.
virtual DtGriddedDataRepository *	gridDataStateRep ()
	Returns a pointer to the GriddedDataRepository - through which you can set or inspect current state information.
virtual DtGriddedDataRepository *	gdsr ()
	Synonym for gridDataStateRep().
virtual DtGriddedDataDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.
virtual DtGriddedDataEncoder *	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 gridded data's identifier.
virtual const DtObjectId &	localId () const
	Get the gridded data'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 DtGriddedDataPublisher 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.
	DtGriddedDataPublisher (const DtGriddedDataPublisher &orig)
	copy constructor -- Not Implemented
DtGriddedDataPublisher &	operator= (const DtGriddedDataPublisher &orig)
	copy constructor -- Not Implemented
Protected Attributes
DtObjectId	myId
DtGriddedDataDecoder *	myDecoder
DtGriddedDataEncoder *	myEncoder
bool	mySendFinalInDtor
Static Protected Attributes
static DtStateRepCreator	theStateRepCreator
static DtTime	theClassDfltTimeThreshold
static bool	theClassDfltIsSetFlag

---

Member Typedef Documentation

typedef DtGriddedDataRepository*(* DtGriddedDataPublisher::DtStateRepCreator)()

Function prototype for functions that create DtGriddedDataRepositories.

---

Constructor & Destructor Documentation

DtGriddedDataPublisher::DtGriddedDataPublisher	(	DtGriddedDataRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	id = DtObjectId::defaultId()
	)

Constructor.

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

Constructor.

virtual DtGriddedDataPublisher::~DtGriddedDataPublisher

(

)

[virtual]

destructor

DtGriddedDataPublisher::DtGriddedDataPublisher

(

const DtGriddedDataPublisher &

orig

)

[protected]

copy constructor -- Not Implemented

---

Member Function Documentation

DtGriddedDataDecoder * DtGriddedDataPublisher::decoder

(

)

[inline, virtual]

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

References myDecoder.

DtGriddedDataEncoder * DtGriddedDataPublisher::encoder

(

)

[inline, virtual]

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

References myEncoder.

virtual void DtGriddedDataPublisher::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.

DtGriddedDataRepository * DtGriddedDataPublisher::gdsr

(

)

[inline, virtual]

Synonym for gridDataStateRep().

References DtObjectPublisher::myStateRep.

Referenced by gridDataStateRep().

virtual const DtGlobalObjectDesignator& DtGriddedDataPublisher::globalId

(

)

const [virtual]

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

Implements DtObjectPublisher.

DtGriddedDataRepository * DtGriddedDataPublisher::gridDataStateRep

(

)

[inline, virtual]

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

References gdsr().

const DtObjectId & DtGriddedDataPublisher::id

(

)

const [inline, virtual]

Get the gridded data's identifier.

Implements DtObjectPublisher.

References myId.

Referenced by localId().

void DtGriddedDataPublisher::init

(

const DtEntityIdentifier &

vehId

)

[protected]

Not virtual since called from constructor.

const DtObjectId & DtGriddedDataPublisher::localId

(

)

const [inline, virtual]

Get the gridded data's localId - same as id for DIS.

Implements DtObjectPublisher.

References id().

DtGriddedDataPublisher& DtGriddedDataPublisher::operator=

(

const DtGriddedDataPublisher &

orig

)

[protected]

copy constructor -- Not Implemented

void DtGriddedDataPublisher::sendFinalPdu

(

)

[protected]

Not virtual since called from destructor.

void DtGriddedDataPublisher::sendFinalPduOnDestruction

(

bool

onOff

)

[inline, virtual]

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

References mySendFinalInDtor.

static void DtGriddedDataPublisher::setClassDfltTimeThreshold

(

DtTime

threshold

)

[static]

static void DtGriddedDataPublisher::setStateRepCreator

(

DtStateRepCreator

creator

)

[static]

Give us a function to be used for creating SRs.

static DtStateRepCreator DtGriddedDataPublisher::stateRepCreator

(

void

)

[static]

virtual void DtGriddedDataPublisher::tick

(

)

[virtual]

This function should be called once per frame for each gridded data object.

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

Implements DtObjectPublisher.

---

Member Data Documentation

DtGriddedDataDecoder* DtGriddedDataPublisher::myDecoder [protected]

Referenced by decoder().

DtGriddedDataEncoder* DtGriddedDataPublisher::myEncoder [protected]

Referenced by encoder().

DtObjectId DtGriddedDataPublisher::myId [protected]

Referenced by id().

bool DtGriddedDataPublisher::mySendFinalInDtor [protected]

Referenced by sendFinalPduOnDestruction().

bool DtGriddedDataPublisher::theClassDfltIsSetFlag [static, protected]

DtTime DtGriddedDataPublisher::theClassDfltTimeThreshold [static, protected]

DtStateRepCreator DtGriddedDataPublisher::theStateRepCreator [static, protected]

---

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

• dGridDataPub.h