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
DtDesignatorEncoder Class Reference

Instances of DtDesignatorEncoder are used to take state information from a DtDesignatorRepository and place it into a designator PDU. More...

+ Inheritance diagram for DtDesignatorEncoder:
+ Collaboration diagram for DtDesignatorEncoder:

Public Member Functions

 DtDesignatorEncoder (double _relPosThreshold=1.0, double _absPosThreshold=1.0, double _accelThreshold=0.2)
 Constructor. More...
 
virtual ~DtDesignatorEncoder ()
 Destructor. More...
 
 DtDesignatorEncoder (const DtDesignatorEncoder &orig)
 Copy constructor. More...
 
DtDesignatorEncoderoperator= (const DtDesignatorEncoder &orig)
 Assignment operator. More...
 
virtual DtDesignatorPdustateMsg (const DtDesignatorRepository &stateRep, const DtDesignatorRepository &asSeenByRemote)
 Constructs a PDU from the state repository. More...
 
 DtCLONE_ENCODER (DtDesignatorEncoder)
 
virtual void setRelPosThreshold (double val)
 Set/Query the value of the "Relative Position" Update Threshold. More...
 
virtual double relPosThreshold () const
 Set/Query the value of the "Relative Position" Update Threshold. More...
 
virtual void setAbsPosThreshold (double val)
 Set/Query the value of the "Absolute Position" Update Threshold. More...
 
virtual double absPosThreshold () const
 Set/Query the value of the "Absolute Position" Update Threshold. More...
 
virtual void setAccelThreshold (double val)
 Set/Query the value of the "Acceleration" Update Threshold. More...
 
virtual double accelThreshold () const
 Set/Query the value of the "Acceleration" Update Threshold. 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 DtDesignatorRepository &stateRep, const DtDesignatorRepository &asSeenByRemote)
 Determine if a state message needs to be sent. More...
 

Protected Attributes

double myRelPosThreshold
 
double myAbsPosThreshold
 
double myAccelThreshold
 
DtDesignatorPdu myPdu
 
- Protected Attributes inherited from DtStateEncoder
bool myForceSendNeeded
 
DtU32 myChangedState
 

Detailed Description

Instances of DtDesignatorEncoder are used to take state information from a DtDesignatorRepository and place it into a designator PDU.

Constructor & Destructor Documentation

DtDesignatorEncoder::DtDesignatorEncoder ( double  _relPosThreshold = 1.0,
double  _absPosThreshold = 1.0,
double  _accelThreshold = 0.2 
)

Constructor.

virtual DtDesignatorEncoder::~DtDesignatorEncoder ( )
virtual

Destructor.

DtDesignatorEncoder::DtDesignatorEncoder ( const DtDesignatorEncoder orig)

Copy constructor.

Member Function Documentation

double DtDesignatorEncoder::absPosThreshold ( ) const
inlinevirtual

Set/Query the value of the "Absolute Position" Update Threshold.

References myAbsPosThreshold.

double DtDesignatorEncoder::accelThreshold ( ) const
inlinevirtual

Set/Query the value of the "Acceleration" Update Threshold.

References myAccelThreshold.

DtDesignatorEncoder::DtCLONE_ENCODER ( DtDesignatorEncoder  )
DtDesignatorEncoder& DtDesignatorEncoder::operator= ( const DtDesignatorEncoder orig)

Assignment operator.

double DtDesignatorEncoder::relPosThreshold ( ) const
inlinevirtual

Set/Query the value of the "Relative Position" Update Threshold.

References myRelPosThreshold.

virtual bool DtDesignatorEncoder::sendNeeded ( const DtDesignatorRepository stateRep,
const DtDesignatorRepository asSeenByRemote 
)
protectedvirtual

Determine if a state message needs to be sent.

void DtDesignatorEncoder::setAbsPosThreshold ( double  val)
inlinevirtual

Set/Query the value of the "Absolute Position" Update Threshold.

References myAbsPosThreshold.

void DtDesignatorEncoder::setAccelThreshold ( double  val)
inlinevirtual

Set/Query the value of the "Acceleration" Update Threshold.

References myAccelThreshold.

void DtDesignatorEncoder::setRelPosThreshold ( double  val)
inlinevirtual

Set/Query the value of the "Relative Position" Update Threshold.

References myRelPosThreshold.

virtual DtDesignatorPdu* DtDesignatorEncoder::stateMsg ( const DtDesignatorRepository stateRep,
const DtDesignatorRepository asSeenByRemote 
)
virtual

Constructs a PDU from the state repository.

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

Returns
PDU if send is needed, and NULL if not

Member Data Documentation

double DtDesignatorEncoder::myAbsPosThreshold
protected
double DtDesignatorEncoder::myAccelThreshold
protected
DtDesignatorPdu DtDesignatorEncoder::myPdu
protected
double DtDesignatorEncoder::myRelPosThreshold
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)