VR-Link API Documentation for DIS
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Friends
DtPropulsionNoiseEncoder Class Reference

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

+ Inheritance diagram for DtPropulsionNoiseEncoder:
+ Collaboration diagram for DtPropulsionNoiseEncoder:

Public Member Functions

 DtPropulsionNoiseEncoder ()
 CTOR.
 DtPropulsionNoiseEncoder (const DtPropulsionNoiseEncoder &orig)
 Copy CTOR.
virtual ~DtPropulsionNoiseEncoder ()
 Virtual CTOR.
DtPropulsionNoiseEncoderoperator= (const DtPropulsionNoiseEncoder &orig)
 Assignment Operator.
virtual DtUnderwaterAcousticPdustateMsg (const DtPropulsionNoiseStateRepository &stateRep, const DtPropulsionNoiseStateRepository &asSeenByRemote)
 Constructs a PDU from the state repository.
- Public Member Functions inherited from DtStateEncoder
 DtStateEncoder ()
 Default constructor.
virtual ~DtStateEncoder ()
 Destructor.
 DtStateEncoder (const DtStateEncoder &orig)
 Copy constructor.
DtStateEncoderoperator= (const DtStateEncoder &orig)
 Assignment operator.
void setSendNeeded ()
 Sets myForceSendNeeded to true.

Protected Member Functions

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

Protected Attributes

DtUnderwaterAcousticPdu myAsPdu
- Protected Attributes inherited from DtStateEncoder
bool myForceSendNeeded

Friends

class DtUnderwaterAcousticsEncoder

Detailed Description

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

Constructor & Destructor Documentation

DtPropulsionNoiseEncoder::DtPropulsionNoiseEncoder ( )

CTOR.

DtPropulsionNoiseEncoder::DtPropulsionNoiseEncoder ( const DtPropulsionNoiseEncoder orig)

Copy CTOR.

virtual DtPropulsionNoiseEncoder::~DtPropulsionNoiseEncoder ( )
virtual

Virtual CTOR.

Member Function Documentation

virtual void DtPropulsionNoiseEncoder::fillOut ( const DtPropulsionNoiseStateRepository stateRep,
const DtPropulsionNoiseStateRepository asSeenByRemote,
DtUnderwaterAcousticPdu pdu 
)
protectedvirtual

Fill out a state message which reflects a state repository.

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

Assignment Operator.

virtual bool DtPropulsionNoiseEncoder::sendNeeded ( const DtPropulsionNoiseStateRepository stateRep,
const DtPropulsionNoiseStateRepository asSeenByRemote 
)
protectedvirtual

Determine if a state message needs to be sent.

virtual DtUnderwaterAcousticPdu* DtPropulsionNoiseEncoder::stateMsg ( const DtPropulsionNoiseStateRepository stateRep,
const DtPropulsionNoiseStateRepository 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 DtPropulsionNoiseEncoder::myAsPdu
protected

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

Document ID: Generated on Wed Aug 14 15:35:11 EDT 2013 from SVN revision 130445
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)