VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
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. More...
 
 DtUnderwaterAcousticsEncoder (const DtUnderwaterAcousticsEncoder &orig)
 Copy CTOR. More...
 
virtual ~DtUnderwaterAcousticsEncoder ()
 Virtual CTOR. More...
 
DtUnderwaterAcousticsEncoderoperator= (const DtUnderwaterAcousticsEncoder &orig)
 Assignment Operator. More...
 
virtual DtUnderwaterAcousticPdustateMsg (const DtUnderwaterAcousticsStateRepository &stateRep, const DtUnderwaterAcousticsStateRepository &asSeenByRemote)
 Constructs a PDU from the state repository. More...
 
virtual void setAzimuthThreshold (double threshold)
 Set the azimuth threshold (Default is 1 degree). More...
 
virtual double azimuthThreshold () const
 Returns the azimuth threshold (in radians). More...
 
virtual void setElevationThreshold (double threshold)
 Set the elevation threshold (Default is 1 degree). More...
 
virtual double elevationThreshold () const
 Returns the elevation threshold (in radians). More...
 
 DtCLONE_ENCODER (DtUnderwaterAcousticsEncoder)
 Inline clone method. More...
 
- Public Member Functions inherited from DtStateEncoder
 DtStateEncoder ()
 Default constructor. More...
 
virtual ~DtStateEncoder ()
 Destructor. More...
 
 DtStateEncoder (const DtStateEncoder &orig)
 Copy constructor. More...
 
DtStateEncoderoperator= (const DtStateEncoder &orig)
 Assignment operator. More...
 
virtual void setSendNeeded ()
 Sets myForceSendNeeded to true. More...
 
virtual DtU32 changedState () const
 
virtual void clearChangedState ()
 
virtual bool isChangedStateBit (DtU32 st) const
 
virtual void resetChangedStateBit (DtU32 st)
 
virtual void setChangedStateBit (DtU32 st)
 
virtual DtPduEncoderclone () const =0
 clone. More...
 
virtual void encode (DtPdu *pdu)
 This is a dummy method for backwards compatibility with DIS encoders. More...
 
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. More...
 
virtual bool sendNeededAttributeRecords (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote)
 In order to modify records in place, and have them sent, we need to compare the stateRep with the As seen by remote. More...
 
- 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. More...
 
virtual void fillOut (const DtUnderwaterAcousticsStateRepository &stateRep, const DtUnderwaterAcousticsStateRepository &asSeenByRemote, DtUnderwaterAcousticPdu *pdu)
 Fill out a state message which reflects a state repository. More...
 

Protected Attributes

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

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:

Document ID: Generated on Mon Apr 25 03:39:01 EDT 2022 from SVN revision 242502
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)