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

The DtStateEncoder class provides a base class for all DIS encoders. More...

+ Inheritance diagram for DtStateEncoder:
+ Collaboration diagram for DtStateEncoder:

Public Member Functions

 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 Attributes

bool myForceSendNeeded

Detailed Description

The DtStateEncoder class provides a base class for all DIS encoders.

Constructor & Destructor Documentation

DtStateEncoder::DtStateEncoder ( )

Default constructor.

virtual DtStateEncoder::~DtStateEncoder ( )
virtual

Destructor.

DtStateEncoder::DtStateEncoder ( const DtStateEncoder orig)

Copy constructor.

Member Function Documentation

virtual DtPduEncoder* DtStateEncoder::clone ( ) const
pure virtual

clone.

Must be defined in your child class. This is easily done by defining DtCLONE_ENCODER(DtChildClass)

Implements DtPduEncoder.

Implemented in DtDirectedEnergyFireEncoder.

virtual void DtStateEncoder::encode ( DtPdu pdu)
virtual

This is a dummy method for backwards compatibility with DIS encoders.

Implements DtPduEncoder.

Reimplemented in DtDirectedEnergyFireEncoder.

virtual void DtStateEncoder::fillOutAttributeRecords ( const DtStateRepository stateRep,
DtPduWithAttributeRecordSets pdu,
const DtEntityIdentifier id,
bool  clearBeforeAdding = true 
)
virtual

DIS 7 requires filling the Attribute Records for a coupled Attribute PDU.

It is filled in this function.

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

Assignment operator.

virtual bool DtStateEncoder::sendNeededAttributeRecords ( const DtStateRepository stateRep,
const DtStateRepository asSeenByRemote 
) const
virtual

In order to modify records in place, and have them sent, we need to compare the stateRep with the As seen by remote.

(DIS 7).

void DtStateEncoder::setSendNeeded ( )

Sets myForceSendNeeded to true.

Referenced by DtDirectedEnergyFirePublisher::forceUpdate(), and DtDesignatorPublisher::forceUpdate().

Member Data Documentation

bool DtStateEncoder::myForceSendNeeded
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)