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

Instances of DtAggregateStateEncoder are used to take state information from an aggregate state repository and place it into an aggregate state PDU. More...

+ Inheritance diagram for DtAggregateStateEncoder:
+ Collaboration diagram for DtAggregateStateEncoder:

Public Member Functions

 DtAggregateStateEncoder ()
 Constructor.
virtual ~DtAggregateStateEncoder ()
 Destructor.
 DtAggregateStateEncoder (const DtAggregateStateEncoder &orig)
 Copy constructor.
DtAggregateStateEncoderoperator= (const DtAggregateStateEncoder &orig)
 Assignment operator.
virtual DtAggregateStatePdustateMsg (const DtAggregateStateRepository &stateRep, const DtAggregateStateRepository &asSeenByRemote)
 Constructs a PDU from the state repository.
 DtCLONE_ENCODER (DtAggregateStateEncoder)
- 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 DtAggregateStateRepository &stateRep, const DtAggregateStateRepository &asSeenByRemote)
 Determine if a state message needs to be sent.
virtual void fillOut (const DtAggregateStateRepository &stateRep, const DtAggregateStateRepository &asSeenByRemote, DtAggregateStatePdu *pdu)
 Fill out a state message which reflects a state repository.

Protected Attributes

DtAggregateStatePdu myAsPdu
- Protected Attributes inherited from DtStateEncoder
bool myForceSendNeeded

Detailed Description

Instances of DtAggregateStateEncoder are used to take state information from an aggregate state repository and place it into an aggregate state PDU.

Constructor & Destructor Documentation

DtAggregateStateEncoder::DtAggregateStateEncoder ( )

Constructor.

virtual DtAggregateStateEncoder::~DtAggregateStateEncoder ( )
virtual

Destructor.

DtAggregateStateEncoder::DtAggregateStateEncoder ( const DtAggregateStateEncoder orig)

Copy constructor.

Member Function Documentation

DtAggregateStateEncoder::DtCLONE_ENCODER ( DtAggregateStateEncoder  )
virtual void DtAggregateStateEncoder::fillOut ( const DtAggregateStateRepository stateRep,
const DtAggregateStateRepository asSeenByRemote,
DtAggregateStatePdu pdu 
)
protectedvirtual

Fill out a state message which reflects a state repository.

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

Assignment operator.

virtual bool DtAggregateStateEncoder::sendNeeded ( const DtAggregateStateRepository stateRep,
const DtAggregateStateRepository asSeenByRemote 
)
protectedvirtual

Determine if a state message needs to be sent.

virtual DtAggregateStatePdu* DtAggregateStateEncoder::stateMsg ( const DtAggregateStateRepository stateRep,
const DtAggregateStateRepository asSeenByRemote 
)
virtual

Constructs a PDU from the state repository.

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

Returns
PDU if send is needed, and NULL if not

Member Data Documentation

DtAggregateStatePdu DtAggregateStateEncoder::myAsPdu
protected

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

Document ID: Generated on Wed Jan 7 13:31:29 EST 2015 from SVN revision 149162
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)