Instances of DtUnderwaterAcousticsPublisher are used to take care of the details associated with publishing the underwater acoustics state of an entity. More...

Inheritance diagram for DtUnderwaterAcousticsPublisher:

Collaboration diagram for DtUnderwaterAcousticsPublisher:

Public Types
typedef DtUnderwaterAcousticsStateRepository (	DtStateRepCreator )()
	Function prototype for functions that create DtUnderwaterAcousticsStateRepositories.

Public Member Functions
	DtUnderwaterAcousticsPublisher (DtUnderwaterAcousticsStateRepository stateRepToUse, DtExerciseConn conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
	DtUnderwaterAcousticsPublisher (DtExerciseConn *conn, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
	DtUnderwaterAcousticsPublisher (DtExerciseConn conn, const char name, const DtObjectId &id=DtObjectId::defaultId())
	CTOR.
virtual	~DtUnderwaterAcousticsPublisher ()
	Virtual DTOR.
virtual DtUnderwaterAcousticsStateRepository *	underwaterAcousticsStateRep ()
	Get the active sonar state repository for this underwater acoustics publisher.
virtual DtUnderwaterAcousticsStateRepository *	usr ()
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 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 ()
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	init (const char *name, const DtEntityIdentifier &id)
	Not virtual since called from constructor.
	DtUnderwaterAcousticsPublisher (const DtUnderwaterAcousticsPublisher &orig)
	copy constructor – Not Implemented
DtUnderwaterAcousticsPublisher &	operator= (const DtUnderwaterAcousticsPublisher &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
DtUnderwaterAcousticsDecoder *	myUnderwaterAcousticsDecoder
DtUnderwaterAcousticsEncoder *	myUnderwaterAcousticsEncoder
char *	myName
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 DtTime	theClassDfltTimeThreshold
static bool	theClassDfltIsSetFlag
Static Protected Attributes inherited from DtObjectPublisher
static DtTime	theDfltTimeThreshold

Detailed Description

Instances of DtUnderwaterAcousticsPublisher are used to take care of the details associated with publishing the underwater acoustics state of an entity.

Member Typedef Documentation

typedef DtUnderwaterAcousticsStateRepository*(* DtUnderwaterAcousticsPublisher::DtStateRepCreator)()

Function prototype for functions that create DtUnderwaterAcousticsStateRepositories.

Constructor & Destructor Documentation

DtUnderwaterAcousticsPublisher::DtUnderwaterAcousticsPublisher	(	DtUnderwaterAcousticsStateRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const DtObjectId &	id = `DtObjectId::defaultId()`
	)

CTOR.

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

CTOR.

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

CTOR.

virtual DtUnderwaterAcousticsPublisher::~DtUnderwaterAcousticsPublisher ( )

virtual

Virtual DTOR.

DtUnderwaterAcousticsPublisher::DtUnderwaterAcousticsPublisher ( const DtUnderwaterAcousticsPublisher & orig )

protected

copy constructor – Not Implemented

Member Function Documentation

virtual double DtUnderwaterAcousticsPublisher::beamAzimuthThreshold ( ) const

virtual

Returns the azimuth threshold (in radians).

virtual double DtUnderwaterAcousticsPublisher::beamElevationThreshold ( ) const

virtual

Returns the elevation threshold (in radians).

virtual void DtUnderwaterAcousticsPublisher::forceUpdate ( )

virtual

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

Implements DtObjectPublisher.

virtual const DtGlobalObjectDesignator& DtUnderwaterAcousticsPublisher::globalId ( ) const

virtual

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

Implements DtObjectPublisher.

virtual const DtObjectId& DtUnderwaterAcousticsPublisher::id ( ) const

virtual

Get the entity's identifier.

Implements DtObjectPublisher.

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

protected

Not virtual since called from constructor.

virtual const DtObjectId& DtUnderwaterAcousticsPublisher::localId ( ) const

virtual

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

Implements DtObjectPublisher.

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

protected

assignment operator – Not Implemented

virtual void DtUnderwaterAcousticsPublisher::setBeamAzimuthThreshold ( double threshold )

virtual

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

Parameters

threshold Threshold in radians.

virtual void DtUnderwaterAcousticsPublisher::setBeamElevationThreshold ( double threshold )

virtual

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

Parameters

threshold Threshold in radians.

static void DtUnderwaterAcousticsPublisher::setClassDfltTimeThreshold ( DtTime threshold )

static

static void DtUnderwaterAcousticsPublisher::setStateRepCreator ( DtStateRepCreator creator )

static

Give us a function to be used for creating SRs.

static DtStateRepCreator DtUnderwaterAcousticsPublisher::stateRepCreator ( )

static

virtual void DtUnderwaterAcousticsPublisher::tick ( )

virtual

Tick the publisher.

Implements DtObjectPublisher.

virtual DtUnderwaterAcousticsStateRepository* DtUnderwaterAcousticsPublisher::underwaterAcousticsStateRep ( )

virtual

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

DtUnderwaterAcousticsStateRepository * DtUnderwaterAcousticsPublisher::usr ( )

inlinevirtual

References DtObjectPublisher::myStateRep.

Member Data Documentation

DtObjectId DtUnderwaterAcousticsPublisher::myId

protected

char* DtUnderwaterAcousticsPublisher::myName

protected

DtUnderwaterAcousticsDecoder* DtUnderwaterAcousticsPublisher::myUnderwaterAcousticsDecoder

protected

DtUnderwaterAcousticsEncoder* DtUnderwaterAcousticsPublisher::myUnderwaterAcousticsEncoder

protected

bool DtUnderwaterAcousticsPublisher::theClassDfltIsSetFlag

staticprotected

DtTime DtUnderwaterAcousticsPublisher::theClassDfltTimeThreshold

staticprotected

DtStateRepCreator DtUnderwaterAcousticsPublisher::theStateRepCreator

staticprotected

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

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