DtActiveSonarEncoder Class Reference

Instances of DtActiveSonarEncoder are used to take state information from a DtActiveSonarStateRepository and place it into an underwater acoustics PDU. More...

Inheritance diagram for DtActiveSonarEncoder:

Collaboration diagram for DtActiveSonarEncoder:

Public Member Functions
	DtActiveSonarEncoder ()
	CTOR.
	DtActiveSonarEncoder (const DtActiveSonarEncoder &orig)
	Copy CTOR.
virtual	~DtActiveSonarEncoder ()
	Virtual CTOR.
DtActiveSonarEncoder &	operator= (const DtActiveSonarEncoder &orig)
	Assignment Operator.
virtual DtUnderwaterAcousticPdu *	stateMsg (const DtActiveSonarStateRepository &stateRep, const DtActiveSonarStateRepository &asSeenByRemote)
	Constructs a PDU from the state repository.
virtual void	setAzimuthThreshold (double threshold)
	Set the azimuth threshold (Default is 1 degree).
virtual double	azimuthThreshold () const
	Returns the azimuth threshold (in radians).
virtual void	setElevationThreshold (double threshold)
	Set the elevation threshold (Default is 1 degree).
virtual double	elevationThreshold () const
	Returns the elevation threshold (in radians).
	DtCLONE_ENCODER (DtActiveSonarEncoder)
	Inline clone method.
Public Member Functions inherited from DtStateEncoder
	DtStateEncoder ()
	Default constructor.
virtual	~DtStateEncoder ()
	Destructor.
	DtStateEncoder (const DtStateEncoder &orig)
	Copy constructor.
DtStateEncoder &	operator= (const DtStateEncoder &orig)
	Assignment operator.
void	setSendNeeded ()
	Sets myForceSendNeeded to true.
virtual DtPduEncoder *	clone () const =0
	clone.
virtual void	encode (DtPdu *pdu)
	This is a dummy method for backwards compatibility with DIS encoders.
virtual void	fillOutAttributeRecords (const DtStateRepository &stateRep, DtPduWithAttributeRecordSets *pdu, const DtEntityIdentifier &id, bool clearBeforeAdding=true)
	DIS 7 requires filling the Attribute Records for a coupled Attribute PDU.
virtual bool	sendNeededAttributeRecords (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote) const
	In order to modify records in place, and have them sent, we need to compare the stateRep with the As seen by remote.
Public Member Functions inherited from DtPduEncoder
virtual	~DtPduEncoder ()

Protected Member Functions
virtual bool	sendNeeded (const DtActiveSonarStateRepository &stateRep, const DtActiveSonarStateRepository &asSeenByRemote)
	Determine if a state message needs to be sent.
virtual void	fillOut (const DtActiveSonarStateRepository &stateRep, const DtActiveSonarStateRepository &asSeenByRemote, DtUnderwaterAcousticPdu *pdu)
	Fill out a state message which reflects a state repository.

Protected Attributes
DtUnderwaterAcousticPdu	myAsPdu
double	myAzimuthThreshold
double	myElevationThreshold
Protected Attributes inherited from DtStateEncoder
bool	myForceSendNeeded

Friends
class	DtUnderwaterAcousticsEncoder

Detailed Description

Instances of DtActiveSonarEncoder are used to take state information from a DtActiveSonarStateRepository and place it into an underwater acoustics PDU.

Constructor & Destructor Documentation

DtActiveSonarEncoder::DtActiveSonarEncoder

(

)

CTOR.

DtActiveSonarEncoder::DtActiveSonarEncoder

(

const DtActiveSonarEncoder &

orig

)

Copy CTOR.

virtual DtActiveSonarEncoder::~DtActiveSonarEncoder ( )

virtual

Virtual CTOR.

Member Function Documentation

virtual double DtActiveSonarEncoder::azimuthThreshold ( ) const

virtual

Returns the azimuth threshold (in radians).

DtActiveSonarEncoder::DtCLONE_ENCODER

(

DtActiveSonarEncoder

)

Inline clone method.

virtual double DtActiveSonarEncoder::elevationThreshold ( ) const

virtual

Returns the elevation threshold (in radians).

virtual void DtActiveSonarEncoder::fillOut ( const DtActiveSonarStateRepository &  stateRep, const DtActiveSonarStateRepository &  asSeenByRemote, DtUnderwaterAcousticPdu *  pdu  )

protectedvirtual

Fill out a state message which reflects a state repository.

DtActiveSonarEncoder& DtActiveSonarEncoder::operator=

(

const DtActiveSonarEncoder &

orig

)

Assignment Operator.

virtual bool DtActiveSonarEncoder::sendNeeded ( const DtActiveSonarStateRepository &  stateRep, const DtActiveSonarStateRepository &  asSeenByRemote  )

protectedvirtual

Determine if a state message needs to be sent.

virtual void DtActiveSonarEncoder::setAzimuthThreshold ( double  threshold )

virtual

Set the azimuth threshold (Default is 1 degree).

threshold Threshold in radians.

virtual void DtActiveSonarEncoder::setElevationThreshold ( double  threshold )

virtual

Set the elevation threshold (Default is 1 degree).

threshold Threshold in radians.

virtual DtUnderwaterAcousticPdu* DtActiveSonarEncoder::stateMsg ( const DtActiveSonarStateRepository &  stateRep, const DtActiveSonarStateRepository &  asSeenByRemote  )

virtual

Constructs a PDU from the state repository.

Determines whether an Underwater Acoustic PDU needs to be sent and constructs one if it does.

Returns

PDU if send is needed, and NULL if not

Friends And Related Function Documentation

friend class DtUnderwaterAcousticsEncoder

friend

Member Data Documentation

DtUnderwaterAcousticPdu DtActiveSonarEncoder::myAsPdu

protected

double DtActiveSonarEncoder::myAzimuthThreshold

protected

double DtActiveSonarEncoder::myElevationThreshold

protected

---

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

• activeSonarEncoderDIS.h