DtEntityPublisher Class Reference

Instances of DtEntityPublisher are used for local or source simulations of entities, (i.e. More...

Inheritance diagram for DtEntityPublisher:

Collaboration diagram for DtEntityPublisher:

List of all members.

Public Types
typedef DtEntityStateRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtEntityStateRepositories.
Public Member Functions
	DtEntityPublisher (DtEntityStateRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	Constructor.
	DtEntityPublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	Constructor.
	DtEntityPublisher (const DtEntityType &type, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	Constructor.
	DtEntityPublisher (const DtEntityType &type, DtExerciseConn *conn, DtDeadReckonTypes algorithm, DtForceType forceId, const DtEntityType &guise=guiseSameAsType(), const DtObjectId &id=DtObjectId::defaultId())
	Constructor.
virtual	~DtEntityPublisher ()
	Destructors.
virtual void	tick ()
	This function should be called once per frame for each entity.
virtual DtEntityStateRepository *	entityStateRep ()
	Returns a pointer to the EntityStateRepository - through which you can set or inspect current state information.
virtual DtEntityStateRepository *	esr ()
	Synonym for entityStateRep().
virtual DtEntityStateDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.
virtual DtEntityStateEncoder *	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 entity's identifier.
virtual const DtObjectId &	localId () const
	Get the entity'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 on)
	Set flag indicating whether to send a final PDU with the "FinalPdu" appearance bit set, from within the DtEntityPublisher 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	setSendDiGuyPdus (bool yesNo)
	Tell the publisher to send DI Guy PDU's.
virtual bool	sendDiGuyPdus () const
	Determine whether this publisher will send DI Guy PDU's.
virtual void	setSendSeesPdus (bool yesNo)
	Tell the publisher to send SEES PDU's.
virtual bool	sendSeesPdus () const
	Determine whether this publisher will send SEES PDU's.
virtual void	setSeesTimeThreshold (DtTime time)
	Set the SEES time threshold for sending a PDU.
virtual DtTime	seesTimeThreshold () const
	Return the SEES time threshold.
Static Public Member Functions
static const DtEntityType &	guiseSameAsType ()
static void	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs.
static DtStateRepCreator	stateRepCreator (void)
static void	setClassDfltTimeThreshold (DtTime threshold)
static void	setDfltRotationThreshold (double r)
static double	dfltRotationThreshold ()
static void	setDfltTranslationThreshold (double t)
static double	dfltTranslationThreshold ()
Protected Member Functions
void	sendFinalPdu ()
	Not virtual since called from destructor.
virtual void	createAndSendDiGuyPdus ()
	Send DI Guy PDU's (if needed).
virtual void	createAndSendSeesPdu ()
	Send SEES PDU.
virtual bool	sendSeesNeeded () const
void	init (const DtObjectId &vehId)
	Not virtual since called from constructor.
Protected Attributes
DtObjectId	myId
DtEntityStateDecoder *	myEntityDecoder
DtEntityStateEncoder *	myEntityEncoder
bool	mySendFinalInDtor
bool	mySendDiGuyPdus
bool	mySendSeesPdus
DtTime	mySeesPdusTimeThreshold
DtTime	myLastSeesPdusUpdate
Static Protected Attributes
static DtStateRepCreator	theStateRepCreator
static DtTime	theClassDfltTimeThreshold
static bool	theClassDfltIsSetFlag
Private Member Functions
	DtEntityPublisher (const DtEntityPublisher &orig)
	copy constructor - Not Implemented
DtEntityPublisher &	operator= (const DtEntityPublisher &orig)
	assignment operator - Not Implemented

---

Detailed Description

Instances of DtEntityPublisher are used for local or source simulations of entities, (i.e.

these entities are not dependent on data being produced elsewhere on the network for their existence). These entities send data to the network.

---

Member Typedef Documentation

typedef DtEntityStateRepository*(* DtEntityPublisher::DtStateRepCreator)()

Function prototype for functions that create DtEntityStateRepositories.

---

Constructor & Destructor Documentation

DtEntityPublisher::DtEntityPublisher	(	DtEntityStateRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	id = DtObjectId::defaultId()
	)

Constructor.

DtObjectId::defaultId() returns a special DtObjectId that is a signal to the DtEntityPublisher constructor that it should obtain its own ObjectId.

DtEntityType::defaultType() returns a special DtEntityType that indicates to the DtEntityPublisher constructor that the entity type should also be used as the guise.

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

Constructor.

DtObjectId::defaultId() returns a special DtObjectId that is a signal to the DtEntityPublisher constructor that it should obtain its own ObjectId.

DtEntityType::defaultType() returns a special DtEntityType that indicates to the DtEntityPublisher constructor that the entity type should also be used as the guise.

DtEntityPublisher::DtEntityPublisher	(	const DtEntityType &	type,
		DtExerciseConn *	conn,
		const DtObjectId &	id = DtObjectId::defaultId()
	)

Constructor.

DtObjectId::defaultId() returns a special DtObjectId that is a signal to the DtEntityPublisher constructor that it should obtain its own ObjectId.

DtEntityType::defaultType() returns a special DtEntityType that indicates to the DtEntityPublisher constructor that the entity type should also be used as the guise.

DtEntityPublisher::DtEntityPublisher	(	const DtEntityType &	type,
		DtExerciseConn *	conn,
		DtDeadReckonTypes	algorithm,
		DtForceType	forceId,
		const DtEntityType &	guise = guiseSameAsType(),
		const DtObjectId &	id = DtObjectId::defaultId()
	)

Constructor.

DtObjectId::defaultId() returns a special DtObjectId that is a signal to the DtEntityPublisher constructor that it should obtain its own ObjectId.

DtEntityType::defaultType() returns a special DtEntityType that indicates to the DtEntityPublisher constructor that the entity type should also be used as the guise.

virtual DtEntityPublisher::~DtEntityPublisher

(

)

[virtual]

Destructors.

DtEntityPublisher::DtEntityPublisher

(

const DtEntityPublisher &

orig

)

[private]

copy constructor - Not Implemented

---

Member Function Documentation

virtual void DtEntityPublisher::createAndSendDiGuyPdus

(

)

[protected, virtual]

Send DI Guy PDU's (if needed).

virtual void DtEntityPublisher::createAndSendSeesPdu

(

)

[protected, virtual]

Send SEES PDU.

DtEntityStateDecoder * DtEntityPublisher::decoder

(

)

[inline, virtual]

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

References myEntityDecoder.

double DtEntityPublisher::dfltRotationThreshold

(

)

[inline, static]

Deprecated:

Please use the DtThresholder static member functions instead.

double DtEntityPublisher::dfltTranslationThreshold

(

)

[inline, static]

Deprecated:

Please use the DtThresholder static member functions instead.

DtEntityStateEncoder * DtEntityPublisher::encoder

(

)

[inline, virtual]

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

References myEntityEncoder.

DtEntityStateRepository * DtEntityPublisher::entityStateRep

(

)

[inline, virtual]

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

References esr().

DtEntityStateRepository * DtEntityPublisher::esr

(

)

[inline, virtual]

Synonym for entityStateRep().

References DtObjectPublisher::stateRep().

Referenced by entityStateRep().

virtual void DtEntityPublisher::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& DtEntityPublisher::globalId

(

)

const [virtual]

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

Implements DtObjectPublisher.

static const DtEntityType& DtEntityPublisher::guiseSameAsType

(

)

[static]

const DtObjectId & DtEntityPublisher::id

(

)

const [inline, virtual]

Get the entity's identifier.

Implements DtObjectPublisher.

References myId.

Referenced by localId().

void DtEntityPublisher::init

(

const DtObjectId &

vehId

)

[protected]

Not virtual since called from constructor.

const DtObjectId & DtEntityPublisher::localId

(

)

const [inline, virtual]

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

Implements DtObjectPublisher.

References id().

DtEntityPublisher& DtEntityPublisher::operator=

(

const DtEntityPublisher &

orig

)

[private]

assignment operator - Not Implemented

virtual DtTime DtEntityPublisher::seesTimeThreshold

(

)

const [virtual]

Return the SEES time threshold.

virtual bool DtEntityPublisher::sendDiGuyPdus

(

)

const [virtual]

Determine whether this publisher will send DI Guy PDU's.

void DtEntityPublisher::sendFinalPdu

(

)

[protected]

Not virtual since called from destructor.

void DtEntityPublisher::sendFinalPduOnDestruction

(

bool

on

)

[inline, virtual]

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

References mySendFinalInDtor.

virtual bool DtEntityPublisher::sendSeesNeeded

(

)

const [protected, virtual]

virtual bool DtEntityPublisher::sendSeesPdus

(

)

const [virtual]

Determine whether this publisher will send SEES PDU's.

static void DtEntityPublisher::setClassDfltTimeThreshold

(

DtTime

threshold

)

[static]

void DtEntityPublisher::setDfltRotationThreshold

(

double

r

)

[inline, static]

Deprecated:

Please use the DtThresholder static member functions instead.

void DtEntityPublisher::setDfltTranslationThreshold

(

double

t

)

[inline, static]

Deprecated:

Please use the DtThresholder static member functions instead.

virtual void DtEntityPublisher::setSeesTimeThreshold

(

DtTime

time

)

[virtual]

Set the SEES time threshold for sending a PDU.

virtual void DtEntityPublisher::setSendDiGuyPdus

(

bool

yesNo

)

[virtual]

Tell the publisher to send DI Guy PDU's.

virtual void DtEntityPublisher::setSendSeesPdus

(

bool

yesNo

)

[virtual]

Tell the publisher to send SEES PDU's.

static void DtEntityPublisher::setStateRepCreator

(

DtStateRepCreator

creator

)

[static]

Give us a function to be used for creating SRs.

static DtStateRepCreator DtEntityPublisher::stateRepCreator

(

void

)

[static]

virtual void DtEntityPublisher::tick

(

)

[virtual]

This function should be called once per frame for each entity.

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

Implements DtObjectPublisher.

---

Member Data Documentation

DtEntityStateDecoder* DtEntityPublisher::myEntityDecoder [protected]

Referenced by decoder().

DtEntityStateEncoder* DtEntityPublisher::myEntityEncoder [protected]

Referenced by encoder().

DtObjectId DtEntityPublisher::myId [protected]

Referenced by id().

DtTime DtEntityPublisher::myLastSeesPdusUpdate [protected]

DtTime DtEntityPublisher::mySeesPdusTimeThreshold [protected]

bool DtEntityPublisher::mySendDiGuyPdus [protected]

bool DtEntityPublisher::mySendFinalInDtor [protected]

Referenced by sendFinalPduOnDestruction().

bool DtEntityPublisher::mySendSeesPdus [protected]

bool DtEntityPublisher::theClassDfltIsSetFlag [static, protected]

DtTime DtEntityPublisher::theClassDfltTimeThreshold [static, protected]

DtStateRepCreator DtEntityPublisher::theStateRepCreator [static, protected]

---

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

• dEntityPub.h