DtDesignatorPublisher Class Reference

Inheritance diagram for DtDesignatorPublisher:

Collaboration diagram for DtDesignatorPublisher:

List of all members.

Public Types
typedef DtDesignatorRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtDesignatorRepositories.
Public Member Functions
	DtDesignatorPublisher (DtDesignatorRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &entityId=DtObjectId::defaultId())
	constructor
	DtDesignatorPublisher (DtExerciseConn *conn, const DtObjectId &entityId=DtObjectId::defaultId())
	constructor
virtual	~DtDesignatorPublisher ()
	destructor
virtual void	tick ()
	This function should be called once per frame for each designator object.
virtual DtDesignatorRepository *	designatorStateRep ()
	Returns a pointer to the DesignatorRepository - through which you can set or inspect current state information.
virtual DtDesignatorRepository *	dsr ()
	Synonym for designatorStateRep().
virtual DtDesignatorDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.
virtual DtDesignatorEncoder *	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 designator's identifier.
virtual const DtObjectId &	localId () const
	Get the designator'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 DtDesignatorPublisher 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	setRelPosThreshold (double val)
	Set/Query the value of the "Relative Position" Update Threshold.
virtual double	relPosThreshold () const
virtual void	setAbsPosThreshold (double val)
	Set/Query the value of the "Relative Position" Update Threshold.
virtual double	absPosThreshold () const
virtual void	setAccelThreshold (double val)
	Set/Query the value of the "Relative Position" Update Threshold.
virtual double	accelThreshold () const
Static Public Member Functions
static void	setDfltRelPosThreshold (double val)
	Get/Set default "Relative Position" threshold.
static double	dfltRelPosThreshold ()
static void	setDfltAbsPosThreshold (double val)
	Get/Set default "Absolute Position" threshold.
static double	dfltAbsPosThreshold ()
static void	setDfltAccelThreshold (double val)
	Get/Set default "Acceleration" threshold.
static double	dfltAccelThreshold ()
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	init (const DtObjectId &)
	Not virtual since called from constructor.
void	sendFinalPdu ()
	Not virtual since called from destructor.
	DtDesignatorPublisher (const DtDesignatorPublisher &)
	copy constructor -- Not Implemented
DtDesignatorPublisher &	operator= (const DtDesignatorPublisher &)
	assignment operator -- Not Implemented
Protected Attributes
DtDesignatorDecoder *	myDecoder
DtDesignatorEncoder *	myEncoder
bool	mySendFinalInDtor
bool	myStateRepPassedFlag
Static Protected Attributes
static double	theDfltRelPosThreshold
static double	theDfltAbsPosThreshold
static double	theDfltAccelThreshold
static DtStateRepCreator	theStateRepCreator
static DtTime	theClassDfltTimeThreshold
static bool	theClassDfltIsSetFlag

---

Member Typedef Documentation

typedef DtDesignatorRepository*(* DtDesignatorPublisher::DtStateRepCreator)()

Function prototype for functions that create DtDesignatorRepositories.

---

Constructor & Destructor Documentation

DtDesignatorPublisher::DtDesignatorPublisher	(	DtDesignatorRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	entityId = DtObjectId::defaultId()
	)

constructor

DtDesignatorPublisher::DtDesignatorPublisher	(	DtExerciseConn *	conn,
		const DtObjectId &	entityId = DtObjectId::defaultId()
	)

constructor

virtual DtDesignatorPublisher::~DtDesignatorPublisher

(

)

[virtual]

destructor

DtDesignatorPublisher::DtDesignatorPublisher

(

const DtDesignatorPublisher &

)

[protected]

copy constructor -- Not Implemented

---

Member Function Documentation

virtual double DtDesignatorPublisher::absPosThreshold

(

)

const [virtual]

virtual double DtDesignatorPublisher::accelThreshold

(

)

const [virtual]

virtual DtDesignatorDecoder* DtDesignatorPublisher::decoder

(

)

[inline, virtual]

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

DtDesignatorRepository * DtDesignatorPublisher::designatorStateRep

(

)

[inline, virtual]

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

References dsr().

double DtDesignatorPublisher::dfltAbsPosThreshold

(

)

[inline, static]

References theDfltAbsPosThreshold.

double DtDesignatorPublisher::dfltAccelThreshold

(

)

[inline, static]

References theDfltAccelThreshold.

double DtDesignatorPublisher::dfltRelPosThreshold

(

)

[inline, static]

References theDfltRelPosThreshold.

DtDesignatorRepository * DtDesignatorPublisher::dsr

(

)

[inline, virtual]

Synonym for designatorStateRep().

References DtObjectPublisher::myStateRep.

Referenced by designatorStateRep().

virtual DtDesignatorEncoder* DtDesignatorPublisher::encoder

(

)

[inline, virtual]

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

void DtDesignatorPublisher::forceUpdate

(

)

[inline, virtual]

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& DtDesignatorPublisher::globalId

(

)

const [inline, virtual]

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

Implements DtObjectPublisher.

References DtObjectPublisher::id().

virtual const DtObjectId& DtDesignatorPublisher::id

(

)

const [virtual]

Get the designator's identifier.

Implements DtObjectPublisher.

void DtDesignatorPublisher::init

(

const DtObjectId &

)

[protected]

Not virtual since called from constructor.

virtual const DtObjectId& DtDesignatorPublisher::localId

(

)

const [inline, virtual]

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

Implements DtObjectPublisher.

References DtObjectPublisher::id().

DtDesignatorPublisher& DtDesignatorPublisher::operator=

(

const DtDesignatorPublisher &

)

[protected]

assignment operator -- Not Implemented

virtual double DtDesignatorPublisher::relPosThreshold

(

)

const [virtual]

void DtDesignatorPublisher::sendFinalPdu

(

)

[protected]

Not virtual since called from destructor.

void DtDesignatorPublisher::sendFinalPduOnDestruction

(

bool

onOff

)

[inline, virtual]

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

References mySendFinalInDtor.

virtual void DtDesignatorPublisher::setAbsPosThreshold

(

double

val

)

[virtual]

Set/Query the value of the "Relative Position" Update Threshold.

virtual void DtDesignatorPublisher::setAccelThreshold

(

double

val

)

[virtual]

Set/Query the value of the "Relative Position" Update Threshold.

static void DtDesignatorPublisher::setClassDfltTimeThreshold

(

DtTime

threshold

)

[static]

void DtDesignatorPublisher::setDfltAbsPosThreshold

(

double

val

)

[inline, static]

Get/Set default "Absolute Position" threshold.

References theDfltAbsPosThreshold.

void DtDesignatorPublisher::setDfltAccelThreshold

(

double

val

)

[inline, static]

Get/Set default "Acceleration" threshold.

References theDfltAccelThreshold.

void DtDesignatorPublisher::setDfltRelPosThreshold

(

double

val

)

[inline, static]

Get/Set default "Relative Position" threshold.

References theDfltRelPosThreshold.

virtual void DtDesignatorPublisher::setRelPosThreshold

(

double

val

)

[virtual]

Set/Query the value of the "Relative Position" Update Threshold.

static void DtDesignatorPublisher::setStateRepCreator

(

DtStateRepCreator

creator

)

[static]

Give us a function to be used for creating SRs.

static DtStateRepCreator DtDesignatorPublisher::stateRepCreator

(

void

)

[static]

virtual void DtDesignatorPublisher::tick

(

)

[virtual]

This function should be called once per frame for each designator 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

DtDesignatorDecoder* DtDesignatorPublisher::myDecoder [protected]

DtDesignatorEncoder* DtDesignatorPublisher::myEncoder [protected]

Referenced by forceUpdate().

bool DtDesignatorPublisher::mySendFinalInDtor [protected]

Referenced by sendFinalPduOnDestruction().

bool DtDesignatorPublisher::myStateRepPassedFlag [protected]

bool DtDesignatorPublisher::theClassDfltIsSetFlag [static, protected]

DtTime DtDesignatorPublisher::theClassDfltTimeThreshold [static, protected]

double DtDesignatorPublisher::theDfltAbsPosThreshold [static, protected]

Referenced by dfltAbsPosThreshold(), and setDfltAbsPosThreshold().

double DtDesignatorPublisher::theDfltAccelThreshold [static, protected]

Referenced by dfltAccelThreshold(), and setDfltAccelThreshold().

double DtDesignatorPublisher::theDfltRelPosThreshold [static, protected]

Referenced by dfltRelPosThreshold(), and setDfltRelPosThreshold().

DtStateRepCreator DtDesignatorPublisher::theStateRepCreator [static, protected]

---

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

• dDesignatrPub.h