DtUnderwaterAcousticsEncoder Class Reference

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

Inheritance diagram for DtUnderwaterAcousticsEncoder:

Collaboration diagram for DtUnderwaterAcousticsEncoder:

Public Member Functions
	DtUnderwaterAcousticsEncoder ()
	CTOR.
	DtUnderwaterAcousticsEncoder (const DtUnderwaterAcousticsEncoder &orig)
	Copy CTOR.
virtual	~DtUnderwaterAcousticsEncoder ()
	Virtual CTOR.
DtUnderwaterAcousticsEncoder &	operator= (const DtUnderwaterAcousticsEncoder &orig)
	Assignment Operator.
virtual DtUnderwaterAcousticPdu *	stateMsg (const DtUnderwaterAcousticsStateRepository &stateRep, const DtUnderwaterAcousticsStateRepository &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 (DtUnderwaterAcousticsEncoder)
	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 DtUnderwaterAcousticsStateRepository &stateRep, const DtUnderwaterAcousticsStateRepository &asSeenByRemote)
	Determine if a state message needs to be sent.
virtual void	fillOut (const DtUnderwaterAcousticsStateRepository &stateRep, const DtUnderwaterAcousticsStateRepository &asSeenByRemote, DtUnderwaterAcousticPdu *pdu)
	Fill out a state message which reflects a state repository.

Protected Attributes
DtUnderwaterAcousticPdu	myAsPdu
DtPropulsionNoiseEncoder	myPropNoiseEnc
DtAdditionalPassiveActivitiesEncoder	myAddPassActEnc
DtActiveSonarEncoder	myActiveSonarEnc
Protected Attributes inherited from DtStateEncoder
bool	myForceSendNeeded

Detailed Description

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

Constructor & Destructor Documentation

DtUnderwaterAcousticsEncoder::DtUnderwaterAcousticsEncoder

(

)

CTOR.

DtUnderwaterAcousticsEncoder::DtUnderwaterAcousticsEncoder

(

const DtUnderwaterAcousticsEncoder &

orig

)

Copy CTOR.

virtual DtUnderwaterAcousticsEncoder::~DtUnderwaterAcousticsEncoder ( )

virtual

Virtual CTOR.

Member Function Documentation

virtual double DtUnderwaterAcousticsEncoder::azimuthThreshold ( ) const

virtual

Returns the azimuth threshold (in radians).

DtUnderwaterAcousticsEncoder::DtCLONE_ENCODER

(

DtUnderwaterAcousticsEncoder

)

Inline clone method.

virtual double DtUnderwaterAcousticsEncoder::elevationThreshold ( ) const

virtual

Returns the elevation threshold (in radians).

virtual void DtUnderwaterAcousticsEncoder::fillOut ( const DtUnderwaterAcousticsStateRepository &  stateRep, const DtUnderwaterAcousticsStateRepository &  asSeenByRemote, DtUnderwaterAcousticPdu *  pdu  )

protectedvirtual

Fill out a state message which reflects a state repository.

DtUnderwaterAcousticsEncoder& DtUnderwaterAcousticsEncoder::operator=

(

const DtUnderwaterAcousticsEncoder &

orig

)

Assignment Operator.

virtual bool DtUnderwaterAcousticsEncoder::sendNeeded ( const DtUnderwaterAcousticsStateRepository &  stateRep, const DtUnderwaterAcousticsStateRepository &  asSeenByRemote  )

protectedvirtual

Determine if a state message needs to be sent.

virtual void DtUnderwaterAcousticsEncoder::setAzimuthThreshold ( double  threshold )

virtual

Set the azimuth threshold (Default is 1 degree).

threshold Threshold in radians.

virtual void DtUnderwaterAcousticsEncoder::setElevationThreshold ( double  threshold )

virtual

Set the elevation threshold (Default is 1 degree).

threshold Threshold in radians.

virtual DtUnderwaterAcousticPdu* DtUnderwaterAcousticsEncoder::stateMsg ( const DtUnderwaterAcousticsStateRepository &  stateRep, const DtUnderwaterAcousticsStateRepository &  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

Member Data Documentation

DtActiveSonarEncoder DtUnderwaterAcousticsEncoder::myActiveSonarEnc

protected

DtAdditionalPassiveActivitiesEncoder DtUnderwaterAcousticsEncoder::myAddPassActEnc

protected

DtUnderwaterAcousticPdu DtUnderwaterAcousticsEncoder::myAsPdu

protected

DtPropulsionNoiseEncoder DtUnderwaterAcousticsEncoder::myPropNoiseEnc

protected

---

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

• underwaterAcousticsEncoderDIS.h