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

This class handles encoding of Transmitter PDUs. More...

+ Inheritance diagram for DtRadioTransmitterEncoder:
+ Collaboration diagram for DtRadioTransmitterEncoder:

Public Member Functions

 DtRadioTransmitterEncoder ()
 Constructor.
virtual ~DtRadioTransmitterEncoder ()
 Destructor.
 DtRadioTransmitterEncoder (const DtRadioTransmitterEncoder &orig)
 Copy constructor.
DtRadioTransmitterEncoderoperator= (const DtRadioTransmitterEncoder &orig)
 Assignment operator.
virtual DtTransmitterPdustateMsg (const DtRadioTransmitterRepository &stateRep, const DtRadioTransmitterRepository &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 DtRadioTransmitterRepository &stateRep, const DtRadioTransmitterRepository &asSeenByRemote)
 Determines whether a PDU needs to be sent.
virtual bool antennaLocationThresholdExceeded (const DtVector &stateRepLocation, const DtVector &asSeenByRemoteLocation, double threshold) const
 Determines whether the antenna location threshold has been exceeded.
virtual bool antennaOrientationThresholdExceeded (const DtTaitBryan &stateRepOrientation, const DtTaitBryan &asSeenByRemoteOrientation, double threshold) const
 Determines whether the antenna orientation threshold has been exceeded.

Protected Attributes

DtTransmitterPdu myPdu
 The PDU constructed by the encoder.
- Protected Attributes inherited from DtStateEncoder
bool myForceSendNeeded

Detailed Description

This class handles encoding of Transmitter PDUs.

It is responsible for constructing a DtTransmitterPdu based on the data in the DtRadioTransmitterRepository, and also checking whether the data has exceeded its thresholds so that a PDU must be sent.

Constructor & Destructor Documentation

DtRadioTransmitterEncoder::DtRadioTransmitterEncoder ( )

Constructor.

virtual DtRadioTransmitterEncoder::~DtRadioTransmitterEncoder ( )
virtual

Destructor.

DtRadioTransmitterEncoder::DtRadioTransmitterEncoder ( const DtRadioTransmitterEncoder orig)

Copy constructor.

Member Function Documentation

virtual bool DtRadioTransmitterEncoder::antennaLocationThresholdExceeded ( const DtVector stateRepLocation,
const DtVector asSeenByRemoteLocation,
double  threshold 
) const
protectedvirtual

Determines whether the antenna location threshold has been exceeded.

virtual bool DtRadioTransmitterEncoder::antennaOrientationThresholdExceeded ( const DtTaitBryan stateRepOrientation,
const DtTaitBryan asSeenByRemoteOrientation,
double  threshold 
) const
protectedvirtual

Determines whether the antenna orientation threshold has been exceeded.

Note that the antenna orientation is only in the PDU when the antenna pattern type is that of beam antenna. The DIS spec states that the orientation should be determined by azimuth and elevation of the beam. If azimuth + elevation > threshold, then the threshold has been exceeded.

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

Assignment operator.

virtual bool DtRadioTransmitterEncoder::sendNeeded ( const DtRadioTransmitterRepository stateRep,
const DtRadioTransmitterRepository asSeenByRemote 
)
protectedvirtual

Determines whether a PDU needs to be sent.

virtual DtTransmitterPdu* DtRadioTransmitterEncoder::stateMsg ( const DtRadioTransmitterRepository stateRep,
const DtRadioTransmitterRepository asSeenByRemote 
)
virtual

Constructs a PDU from the state repository.

stateMsg determines whether a Transmitter PDU needs to be sent and constructs one of it does.

Returns
PDU if send is needed, and NULL if not

Member Data Documentation

DtTransmitterPdu DtRadioTransmitterEncoder::myPdu
protected

The PDU constructed by the encoder.


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)