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

Instances of DtGriddedDataEncoder are used to take state information from a DtGriddedDataRepository and place it into a gridded data PDU. More...

+ Inheritance diagram for DtGriddedDataEncoder:
+ Collaboration diagram for DtGriddedDataEncoder:

Public Member Functions

 DtGriddedDataEncoder ()
 Constructor.
virtual ~DtGriddedDataEncoder ()
 Destructor.
 DtGriddedDataEncoder (const DtGriddedDataEncoder &orig)
 Copy constructor.
DtGriddedDataEncoderoperator= (const DtGriddedDataEncoder &orig)
 Assignment operator.
virtual DtGriddedDataPdustateMsg (const DtGriddedDataRepository &stateRep, const DtGriddedDataRepository &asSeenByRemote)
 Constructs a PDU from the state repository.
 DtCLONE_ENCODER (DtGriddedDataEncoder)
- 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.

Protected Member Functions

virtual bool sendNeeded (const DtGriddedDataRepository &stateRep, const DtGriddedDataRepository &asSeenByRemote)
 Returns true if a PDU needs to be sent, (based on thresholds, etc) false otherwise.
virtual bool needGridAxisInfo (const DtGriddedDataRepository &stateRep, const DtGriddedDataRepository &asSeenByRemote, int index)
 Returns true if the grid axis info has changed.
virtual bool needGridDataInfo (const DtGriddedDataRepository &stateRep, const DtGriddedDataRepository &asSeenByRemote, int index)
 Returns true if the grid data info has changed.

Protected Attributes

DtGriddedDataPdu myPdu
- Protected Attributes inherited from DtStateEncoder
bool myForceSendNeeded

Detailed Description

Instances of DtGriddedDataEncoder are used to take state information from a DtGriddedDataRepository and place it into a gridded data PDU.

Constructor & Destructor Documentation

DtGriddedDataEncoder::DtGriddedDataEncoder ( )

Constructor.

virtual DtGriddedDataEncoder::~DtGriddedDataEncoder ( )
virtual

Destructor.

DtGriddedDataEncoder::DtGriddedDataEncoder ( const DtGriddedDataEncoder orig)

Copy constructor.

Member Function Documentation

DtGriddedDataEncoder::DtCLONE_ENCODER ( DtGriddedDataEncoder  )
virtual bool DtGriddedDataEncoder::needGridAxisInfo ( const DtGriddedDataRepository stateRep,
const DtGriddedDataRepository asSeenByRemote,
int  index 
)
protectedvirtual

Returns true if the grid axis info has changed.

virtual bool DtGriddedDataEncoder::needGridDataInfo ( const DtGriddedDataRepository stateRep,
const DtGriddedDataRepository asSeenByRemote,
int  index 
)
protectedvirtual

Returns true if the grid data info has changed.

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

Assignment operator.

virtual bool DtGriddedDataEncoder::sendNeeded ( const DtGriddedDataRepository stateRep,
const DtGriddedDataRepository asSeenByRemote 
)
protectedvirtual

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

virtual DtGriddedDataPdu* DtGriddedDataEncoder::stateMsg ( const DtGriddedDataRepository stateRep,
const DtGriddedDataRepository asSeenByRemote 
)
virtual

Constructs a PDU from the state repository.

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

Returns
PDU if send is needed, and NULL if not

Member Data Documentation

DtGriddedDataPdu DtGriddedDataEncoder::myPdu
protected

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

Document ID: Generated on Wed Oct 23 22:25:48 EDT 2013 from SVN revision 132765
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)