DtLinearObjectPublisher Class Reference

Inheritance diagram for DtLinearObjectPublisher:

Collaboration diagram for DtLinearObjectPublisher:

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

Public Member Functions
	DtLinearObjectPublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
	DtLinearObjectPublisher (DtLinearObjectRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
	DtLinearObjectPublisher (const DtSyntheticEnvironmentObjectType &type, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
virtual	~DtLinearObjectPublisher ()
	Virtual DTOR.
virtual void	tick ()
	This function should be called once per frame for each point object.
virtual DtLinearObjectRepository *	linearObjectStateRep ()
	Returns a pointer to the DtLinearObjectRepository - through which you can set or inspect current state information.
virtual DtLinearObjectRepository *	losr ()
	Synonym for pointObjectStateRep().
virtual DtLinearObjectDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.
virtual DtLinearObjectEncoder *	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 DtLinearObjectPublisher 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	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 void	setRelLocTimeThreshold (DtTime time)
	Set the heartbeat rate of relative location updates for this object.
virtual DtTime	relLocTimeThreshold () const
	The relative location 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	lastTimeAttrUpdated () const
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.
virtual void	setAttributePduStrategy (DtAttributePduStrategy strat)
	Sets/Gets whether to couple the attribute PDU.
virtual DtAttributePduStrategy	attributePduStrategy () const
virtual void	encodeExtensions (DtStateRepository *stateRep, const DtStateRepository &asSeenByRemote)
	Encode State Repository Extensions. Extensions should be added to stateRep attributeRecords.
virtual void	decodeExtensions (DtPdu *pdu, const DtStateRepository &stateRep)
	Decode State Repository Extensions.
DtNonCoupledAttributePduCreator	setNonCoupledAttributePduCreator (DtNonCoupledAttributePduCreator creator)
	Give us a function to be used for creating non-coupled Attribute PDUs.
DtNonCoupledAttributePduCreator	nonCoupledAttributePduCreator (void)

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().
static void	setDfltRelLocTimeThreshold (DtTime time)
	Set the default heartbeat rate for relative location updates.
static DtTime	dfltRelLocTimeThreshold ()
	The default heartbeat rate for relative location updates, see setDfltRelLocTimeThreshold()
static DtNonCoupledAttributePduCreator	setDefaultNonCoupledAttributePduCreator (DtNonCoupledAttributePduCreator creator)
	Give us a function to be used for creating non-coupled Attribute PDUs.
static DtNonCoupledAttributePduCreator	defaultNonCoupledAttributePduCreator (void)

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
DtLinearObjectDecoder *	myDecoder
DtLinearObjectEncoder *	myEncoder
bool	myStateRepPassedFlag
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.
DtTime	myRelLocTimeThreshold
	Time threshold for heartbeat rate of relative location updates (only for embarked/attached entities)
DtTime	mySimTimeLastUpdate
	Set in const send() method.
DtTime	myRealTimeLastUpdate
	Set in const send() method.
DtTime	myRealTimeLastAttrUpdate
DtNonCoupledAttributePduCreator	myNonCoupledAttributePduCreator
DtAttributePduStrategy	myAttributePduStrategy
std::vector < DtStateRepositoryExtensionEncoder * >	myStateRepositoryExtensionEncoderList
std::vector < DtStateRepositoryExtensionDecoder * >	myStateRepositoryExtensionDecoderList

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

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

Member Typedef Documentation

typedef DtLinearObjectRepository*(* DtLinearObjectPublisher::DtStateRepCreator)()

Function prototype for functions that create DtLinearObjectRepositories.

Constructor & Destructor Documentation

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

CTOR.

DtLinearObjectPublisher::DtLinearObjectPublisher	(	DtLinearObjectRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	id = DtObjectId::defaultId()
	)

CTOR.

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

CTOR.

virtual DtLinearObjectPublisher::~DtLinearObjectPublisher ( )

virtual

Virtual DTOR.

DtLinearObjectPublisher::DtLinearObjectPublisher ( const DtLinearObjectPublisher &  )

private

Copy CTOR not implemented – Do Not Copy!

Member Function Documentation

virtual DtLinearObjectDecoder* DtLinearObjectPublisher::decoder ( )

inlinevirtual

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

double DtLinearObjectPublisher::dfltLocThreshold ( )

inlinestatic

References theDfltLocThreshold.

virtual DtLinearObjectEncoder* DtLinearObjectPublisher::encoder ( )

inlinevirtual

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

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

inlinevirtual

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

Implements DtObjectPublisher.

References DtObjectPublisher::id().

virtual const DtObjectId& DtLinearObjectPublisher::id ( ) const

virtual

Get the point object's identifier.

Implements DtObjectPublisher.

void DtLinearObjectPublisher::init ( const DtObjectId &  )

protected

Not virtual since called from constructor.

DtLinearObjectRepository * DtLinearObjectPublisher::linearObjectStateRep ( )

inlinevirtual

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

References losr().

virtual const DtObjectId& DtLinearObjectPublisher::localId ( ) const

inlinevirtual

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

Implements DtObjectPublisher.

References DtObjectPublisher::id().

virtual double DtLinearObjectPublisher::locThreshold ( ) const

virtual

DtLinearObjectRepository * DtLinearObjectPublisher::losr ( )

inlinevirtual

Synonym for pointObjectStateRep().

References DtObjectPublisher::myStateRep.

Referenced by linearObjectStateRep().

DtLinearObjectPublisher& DtLinearObjectPublisher::operator= ( const DtLinearObjectPublisher &  )

private

Assignment Operator not implemented – Do Not Copy!

void DtLinearObjectPublisher::sendFinalPdu ( )

protected

Not virtual since called from destructor.

void DtLinearObjectPublisher::sendFinalPduOnDestruction ( bool  onOff )

inlinevirtual

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

References mySendFinalInDtor.

static void DtLinearObjectPublisher::setClassDfltTimeThreshold ( DtTime  threshold )

static

void DtLinearObjectPublisher::setDfltLocThreshold ( double  val )

inlinestatic

Get/Set default Location threshold.

References theDfltLocThreshold.

virtual void DtLinearObjectPublisher::setLocThreshold ( double  val )

virtual

Set/Query the value of the Location Update Threshold.

static void DtLinearObjectPublisher::setStateRepCreator ( DtStateRepCreator  creator )

static

Give us a function to be used for creating SRs.

static DtStateRepCreator DtLinearObjectPublisher::stateRepCreator ( )

static

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

DtLinearObjectDecoder* DtLinearObjectPublisher::myDecoder

protected

DtLinearObjectEncoder* DtLinearObjectPublisher::myEncoder

protected

Referenced by forceUpdate().

bool DtLinearObjectPublisher::mySendFinalInDtor

protected

Referenced by sendFinalPduOnDestruction().

bool DtLinearObjectPublisher::myStateRepPassedFlag

protected

bool DtLinearObjectPublisher::theClassDfltIsSetFlag

staticprotected

DtTime DtLinearObjectPublisher::theClassDfltTimeThreshold

staticprotected

double DtLinearObjectPublisher::theDfltLocThreshold

staticprotected

Referenced by dfltLocThreshold(), and setDfltLocThreshold().

DtStateRepCreator DtLinearObjectPublisher::theStateRepCreator

staticprotected

---

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

• linearObjectPublisherDIS.h