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

Instances of DtEntityStateEncoder are used to take state information from a DtEntityStateRepository and place it into an entity state PDU. More...

+ Inheritance diagram for DtEntityStateEncoder:
+ Collaboration diagram for DtEntityStateEncoder:

Public Member Functions

 DtEntityStateEncoder ()
 CTOR.
 DtEntityStateEncoder (const DtEntityStateEncoder &orig)
 Copy CTOR.
virtual ~DtEntityStateEncoder ()
 Virtual DTOR.
DtEntityStateEncoderoperator= (const DtEntityStateEncoder &orig)
 Assignment operator.
virtual DtEntityStatePdustateMsg (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote)
 Constructs a PDU from the state repository.
 DtCLONE_ENCODER (DtEntityStateEncoder)
- 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.
virtual DtPduEncoderclone () const =0
 clone.
virtual void encode (DtPdu *pdu)
 This is a dummy method for backwards compatibility with DIS encoders.
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.
virtual bool sendNeededAttributeRecords (const DtStateRepository &stateRep, const DtStateRepository &asSeenByRemote) const
 In order to modify records in place, and have them sent, we need to compare the stateRep with the As seen by remote.
- Public Member Functions inherited from DtPduEncoder
virtual ~DtPduEncoder ()

Protected Member Functions

virtual bool sendNeeded (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote)
 Returns true if a PDU needs to be sent, (based on thresholds, etc) false otherwise.
virtual void fillOut (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote, DtEntityStatePdu *pdu)
 Copy current ESR data to the pdu.
virtual bool artPartsNeedUpdating (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote)
 Returns true if art part info is out of date, false otherwise.
virtual bool attPartsNeedUpdating (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote)
 Returns true if art part info is out of date, false otherwise.
virtual bool variableDatumNeedsUpdating (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote)
 Returns true if the DIS 7 Variable Datum is out of date, false otherwise.
virtual void fillOutDeadReckoningParams (const DtEntityStateRepository &stateRep, DtEntityStatePdu *pdu)
 DIS 7 requires filling the Params structure with derived values for speed in decoding.
virtual void fillOutArtAndAttParts (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote, DtEntityStatePdu *pdu)
 Copies current articulated and attached part info from the ESR to the PDU.

Protected Attributes

DtEntityStatePdu myEsPdu
- Protected Attributes inherited from DtStateEncoder
bool myForceSendNeeded

Detailed Description

Instances of DtEntityStateEncoder are used to take state information from a DtEntityStateRepository and place it into an entity state PDU.

Constructor & Destructor Documentation

DtEntityStateEncoder::DtEntityStateEncoder ( )

CTOR.

DtEntityStateEncoder::DtEntityStateEncoder ( const DtEntityStateEncoder orig)

Copy CTOR.

virtual DtEntityStateEncoder::~DtEntityStateEncoder ( )
virtual

Virtual DTOR.

Member Function Documentation

virtual bool DtEntityStateEncoder::artPartsNeedUpdating ( const DtEntityStateRepository stateRep,
const DtEntityStateRepository asSeenByRemote 
)
protectedvirtual

Returns true if art part info is out of date, false otherwise.

virtual bool DtEntityStateEncoder::attPartsNeedUpdating ( const DtEntityStateRepository stateRep,
const DtEntityStateRepository asSeenByRemote 
)
protectedvirtual

Returns true if art part info is out of date, false otherwise.

DtEntityStateEncoder::DtCLONE_ENCODER ( DtEntityStateEncoder  )
virtual void DtEntityStateEncoder::fillOut ( const DtEntityStateRepository stateRep,
const DtEntityStateRepository asSeenByRemote,
DtEntityStatePdu pdu 
)
protectedvirtual

Copy current ESR data to the pdu.

virtual void DtEntityStateEncoder::fillOutArtAndAttParts ( const DtEntityStateRepository stateRep,
const DtEntityStateRepository asSeenByRemote,
DtEntityStatePdu pdu 
)
protectedvirtual

Copies current articulated and attached part info from the ESR to the PDU.

virtual void DtEntityStateEncoder::fillOutDeadReckoningParams ( const DtEntityStateRepository stateRep,
DtEntityStatePdu pdu 
)
protectedvirtual

DIS 7 requires filling the Params structure with derived values for speed in decoding.

It is filled in this function.

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

Assignment operator.

virtual bool DtEntityStateEncoder::sendNeeded ( const DtEntityStateRepository stateRep,
const DtEntityStateRepository asSeenByRemote 
)
protectedvirtual

Returns true if a PDU needs to be sent, (based on thresholds, etc) false otherwise.

virtual DtEntityStatePdu* DtEntityStateEncoder::stateMsg ( const DtEntityStateRepository stateRep,
const DtEntityStateRepository asSeenByRemote 
)
virtual

Constructs a PDU from the state repository.

stateMsg determines whether an Entity State PDU needs to be sent and constructs one of it does.

Returns
PDU if send is needed, and NULL if not
virtual bool DtEntityStateEncoder::variableDatumNeedsUpdating ( const DtEntityStateRepository stateRep,
const DtEntityStateRepository asSeenByRemote 
)
protectedvirtual

Returns true if the DIS 7 Variable Datum is out of date, false otherwise.

Member Data Documentation

DtEntityStatePdu DtEntityStateEncoder::myEsPdu
protected

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

Document ID: Generated on Fri May 15 06:36:13 EDT 2015 from SVN revision 153263
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)