DtArealObjectPublisher Class Reference

Inheritance diagram for DtArealObjectPublisher:

Collaboration diagram for DtArealObjectPublisher:

Public Types
typedef DtArealObjectRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtArealObjectRepositories.

Public Member Functions
	DtArealObjectPublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
	DtArealObjectPublisher (DtArealObjectRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
	DtArealObjectPublisher (const DtSyntheticEnvironmentObjectType &type, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
virtual	~DtArealObjectPublisher ()
	Virtual DTOR.
virtual void	tick ()
	This function should be called once per frame for each point object.
virtual DtArealObjectRepository *	arealObjectStateRep ()
	Returns a pointer to the DtArealObjectRepository - through which you can set or inspect current state information.
virtual DtArealObjectRepository *	aosr ()
	Synonym for pointObjectStateRep().
virtual DtArealObjectDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.
virtual DtArealObjectEncoder *	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 point object's identifier.
virtual const DtObjectId &	localId () const
	Get the point object'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 DtArealObjectPublisher 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.
virtual void	setLocThreshold (double val)
	Set/Query the value of the Location Update Threshold.
virtual double	locThreshold () const
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.
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 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.
virtual void	setUseCustomThreshold (bool useCustom)
	Sets whether or not this object will use a custom threshold value, or the default.
virtual bool	useCustomThreshold ()
	Returns whether or not this object will use a custom threshold value, or the default.

Static Public Member Functions
static void	setDfltLocThreshold (double val)
	Get/Set default Location threshold.
static double	dfltLocThreshold ()
static void	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs.
static DtStateRepCreator	stateRepCreator ()
static void	setClassDfltTimeThreshold (DtTime threshold)
Static Public Member Functions inherited from DtObjectPublisher
static void	setDfltTimeThreshold (DtTime time)
	Set the default heartbeat rate.
static DtTime	dfltTimeThreshold ()
	The default heartbeat rate, see setDfltTimeThreshold().

Protected Member Functions
void	init (const DtObjectId &)
	Not virtual since called from constructor.
void	sendFinalPdu ()
	Not virtual since called from destructor.
Protected Member Functions inherited from DtObjectPublisher
virtual void	send (DtPdu *pdu) const
	Puts the PDU on the network and updates timestamps.

Protected Attributes
DtArealObjectDecoder *	myDecoder
DtArealObjectEncoder *	myEncoder
bool	myStateRepPassedFlag
bool	mySendFinalInDtor
Protected Attributes inherited from DtObjectPublisher
DtExerciseConn *	myExConn
DtStateRepository *	myStateRep
DtStateRepository *	myAsSeenByRemote
bool	myOkToDeleteStateRepFlag
bool	myUseCustomThreshold
DtTime	myTimeThreshold
DtTime	mySimTimeLastUpdate
	Set in const send() method.
DtTime	myRealTimeLastUpdate
	Set in const send() method.

Static Protected Attributes
static DtStateRepCreator	theStateRepCreator
static double	theDfltLocThreshold
static DtTime	theClassDfltTimeThreshold
static bool	theClassDfltIsSetFlag
Static Protected Attributes inherited from DtObjectPublisher
static DtTime	theDfltTimeThreshold

Private Member Functions
	DtArealObjectPublisher (const DtArealObjectPublisher &)
	Copy CTOR not implemented – Do Not Copy!
DtArealObjectPublisher &	operator= (const DtArealObjectPublisher &)
	Assignment Operator not implemented – Do Not Copy!

Member Typedef Documentation

typedef DtArealObjectRepository*(* DtArealObjectPublisher::DtStateRepCreator)()

Function prototype for functions that create DtArealObjectRepositories.

Constructor & Destructor Documentation

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

CTOR.

DtArealObjectPublisher::DtArealObjectPublisher	(	DtArealObjectRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	id = DtObjectId::defaultId()
	)

CTOR.

DtArealObjectPublisher::DtArealObjectPublisher	(	const DtSyntheticEnvironmentObjectType &	type,
		DtExerciseConn *	conn,
		const DtObjectId &	id = DtObjectId::defaultId()
	)

CTOR.

virtual DtArealObjectPublisher::~DtArealObjectPublisher ( )

virtual

Virtual DTOR.

DtArealObjectPublisher::DtArealObjectPublisher ( const DtArealObjectPublisher &  )

private

Copy CTOR not implemented – Do Not Copy!

Member Function Documentation

DtArealObjectRepository * DtArealObjectPublisher::aosr ( )

inlinevirtual

Synonym for pointObjectStateRep().

References DtObjectPublisher::myStateRep.

Referenced by arealObjectStateRep().

DtArealObjectRepository * DtArealObjectPublisher::arealObjectStateRep ( )

inlinevirtual

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

References aosr().

virtual DtArealObjectDecoder* DtArealObjectPublisher::decoder ( )

inlinevirtual

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

double DtArealObjectPublisher::dfltLocThreshold ( )

inlinestatic

References theDfltLocThreshold.

virtual DtArealObjectEncoder* DtArealObjectPublisher::encoder ( )

inlinevirtual

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

void DtArealObjectPublisher::forceUpdate ( )

inlinevirtual

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

Implements DtObjectPublisher.

References myEncoder, and DtStateEncoder::setSendNeeded().

virtual const DtGlobalObjectDesignator& DtArealObjectPublisher::globalId ( ) const

inlinevirtual

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

Implements DtObjectPublisher.

References DtObjectPublisher::id().

virtual const DtObjectId& DtArealObjectPublisher::id ( ) const

virtual

Get the point object's identifier.

Implements DtObjectPublisher.

void DtArealObjectPublisher::init ( const DtObjectId &  )

protected

Not virtual since called from constructor.

virtual const DtObjectId& DtArealObjectPublisher::localId ( ) const

inlinevirtual

Get the point object's localId - same as id for DIS.

Implements DtObjectPublisher.

References DtObjectPublisher::id().

virtual double DtArealObjectPublisher::locThreshold ( ) const

virtual

DtArealObjectPublisher& DtArealObjectPublisher::operator= ( const DtArealObjectPublisher &  )

private

Assignment Operator not implemented – Do Not Copy!

void DtArealObjectPublisher::sendFinalPdu ( )

protected

Not virtual since called from destructor.

void DtArealObjectPublisher::sendFinalPduOnDestruction ( bool  onOff )

inlinevirtual

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

References mySendFinalInDtor.

static void DtArealObjectPublisher::setClassDfltTimeThreshold ( DtTime  threshold )

static

void DtArealObjectPublisher::setDfltLocThreshold ( double  val )

inlinestatic

Get/Set default Location threshold.

References theDfltLocThreshold.

virtual void DtArealObjectPublisher::setLocThreshold ( double  val )

virtual

Set/Query the value of the Location Update Threshold.

static void DtArealObjectPublisher::setStateRepCreator ( DtStateRepCreator  creator )

static

Give us a function to be used for creating SRs.

static DtStateRepCreator DtArealObjectPublisher::stateRepCreator ( )

static

virtual void DtArealObjectPublisher::tick ( )

virtual

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

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

Implements DtObjectPublisher.

Member Data Documentation

DtArealObjectDecoder* DtArealObjectPublisher::myDecoder

protected

DtArealObjectEncoder* DtArealObjectPublisher::myEncoder

protected

Referenced by forceUpdate().

bool DtArealObjectPublisher::mySendFinalInDtor

protected

Referenced by sendFinalPduOnDestruction().

bool DtArealObjectPublisher::myStateRepPassedFlag

protected

bool DtArealObjectPublisher::theClassDfltIsSetFlag

staticprotected

DtTime DtArealObjectPublisher::theClassDfltTimeThreshold

staticprotected

double DtArealObjectPublisher::theDfltLocThreshold

staticprotected

Referenced by dfltLocThreshold(), and setDfltLocThreshold().

DtStateRepCreator DtArealObjectPublisher::theStateRepCreator

staticprotected

---

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

• arealObjectPublisherDIS.h