DtRadioReceiverPublisher Class Reference

Inheritance diagram for DtRadioReceiverPublisher:

Collaboration diagram for DtRadioReceiverPublisher:

List of all members.

Public Types
typedef DtRadioReceiverRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtRadioReceiverRepositories.
Public Member Functions
	DtRadioReceiverPublisher (DtRadioReceiverRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &entityId=DtObjectId::defaultId())
	Constructor -- State Rep must contain a radio ID.
	DtRadioReceiverPublisher (DtExerciseConn *conn, const DtObjectId &entityId=DtObjectId::defaultId(), int radioId=1)
	Constructor.
virtual	~DtRadioReceiverPublisher ()
	Destructor.
virtual void	tick ()
	This function should be called once per frame for each radio receiver object.
virtual DtRadioReceiverRepository *	receiverRep ()
	Returns a pointer to the RadioReceiverRepository - through which you can set or inspect current state information.
virtual DtRadioReceiverRepository *	rsr ()
	Synonym for receiverRep()
virtual DtRadioReceiverDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.
virtual DtRadioReceiverEncoder *	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 radio receiver's identifier.
virtual const DtObjectId &	localId () const
	Get the radio receiver's localId - same as id for DIS.
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the global object designator - same as id for DIS.
virtual int	radioId () const
	Get the radio ID.
virtual void	sendFinalPduOnDestruction (bool onOff)
	Set flag indicating whether to send a final PDU with the "FinalPdu" appearance bit set, from within the DtRadioReceiverPublisher 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
	DtRadioReceiverPublisher (const DtRadioReceiverPublisher &orig)
	copy constructor -- Not Implemented
DtRadioReceiverPublisher &	operator= (const DtRadioReceiverPublisher &orig)
	copy constructor -- Not Implemented
Protected Attributes
DtObjectId	myId
DtRadioReceiverDecoder *	myDecoder
DtRadioReceiverEncoder *	myEncoder
bool	mySendFinalInDtor
Static Protected Attributes
static DtStateRepCreator	theStateRepCreator
static DtTime	theClassDfltTimeThreshold
static bool	theClassDfltIsSetFlag

---

Member Typedef Documentation

typedef DtRadioReceiverRepository*(* DtRadioReceiverPublisher::DtStateRepCreator)()

Function prototype for functions that create DtRadioReceiverRepositories.

---

Constructor & Destructor Documentation

DtRadioReceiverPublisher::DtRadioReceiverPublisher	(	DtRadioReceiverRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	entityId = DtObjectId::defaultId()
	)

Constructor -- State Rep must contain a radio ID.

DtRadioReceiverPublisher::DtRadioReceiverPublisher	(	DtExerciseConn *	conn,
		const DtObjectId &	entityId = DtObjectId::defaultId(),
		int	radioId = 1
	)

Constructor.

virtual DtRadioReceiverPublisher::~DtRadioReceiverPublisher

(

)

[virtual]

Destructor.

DtRadioReceiverPublisher::DtRadioReceiverPublisher

(

const DtRadioReceiverPublisher &

orig

)

[protected]

copy constructor -- Not Implemented

---

Member Function Documentation

virtual DtRadioReceiverDecoder* DtRadioReceiverPublisher::decoder

(

)

[virtual]

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

virtual DtRadioReceiverEncoder* DtRadioReceiverPublisher::encoder

(

)

[virtual]

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

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

virtual const DtGlobalObjectDesignator& DtRadioReceiverPublisher::globalId

(

)

const [virtual]

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

Implements DtObjectPublisher.

virtual const DtObjectId& DtRadioReceiverPublisher::id

(

)

const [virtual]

Get the radio receiver's identifier.

Implements DtObjectPublisher.

void DtRadioReceiverPublisher::init

(

const DtEntityIdentifier &

vehId

)

[protected]

not virtual since called from constructor

virtual const DtObjectId& DtRadioReceiverPublisher::localId

(

)

const [virtual]

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

Implements DtObjectPublisher.

DtRadioReceiverPublisher& DtRadioReceiverPublisher::operator=

(

const DtRadioReceiverPublisher &

orig

)

[protected]

copy constructor -- Not Implemented

virtual int DtRadioReceiverPublisher::radioId

(

)

const [virtual]

Get the radio ID.

virtual DtRadioReceiverRepository* DtRadioReceiverPublisher::receiverRep

(

)

[virtual]

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

DtRadioReceiverRepository * DtRadioReceiverPublisher::rsr

(

)

[inline, virtual]

Synonym for receiverRep()

References DtObjectPublisher::myStateRep.

void DtRadioReceiverPublisher::sendFinalPdu

(

)

[protected]

not virtual since called from destructor.

virtual void DtRadioReceiverPublisher::sendFinalPduOnDestruction

(

bool

onOff

)

[virtual]

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

static void DtRadioReceiverPublisher::setClassDfltTimeThreshold

(

DtTime

threshold

)

[static]

static void DtRadioReceiverPublisher::setStateRepCreator

(

DtStateRepCreator

creator

)

[static]

Give us a function to be used for creating SRs.

static DtStateRepCreator DtRadioReceiverPublisher::stateRepCreator

(

void

)

[static]

virtual void DtRadioReceiverPublisher::tick

(

)

[virtual]

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

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

Implements DtObjectPublisher.

---

Member Data Documentation

DtRadioReceiverDecoder* DtRadioReceiverPublisher::myDecoder [protected]

DtRadioReceiverEncoder* DtRadioReceiverPublisher::myEncoder [protected]

DtObjectId DtRadioReceiverPublisher::myId [protected]

bool DtRadioReceiverPublisher::mySendFinalInDtor [protected]

bool DtRadioReceiverPublisher::theClassDfltIsSetFlag [static, protected]

DtTime DtRadioReceiverPublisher::theClassDfltTimeThreshold [static, protected]

DtStateRepCreator DtRadioReceiverPublisher::theStateRepCreator [static, protected]

---

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

• dRadioRcvrPub.h