Instances of DtActiveSonarPublisher are used to take care of the details associated with publishing the state of an active sonar. More...

Inheritance diagram for DtActiveSonarPublisher:

Collaboration diagram for DtActiveSonarPublisher:

Public Types
typedef DtActiveSonarStateRepository (	DtStateRepCreator )()
	Function prototype for functions that create DtActiveSonarStateRepositories.
Public Types inherited from DtObjectPublisher
typedef DtAttributePdu (	DtNonCoupledAttributePduCreator )(const DtPduWithAttributeRecordSets , void )
	Function prototype for functions that create DtAggregateStateRepositories.

Public Member Functions
	DtActiveSonarPublisher (DtActiveSonarStateRepository stateRepToUse, DtExerciseConn conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
	DtActiveSonarPublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
	DtActiveSonarPublisher (DtExerciseConn conn, const char name, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
virtual	~DtActiveSonarPublisher ()
	Virtual DTOR.
virtual DtActiveSonarStateRepository *	activeSonarStateRep ()
	Get the active sonar state repository for this active sonar publisher.
virtual DtActiveSonarStateRepository *	asr ()
virtual void	tick ()
	Tick the publisher.
virtual void	forceUpdate ()
	force a pdu to be sent on the next tick call, even if it is not needed.
virtual const DtObjectId &	id () const
	Get the entity's identifier.
virtual const DtObjectId &	localId () const
	The localId is the same as the globalId, a DtEntityIdentifier unique to this object.
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the global object designator - same as id for DIS.
virtual void	setBeamAzimuthThreshold (double threshold)
	Set the threshold used for determining if azimuth changes should be sent.
virtual double	beamAzimuthThreshold () const
	Returns the azimuth threshold (in radians).
virtual void	setBeamElevationThreshold (double threshold)
	Set the threshold used for determining if elevation changes should be sent.
virtual double	beamElevationThreshold () const
	Returns the elevation threshold (in radians).
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 void	setRelLocTimeThreshold (DtTime time)
	Set the heartbeat rate of relative location updates for this object.
virtual DtTime	relLocTimeThreshold () const
	The relative location 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	lastTimeAttrUpdated () const
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.
virtual void	setAttributePduStrategy (DtAttributePduStrategy strat)
	Sets/Gets whether to couple the attribute PDU.
virtual DtAttributePduStrategy	attributePduStrategy () const
virtual void	encodeExtensions (DtStateRepository *stateRep, const DtStateRepository &asSeenByRemote)
	Encode State Repository Extensions. Extensions should be added to stateRep attributeRecords.
virtual void	decodeExtensions (DtPdu *pdu, const DtStateRepository &stateRep)
	Decode State Repository Extensions.
DtNonCoupledAttributePduCreator	setNonCoupledAttributePduCreator (DtNonCoupledAttributePduCreator creator)
	Give us a function to be used for creating non-coupled Attribute PDUs.
DtNonCoupledAttributePduCreator	nonCoupledAttributePduCreator (void)

Static Public Member Functions
static void	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs.
static DtStateRepCreator	stateRepCreator ()
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().
static void	setDfltRelLocTimeThreshold (DtTime time)
	Set the default heartbeat rate for relative location updates.
static DtTime	dfltRelLocTimeThreshold ()
	The default heartbeat rate for relative location updates, see setDfltRelLocTimeThreshold()
static DtNonCoupledAttributePduCreator	setDefaultNonCoupledAttributePduCreator (DtNonCoupledAttributePduCreator creator)
	Give us a function to be used for creating non-coupled Attribute PDUs.
static DtNonCoupledAttributePduCreator	defaultNonCoupledAttributePduCreator (void)

Protected Member Functions
void	init (const char *name, const DtEntityIdentifier &id)
	Not virtual since called from constructor.
	DtActiveSonarPublisher (const DtActiveSonarPublisher &orig)
	copy constructor – Not Implemented
DtActiveSonarPublisher &	operator= (const DtActiveSonarPublisher &orig)
	assignment operator – 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
DtActiveSonarDecoder *	myActiveSonarDecoder
DtActiveSonarEncoder *	myActiveSonarEncoder
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.
DtTime	myRelLocTimeThreshold
	Time threshold for heartbeat rate of relative location updates (only for embarked/attached entities)
DtTime	mySimTimeLastUpdate
	Set in const send() method.
DtTime	myRealTimeLastUpdate
	Set in const send() method.
DtTime	myRealTimeLastAttrUpdate
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

Detailed Description

Instances of DtActiveSonarPublisher are used to take care of the details associated with publishing the state of an active sonar.

Member Typedef Documentation

typedef DtActiveSonarStateRepository*(* DtActiveSonarPublisher::DtStateRepCreator)()

Function prototype for functions that create DtActiveSonarStateRepositories.

Constructor & Destructor Documentation

DtActiveSonarPublisher::DtActiveSonarPublisher	(	DtActiveSonarStateRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	id = `DtObjectId::defaultId()`
	)

CTOR.

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

CTOR.

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

CTOR.

virtual DtActiveSonarPublisher::~DtActiveSonarPublisher ( )

virtual

Virtual DTOR.

DtActiveSonarPublisher::DtActiveSonarPublisher ( const DtActiveSonarPublisher & orig )

protected

copy constructor – Not Implemented

Member Function Documentation

virtual DtActiveSonarStateRepository* DtActiveSonarPublisher::activeSonarStateRep ( )

virtual

Get the active sonar state repository for this active sonar publisher.

DtActiveSonarStateRepository * DtActiveSonarPublisher::asr ( )

inlinevirtual

References DtObjectPublisher::myStateRep.

virtual double DtActiveSonarPublisher::beamAzimuthThreshold ( ) const

virtual

Returns the azimuth threshold (in radians).

virtual double DtActiveSonarPublisher::beamElevationThreshold ( ) const

virtual

Returns the elevation threshold (in radians).

virtual void DtActiveSonarPublisher::forceUpdate ( )

virtual

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

Implements DtObjectPublisher.

virtual const DtGlobalObjectDesignator& DtActiveSonarPublisher::globalId ( ) const

virtual

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

Implements DtObjectPublisher.

virtual const DtObjectId& DtActiveSonarPublisher::id ( ) const

virtual

Get the entity's identifier.

Implements DtObjectPublisher.

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

protected

Not virtual since called from constructor.

virtual const DtObjectId& DtActiveSonarPublisher::localId ( ) const

virtual

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

Implements DtObjectPublisher.

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

protected

assignment operator – Not Implemented

virtual void DtActiveSonarPublisher::setBeamAzimuthThreshold ( double threshold )

virtual

Set the threshold used for determining if azimuth changes should be sent.

Parameters

threshold Threshold in radians.

virtual void DtActiveSonarPublisher::setBeamElevationThreshold ( double threshold )

virtual

Set the threshold used for determining if elevation changes should be sent.

Parameters

threshold Threshold in radians.

static void DtActiveSonarPublisher::setClassDfltTimeThreshold ( DtTime threshold )

static

static void DtActiveSonarPublisher::setStateRepCreator ( DtStateRepCreator creator )

static

Give us a function to be used for creating SRs.

static DtStateRepCreator DtActiveSonarPublisher::stateRepCreator ( )

static

virtual void DtActiveSonarPublisher::tick ( )

virtual

Tick the publisher.

Implements DtObjectPublisher.

Member Data Documentation

DtActiveSonarDecoder* DtActiveSonarPublisher::myActiveSonarDecoder

protected

DtActiveSonarEncoder* DtActiveSonarPublisher::myActiveSonarEncoder

protected

DtObjectId DtActiveSonarPublisher::myId

protected

char* DtActiveSonarPublisher::myName

protected

bool DtActiveSonarPublisher::theClassDfltIsSetFlag

staticprotected

DtTime DtActiveSonarPublisher::theClassDfltTimeThreshold

staticprotected

DtStateRepCreator DtActiveSonarPublisher::theStateRepCreator

staticprotected

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

activeSonarPublisherDIS.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