DtEmitterSystemPublisher Class Reference

Instances of DtEmitterSystemPublisher are used to take care of the details associated with publishing the state of an emitter system. More...

Inheritance diagram for DtEmitterSystemPublisher:

Collaboration diagram for DtEmitterSystemPublisher:

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

Public Member Functions
	DtEmitterSystemPublisher (DtEmitterSystemRepository *stateRepToUse, DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	Constructor defaultId returns an id of (-1,-1,-1). More...
	DtEmitterSystemPublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	Constructor defaultId returns an id of (-1,-1,-1). More...
	DtEmitterSystemPublisher (DtExerciseConn *conn, const char *name, const DtObjectId &id=DtObjectId::defaultId())
	Constructor defaultId() returns an id of (-1,-1,-1). More...
virtual	~DtEmitterSystemPublisher ()
	destructor More...
virtual void	forceUpdate ()
	force a pdu to be sent on the next tick call, even if it is not needed. More...
virtual bool	tick ()
	Tick the publisher, returns true if data is sent. More...
virtual DtEmitterSystemRepository *	emitterSystemStateRep ()
	Get the emitter system state repository for this emitter system publisher. More...
virtual DtEmitterSystemRepository *	esr ()
virtual const DtObjectId &	id () const
	Get the entity's identifier. More...
virtual const DtObjectId &	localId () const
	The localId is the same as the globalId, a DtEntityIdentifier unique to this object. More...
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the global object designator - same as id for DIS. More...
virtual void	setBeamAzimuthThreshold (double threshold)
	Set the EE_AZ_THRSH_DFLT. More...
virtual double	beamAzimuthThreshold () const
	Returns the azimuth threshold (in radians). More...
virtual void	setBeamElevationThreshold (double threshold)
	Set the EE_EL_THRSH_DFLT. More...
virtual double	beamElevationThreshold () const
	Returns the elevation threshold (in radians). More...
void	sendFinalPdu ()
	Not virtual since called from destructor. More...
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. More...
virtual	~DtObjectPublisher ()
	Destructor. More...
virtual DtStateRepository *	stateRep ()
	Returns a pointer to the DtStateRepository - through which you can set or inspect current state information. More...
virtual DtStateRepository *	sr ()
	Returns a pointer to the DtStateRepository - through which you can set or inspect current state information. More...
virtual DtExerciseConn *	exerciseConn ()
	Get our exercise connection. More...
virtual bool	parallelTick ()
	Tick (update) this object in parallel threads. More...
virtual void	setTimeThreshold (DtTime time)
	Set the heartbeat rate for this object. More...
virtual DtTime	timeThreshold () const
	The heartbeat rate for this object. More...
virtual void	setRelLocTimeThreshold (DtTime time)
	Set the heartbeat rate of relative location updates for this object. More...
virtual DtTime	relLocTimeThreshold () const
	The relative location heartbeat rate for this object. More...
virtual DtStateRepository *	approximateRemoteStateRep ()
	Returns a pointer to the approximate remote DtStateRepository – This state repository contains the contents of the last sent message. More...
virtual DtTime	lastTimeUpdated () const
	Returns the value of wallclock time at the time an update was last received for the entity. More...
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. More...
virtual void	setUseCustomThreshold (bool useCustom)
	Sets whether or not this object will use a custom threshold value, or the default. More...
virtual bool	useCustomThreshold ()
	Returns whether or not this object will use a custom threshold value, or the default. More...
virtual void	setAttributePduStrategy (DtAttributePduStrategy strat)
	Sets/Gets whether to couple the attribute PDU. More...
virtual DtAttributePduStrategy	attributePduStrategy () const
virtual void	encodeExtensions (DtStateRepository *stateRep, const DtStateRepository &asSeenByRemote)
	Encode State Repository Extensions. Extensions should be added to stateRep attributeRecords. More...
virtual void	decodeExtensions (DtPdu *pdu, const DtStateRepository &stateRep)
	Decode State Repository Extensions. More...
virtual void	setUpdateRateWarningThreshold (unsigned short updatesPerSecond)
	Overrides the default (static) updates per second for a specific instance Sets/Gets for private member. More...
virtual unsigned short	updateRateWarningThreshold () const
virtual void	checkForUpdateRateWarning () const
	Helper function that determines whether or not to trigger a spam warning. More...
DtNonCoupledAttributePduCreator	setNonCoupledAttributePduCreator (DtNonCoupledAttributePduCreator creator)
	Give us a function to be used for creating non-coupled Attribute PDUs. More...
DtNonCoupledAttributePduCreator	nonCoupledAttributePduCreator (void)

Static Public Member Functions
static void	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs. More...
static DtStateRepCreator	stateRepCreator (void)
static void	setClassDfltTimeThreshold (DtTime threshold)
Static Public Member Functions inherited from DtObjectPublisher
static void	setDfltTimeThreshold (DtTime time)
	Set the default heartbeat rate. More...
static DtTime	dfltTimeThreshold ()
	The default heartbeat rate, see setDfltTimeThreshold(). More...
static void	setDfltUpdateRateWarningThreshold (unsigned short updatesPerSecond)
	Sets the default (static) updates per second for any instance. More...
static unsigned short	dfltUpdateRateWarningThreshold ()
	Return the value of theDfltUpdateRateWarningThreshold. More...
static void	setDfltRelLocTimeThreshold (DtTime time)
	Set the default heartbeat rate for relative location updates. More...
static DtTime	dfltRelLocTimeThreshold ()
	The default heartbeat rate for relative location updates, see setDfltRelLocTimeThreshold() More...
static DtNonCoupledAttributePduCreator	setDefaultNonCoupledAttributePduCreator (DtNonCoupledAttributePduCreator creator)
	Give us a function to be used for creating non-coupled Attribute PDUs. More...
static DtNonCoupledAttributePduCreator	defaultNonCoupledAttributePduCreator (void)

Protected Member Functions
void	init (const char *name, const DtEntityIdentifier &id)
	Not virtual since called from constructor. More...
	DtEmitterSystemPublisher (const DtEmitterSystemPublisher &orig)
	copy constructor – Not Implemented More...
DtEmitterSystemPublisher &	operator= (const DtEmitterSystemPublisher &orig)
	assignment operator – Not Implemented More...
Protected Member Functions inherited from DtObjectPublisher
virtual void	send (DtPdu *pdu) const
	Puts the PDU on the network and updates timestamps. More...

Protected Attributes
DtObjectId	myId
DtEmitterSystemStateDecoder *	myEmitterSystemDecoder
DtEmitterSystemStateEncoder *	myEmitterSystemEncoder
bool	mySendFinalInDtor
char *	myName
Protected Attributes inherited from DtObjectPublisher
DtExerciseConn *	myExConn
DtStateRepository *	myStateRep
DtStateRepository *	myAsSeenByRemote
bool	myOkToDeleteStateRepFlag
bool	myUseCustomThreshold
DtTime	myTimeThreshold
	Time threshold for the heartbeat rate. More...
DtTime	myRelLocTimeThreshold
	Time threshold for heartbeat rate of relative location updates (only for embarked/attached entities) More...
DtTime	mySimTimeLastUpdate
	Set in const send() method. More...
DtTime	myRealTimeLastUpdate
	Set in const send() method. More...
DtTime	myRealTimeLastAttrUpdate
DtTime	myLastSpamCheckTime
	Set in constructor. More...
unsigned short	myNumberOfPdusPerSecond
	Set in constructor. More...
unsigned short	myUpdateRateWarningThreshold
	Set in constructor. More...
bool	myCanWarn
	Set in constructor. More...
DtNonCoupledAttributePduCreator	myNonCoupledAttributePduCreator
DtAttributePduStrategy	myAttributePduStrategy
std::vector < DtStateRepositoryExtensionEncoder * >	myStateRepositoryExtensionEncoderList
std::vector < DtStateRepositoryExtensionDecoder * >	myStateRepositoryExtensionDecoderList

Static Protected Attributes
static DtStateRepCreator	theStateRepCreator
static DtTime	theClassDfltTimeThreshold
static bool	theClassDfltIsSetFlag
Static Protected Attributes inherited from DtObjectPublisher
static DtNonCoupledAttributePduCreator	theDefaultNonCoupledAttributePduCreator
static DtTime	theDfltTimeThreshold
static DtTime	theDfltRelLocTimeThreshold
static unsigned short	theDfltUpdateRateWarningThreshold

Detailed Description

Instances of DtEmitterSystemPublisher are used to take care of the details associated with publishing the state of an emitter system.

Member Typedef Documentation

typedef DtEmitterSystemRepository*(* DtEmitterSystemPublisher::DtStateRepCreator)()

Function prototype for functions that create DtEmitterSystemRepositories.

Constructor & Destructor Documentation

DtEmitterSystemPublisher::DtEmitterSystemPublisher	(	DtEmitterSystemRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	id = DtObjectId::defaultId()
	)

Constructor defaultId returns an id of (-1,-1,-1).

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

Constructor defaultId returns an id of (-1,-1,-1).

DtEmitterSystemPublisher::DtEmitterSystemPublisher	(	DtExerciseConn *	conn,
		const char *	name,
		const DtObjectId &	id = DtObjectId::defaultId()
	)

Constructor defaultId() returns an id of (-1,-1,-1).

virtual DtEmitterSystemPublisher::~DtEmitterSystemPublisher ( )

virtual

destructor

DtEmitterSystemPublisher::DtEmitterSystemPublisher ( const DtEmitterSystemPublisher &  orig )

protected

copy constructor – Not Implemented

Member Function Documentation

virtual double DtEmitterSystemPublisher::beamAzimuthThreshold ( ) const

virtual

Returns the azimuth threshold (in radians).

virtual double DtEmitterSystemPublisher::beamElevationThreshold ( ) const

virtual

Returns the elevation threshold (in radians).

virtual DtEmitterSystemRepository* DtEmitterSystemPublisher::emitterSystemStateRep ( )

virtual

Get the emitter system state repository for this emitter system publisher.

DtEmitterSystemRepository * DtEmitterSystemPublisher::esr ( )

inlinevirtual

References DtObjectPublisher::myStateRep.

virtual void DtEmitterSystemPublisher::forceUpdate ( )

virtual

force a pdu to be sent on the next tick call, even if it is not needed.

Implements DtObjectPublisher.

virtual const DtGlobalObjectDesignator& DtEmitterSystemPublisher::globalId ( ) const

virtual

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

Implements DtObjectPublisher.

virtual const DtObjectId& DtEmitterSystemPublisher::id ( ) const

virtual

Get the entity's identifier.

Implements DtObjectPublisher.

void DtEmitterSystemPublisher::init ( const char *  name, const DtEntityIdentifier &  id  )

protected

Not virtual since called from constructor.

virtual const DtObjectId& DtEmitterSystemPublisher::localId ( ) const

virtual

The localId is the same as the globalId, a DtEntityIdentifier unique to this object.

Implements DtObjectPublisher.

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

protected

assignment operator – Not Implemented

void DtEmitterSystemPublisher::sendFinalPdu

(

)

Not virtual since called from destructor.

virtual void DtEmitterSystemPublisher::setBeamAzimuthThreshold ( double  threshold )

virtual

Set the EE_AZ_THRSH_DFLT.

Default value is 1 degree.

Parameters

threshold

Threshold in radians.

virtual void DtEmitterSystemPublisher::setBeamElevationThreshold ( double  threshold )

virtual

Set the EE_EL_THRSH_DFLT.

Default value is 1 degree.

Parameters

threshold

Threshold in radians.

static void DtEmitterSystemPublisher::setClassDfltTimeThreshold ( DtTime  threshold )

static

static void DtEmitterSystemPublisher::setStateRepCreator ( DtStateRepCreator  creator )

static

Give us a function to be used for creating SRs.

static DtStateRepCreator DtEmitterSystemPublisher::stateRepCreator ( void  )

static

virtual bool DtEmitterSystemPublisher::tick ( )

virtual

Tick the publisher, returns true if data is sent.

Implements DtObjectPublisher.

Member Data Documentation

DtEmitterSystemStateDecoder* DtEmitterSystemPublisher::myEmitterSystemDecoder

protected

DtEmitterSystemStateEncoder* DtEmitterSystemPublisher::myEmitterSystemEncoder

protected

DtObjectId DtEmitterSystemPublisher::myId

protected

char* DtEmitterSystemPublisher::myName

protected

bool DtEmitterSystemPublisher::mySendFinalInDtor

protected

bool DtEmitterSystemPublisher::theClassDfltIsSetFlag

staticprotected

DtTime DtEmitterSystemPublisher::theClassDfltTimeThreshold

staticprotected

DtStateRepCreator DtEmitterSystemPublisher::theStateRepCreator

staticprotected

---

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

• emitterSystemPublisherDIS.h