VR-Link API Documentation for DIS
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:

List of all members.

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.

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.

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

Constructor.

Destructor.

Copy constructor.


Member Function Documentation

virtual bool DtRadioTransmitterEncoder::antennaLocationThresholdExceeded ( const DtVector stateRepLocation,
const DtVector asSeenByRemoteLocation,
double  threshold 
) const [protected, virtual]

Determines whether the antenna location threshold has been exceeded.

virtual bool DtRadioTransmitterEncoder::antennaOrientationThresholdExceeded ( const DtTaitBryan stateRepOrientation,
const DtTaitBryan asSeenByRemoteOrientation,
double  threshold 
) const [protected, virtual]

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 
) [protected, virtual]

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

The PDU constructed by the encoder.


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

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)