Instances of DtRadioTransmitterPublisher are used for local or source simulations of radio transmitters, (i.e. More...

Inheritance diagram for DtRadioTransmitterPublisher:

Collaboration diagram for DtRadioTransmitterPublisher:

Public Types
typedef DtRadioTransmitterRepository (	DtStateRepCreator )()
	Function prototype for functions that create DtRadioTransmitterRepositorys.

Public Member Functions
	DtRadioTransmitterPublisher (DtRadioTransmitterRepository stateRepToUse, DtExerciseConn conn, const DtObjectId &entityId=DtObjectId::defaultId())
	Constructor – State Rep must contain a radioId.
	DtRadioTransmitterPublisher (DtExerciseConn *conn, const DtObjectId &entityId=DtObjectId::defaultId(), int radioId=1)
	Constructor.
virtual	~DtRadioTransmitterPublisher ()
	Destructor.
virtual void	tick ()
	This function should be called once per frame for each environment process object.
virtual DtRadioTransmitterRepository *	radioXmitRep ()
	Returns a pointer to the EnvironmentProcessRepository - through which you can set or inspect current state information.
virtual DtRadioTransmitterRepository *	tsr ()
	Synonym for environmentProcessStateRep()
virtual DtRadioTransmitterDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode PDUs that we send back into the asSeenByRemote ESR.
virtual DtRadioTransmitterEncoder *	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 environment process's identifier.
virtual const DtObjectId &	localId () const
	Get the environment process'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 DtRadioTransmitterPublisher 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	setHeartbeatMoveTimer (DtTime time)
	Sets the time threshold used for moving radio transmitters.
virtual DtTime	heartbeatMoveTimer () const
	Returns the time threshold used for moving radio transmitters.
virtual DtTime	transmitterTimeThreshold () const
	Returns the time threshold being used.
virtual void	setAntennaLocationThreshold (double threshold)
	Sets the antenna location threshold.
virtual double	antennaLocationThreshold () const
	Returns the antenna location threshold.
virtual void	setAntennaOrientationThreshold (double threshold)
	Sets the antenna orientation threshold.
virtual double	antennaOrientationThreshold () const
	Returns the antenna orientation threshold.
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	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs.
static DtStateRepCreator	stateRepCreator (void)
static void	setUseMovingThresholdFlag (bool flag)
	Sets the flag to determine whether to use a separate threshold value if the entity that the transmitter is attached to is moving.
static bool	useMovingThresholdFlag ()
	Returns the flag described above.
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	sendFinalPdu ()
	not virtual since called from destructor.
void	init (const DtEntityIdentifier &vehId)
	not virtual since called from constructor
	DtRadioTransmitterPublisher (const DtRadioTransmitterPublisher &orig)
	copy constructor – not implemented
DtRadioTransmitterPublisher &	operator= (const DtRadioTransmitterPublisher &orig)
	copy constructor – not implemented
Protected Member Functions inherited from DtObjectPublisher
virtual void	send (DtPdu *pdu) const
	Puts the PDU on the network and updates timestamps.

Protected Attributes
DtObjectId	myId
DtRadioTransmitterDecoder *	myDecoder
DtRadioTransmitterEncoder *	myEncoder
bool	mySendFinalInDtor
DtTime	myHeartbeatMoveTimer
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 bool	theUseMovingThresholdFlag
static DtTime	theClassDfltTimeThreshold
static bool	theClassDfltIsSetFlag
Static Protected Attributes inherited from DtObjectPublisher
static DtTime	theDfltTimeThreshold

Detailed Description

Instances of DtRadioTransmitterPublisher are used for local or source simulations of radio transmitters, (i.e.

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

Member Typedef Documentation

typedef DtRadioTransmitterRepository*(* DtRadioTransmitterPublisher::DtStateRepCreator)()

Function prototype for functions that create DtRadioTransmitterRepositorys.

Constructor & Destructor Documentation

DtRadioTransmitterPublisher::DtRadioTransmitterPublisher	(	DtRadioTransmitterRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	entityId = `DtObjectId::defaultId()`
	)

Constructor – State Rep must contain a radioId.

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

Constructor.

virtual DtRadioTransmitterPublisher::~DtRadioTransmitterPublisher ( )

virtual

Destructor.

DtRadioTransmitterPublisher::DtRadioTransmitterPublisher ( const DtRadioTransmitterPublisher & orig )

protected

copy constructor – not implemented

Member Function Documentation

virtual double DtRadioTransmitterPublisher::antennaLocationThreshold ( ) const

virtual

Returns the antenna location threshold.

Returns: The location threshold in meters.

Deprecated:: Users should now call: tsr()->thresholder()->antennaLocationThreshold()

Exceptions

DtException if state rep is null.

virtual double DtRadioTransmitterPublisher::antennaOrientationThreshold ( ) const

virtual

Returns the antenna orientation threshold.

Returns: The orientation threshold in radians.

Deprecated:: Users should now call: tsr()->thresholder()->antennaOrientationThreshold()

Exceptions

DtException if state rep is null.

virtual DtRadioTransmitterDecoder* DtRadioTransmitterPublisher::decoder ( )

virtual

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

virtual DtRadioTransmitterEncoder* DtRadioTransmitterPublisher::encoder ( )

virtual

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

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

virtual

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

Implements DtObjectPublisher.

virtual DtTime DtRadioTransmitterPublisher::heartbeatMoveTimer ( ) const

virtual

Returns the time threshold used for moving radio transmitters.

virtual const DtObjectId& DtRadioTransmitterPublisher::id ( ) const

virtual

Get the environment process's identifier.

Implements DtObjectPublisher.

void DtRadioTransmitterPublisher::init ( const DtEntityIdentifier & vehId )

protected

not virtual since called from constructor

virtual const DtObjectId& DtRadioTransmitterPublisher::localId ( ) const

virtual

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

Implements DtObjectPublisher.

DtRadioTransmitterPublisher& DtRadioTransmitterPublisher::operator= ( const DtRadioTransmitterPublisher & orig )

protected

copy constructor – not implemented

virtual int DtRadioTransmitterPublisher::radioId ( ) const

virtual

Get the radio ID.

virtual DtRadioTransmitterRepository* DtRadioTransmitterPublisher::radioXmitRep ( )

virtual

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

void DtRadioTransmitterPublisher::sendFinalPdu ( )

protected

not virtual since called from destructor.

virtual void DtRadioTransmitterPublisher::sendFinalPduOnDestruction ( bool onOff )

virtual

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

virtual void DtRadioTransmitterPublisher::setAntennaLocationThreshold ( double threshold )

virtual

Sets the antenna location threshold.

Sets the distance that the antenna must have moved for another PDU to be sent.

Parameters

threshold Threshold in meters defaulted to 500 m.

Deprecated:: Users should now call: tsr()->thresholder()->setAntennaLocationThreshold()

virtual void DtRadioTransmitterPublisher::setAntennaOrientationThreshold ( double threshold )

virtual

Sets the antenna orientation threshold.

Parameters

threshold Threshold in radians defaulted to 180 degrees.

Deprecated:: Users should now call: tsr()->thresholder()->setAntennaOrientationThreshold()

static void DtRadioTransmitterPublisher::setClassDfltTimeThreshold ( DtTime threshold )

static

virtual void DtRadioTransmitterPublisher::setHeartbeatMoveTimer ( DtTime time )

virtual

Sets the time threshold used for moving radio transmitters.

static void DtRadioTransmitterPublisher::setStateRepCreator ( DtStateRepCreator creator )

static

Give us a function to be used for creating SRs.

static void DtRadioTransmitterPublisher::setUseMovingThresholdFlag ( bool flag )

static

Sets the flag to determine whether to use a separate threshold value if the entity that the transmitter is attached to is moving.

static DtStateRepCreator DtRadioTransmitterPublisher::stateRepCreator ( void )

static

virtual void DtRadioTransmitterPublisher::tick ( )

virtual

This function should be called once per frame for each environment process object.

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

Implements DtObjectPublisher.

virtual DtTime DtRadioTransmitterPublisher::transmitterTimeThreshold ( ) const

virtual

Returns the time threshold being used.

DtRadioTransmitterRepository * DtRadioTransmitterPublisher::tsr ( )

inlinevirtual

Synonym for environmentProcessStateRep()

References DtObjectPublisher::myStateRep.

static bool DtRadioTransmitterPublisher::useMovingThresholdFlag ( )

static

Returns the flag described above.

See Also: setUseMovingThresholdFlag

Member Data Documentation

DtRadioTransmitterDecoder* DtRadioTransmitterPublisher::myDecoder

protected

DtRadioTransmitterEncoder* DtRadioTransmitterPublisher::myEncoder

protected

DtTime DtRadioTransmitterPublisher::myHeartbeatMoveTimer

protected

DtObjectId DtRadioTransmitterPublisher::myId

protected

bool DtRadioTransmitterPublisher::mySendFinalInDtor

protected

bool DtRadioTransmitterPublisher::theClassDfltIsSetFlag

staticprotected

DtTime DtRadioTransmitterPublisher::theClassDfltTimeThreshold

staticprotected

DtStateRepCreator DtRadioTransmitterPublisher::theStateRepCreator

staticprotected

bool DtRadioTransmitterPublisher::theUseMovingThresholdFlag

staticprotected

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

radioTransmitterPublisherDIS.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation