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. More...
 
 DtEntityStateEncoder (const DtEntityStateEncoder &orig)
 Copy CTOR. More...
 
virtual ~DtEntityStateEncoder ()
 Virtual DTOR. More...
 
DtEntityStateEncoderoperator= (const DtEntityStateEncoder &orig)
 Assignment operator. More...
 
virtual DtEntityStatePdustateMsg (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote)
 Constructs a PDU from the state repository. More...
 
 DtCLONE_ENCODER (DtEntityStateEncoder)
 
- 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 DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote)
 Returns true if a PDU needs to be sent, (based on thresholds, etc) false otherwise. More...
 
virtual void fillOut (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote, DtEntityStatePdu *pdu)
 Copy current ESR data to the pdu. More...
 
virtual bool artPartsNeedUpdating (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote)
 Returns true if art part info is out of date, false otherwise. More...
 
virtual bool attPartsNeedUpdating (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote)
 Returns true if art part info is out of date, false otherwise. More...
 
virtual bool netnNeedsUpdating (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote)
 Returns true if NETN attributes needs updating. More...
 
virtual bool makExtensionsNeedUpdating (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote)
 Returns true if MAK Extended attributes need updating. More...
 
virtual bool variableDatumNeedsUpdating (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote)
 Returns true if the DIS 7 Variable Datum is out of date, false otherwise. More...
 
virtual void fillOutDeadReckoningParams (const DtEntityStateRepository &stateRep, DtEntityStatePdu *pdu)
 DIS 7 requires filling the Params structure with derived values for speed in decoding. More...
 
virtual void fillOutArtAndAttParts (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote, DtEntityStatePdu *pdu)
 Copies current articulated and attached part info from the ESR to the PDU. More...
 
virtual void fillOutNetnAttributes (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote)
 Filling out the attribute Records with NETN values. More...
 
virtual void fillOutMakExtendedAttributes (const DtEntityStateRepository &stateRep, const DtEntityStateRepository &asSeenByRemote)
 Filling out the attribute Records with custom MAK Extension records. More...
 

Protected Attributes

DtEntityStatePdu myEsPdu
 
bool myFilloutMakAttributeRecords
 
bool myFilloutNetnAttributeRecords
 
- Protected Attributes inherited from DtStateEncoder
bool myForceSendNeeded
 
DtU32 myChangedState
 

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.

virtual void DtEntityStateEncoder::fillOutMakExtendedAttributes ( const DtEntityStateRepository stateRep,
const DtEntityStateRepository asSeenByRemote 
)
protectedvirtual

Filling out the attribute Records with custom MAK Extension records.

virtual void DtEntityStateEncoder::fillOutNetnAttributes ( const DtEntityStateRepository stateRep,
const DtEntityStateRepository asSeenByRemote 
)
protectedvirtual

Filling out the attribute Records with NETN values.

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

Returns true if MAK Extended attributes need updating.

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

Returns true if NETN attributes needs updating.

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
bool DtEntityStateEncoder::myFilloutMakAttributeRecords
protected
bool DtEntityStateEncoder::myFilloutNetnAttributeRecords
protected

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

Document ID: Generated on Thu Sep 19 02:12:35 EDT 2024 from SVN revision 269601
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)