DtPointObjectPublisher Class Reference

Inheritance diagram for DtPointObjectPublisher:

Collaboration diagram for DtPointObjectPublisher:

Public Types
typedef DtPointObjectRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtPointObjectRepositories.

Public Member Functions
	DtPointObjectPublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
	DtPointObjectPublisher (DtPointObjectRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
	DtPointObjectPublisher (const DtSyntheticEnvironmentObjectType &type, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
virtual	~DtPointObjectPublisher ()
	Virtual DTOR.
virtual void	tick ()
	This function should be called once per frame for each point object.
virtual DtPointObjectRepository *	pointObjectStateRep ()
	Returns a pointer to the DtPointObjectRepository - through which you can set or inspect current state information.
virtual DtPointObjectRepository *	posr ()
	Synonym for pointObjectStateRep().
virtual DtPointObjectDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.
virtual DtPointObjectEncoder *	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 DtPointObjectPublisher 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
virtual void	setOriThreshold (double val)
	Set/Query the value of the Orientation Update Threshold.
virtual double	oriThreshold () 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	parallelTick ()
	Tick (update) this object in parallel threads.
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	setDfltOriThreshold (double val)
	Get/Set default Orientation threshold.
static double	dfltOriThreshold ()
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
DtPointObjectDecoder *	myDecoder
DtPointObjectEncoder *	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 double	theDfltOriThreshold
static DtTime	theClassDfltTimeThreshold
static bool	theClassDfltIsSetFlag
Static Protected Attributes inherited from DtObjectPublisher
static DtTime	theDfltTimeThreshold

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

Member Typedef Documentation

typedef DtPointObjectRepository*(* DtPointObjectPublisher::DtStateRepCreator)()

Function prototype for functions that create DtPointObjectRepositories.

Constructor & Destructor Documentation

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

CTOR.

DtPointObjectPublisher::DtPointObjectPublisher	(	DtPointObjectRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	id = DtObjectId::defaultId()
	)

CTOR.

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

CTOR.

virtual DtPointObjectPublisher::~DtPointObjectPublisher ( )

virtual

Virtual DTOR.

DtPointObjectPublisher::DtPointObjectPublisher ( const DtPointObjectPublisher &  )

private

Copy CTOR not implemented – Do Not Copy!

Member Function Documentation

virtual DtPointObjectDecoder* DtPointObjectPublisher::decoder ( )

inlinevirtual

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

double DtPointObjectPublisher::dfltLocThreshold ( )

inlinestatic

References theDfltLocThreshold.

double DtPointObjectPublisher::dfltOriThreshold ( )

inlinestatic

References theDfltOriThreshold.

virtual DtPointObjectEncoder* DtPointObjectPublisher::encoder ( )

inlinevirtual

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

void DtPointObjectPublisher::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& DtPointObjectPublisher::globalId ( ) const

inlinevirtual

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

Implements DtObjectPublisher.

References DtObjectPublisher::id().

virtual const DtObjectId& DtPointObjectPublisher::id ( ) const

virtual

Get the point object's identifier.

Implements DtObjectPublisher.

void DtPointObjectPublisher::init ( const DtObjectId &  )

protected

Not virtual since called from constructor.

virtual const DtObjectId& DtPointObjectPublisher::localId ( ) const

inlinevirtual

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

Implements DtObjectPublisher.

References DtObjectPublisher::id().

virtual double DtPointObjectPublisher::locThreshold ( ) const

virtual

DtPointObjectPublisher& DtPointObjectPublisher::operator= ( const DtPointObjectPublisher &  )

private

Assignment Operator not implemented – Do Not Copy!

virtual double DtPointObjectPublisher::oriThreshold ( ) const

virtual

DtPointObjectRepository * DtPointObjectPublisher::pointObjectStateRep ( )

inlinevirtual

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

References posr().

DtPointObjectRepository * DtPointObjectPublisher::posr ( )

inlinevirtual

Synonym for pointObjectStateRep().

References DtObjectPublisher::myStateRep.

Referenced by pointObjectStateRep().

void DtPointObjectPublisher::sendFinalPdu ( )

protected

Not virtual since called from destructor.

void DtPointObjectPublisher::sendFinalPduOnDestruction ( bool  onOff )

inlinevirtual

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

References mySendFinalInDtor.

static void DtPointObjectPublisher::setClassDfltTimeThreshold ( DtTime  threshold )

static

void DtPointObjectPublisher::setDfltLocThreshold ( double  val )

inlinestatic

Get/Set default Location threshold.

References theDfltLocThreshold.

void DtPointObjectPublisher::setDfltOriThreshold ( double  val )

inlinestatic

Get/Set default Orientation threshold.

References theDfltOriThreshold.

virtual void DtPointObjectPublisher::setLocThreshold ( double  val )

virtual

Set/Query the value of the Location Update Threshold.

virtual void DtPointObjectPublisher::setOriThreshold ( double  val )

virtual

Set/Query the value of the Orientation Update Threshold.

static void DtPointObjectPublisher::setStateRepCreator ( DtStateRepCreator  creator )

static

Give us a function to be used for creating SRs.

static DtStateRepCreator DtPointObjectPublisher::stateRepCreator ( )

static

virtual void DtPointObjectPublisher::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

DtPointObjectDecoder* DtPointObjectPublisher::myDecoder

protected

DtPointObjectEncoder* DtPointObjectPublisher::myEncoder

protected

Referenced by forceUpdate().

bool DtPointObjectPublisher::mySendFinalInDtor

protected

Referenced by sendFinalPduOnDestruction().

bool DtPointObjectPublisher::myStateRepPassedFlag

protected

bool DtPointObjectPublisher::theClassDfltIsSetFlag

staticprotected

DtTime DtPointObjectPublisher::theClassDfltTimeThreshold

staticprotected

double DtPointObjectPublisher::theDfltLocThreshold

staticprotected

Referenced by dfltLocThreshold(), and setDfltLocThreshold().

double DtPointObjectPublisher::theDfltOriThreshold

staticprotected

Referenced by dfltOriThreshold(), and setDfltOriThreshold().

DtStateRepCreator DtPointObjectPublisher::theStateRepCreator

staticprotected

---

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

• pointObjectPublisherDIS.h