VR-Link API Documentation for DIS
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtReflectedAggregate Class Reference

Instances of this class provide a protocol independent interface to a reflected aggregate in a DIS environment. More...

+ Inheritance diagram for DtReflectedAggregate:
+ Collaboration diagram for DtReflectedAggregate:

List of all members.

Public Types

typedef
DtAggregateStateRepository *(* 
DtStateRepCreator )()
 Function prototype for functions that create DtAggregateStateRepositorys.

Public Member Functions

 DtReflectedAggregate (DtExerciseConn *conn, const DtEntityIdentifier &id, const DtEntityType &type)
 Constructor.
virtual ~DtReflectedAggregate ()
 Destructor.
virtual
DtAggregateStateRepository
aggregateStateRep () const
 Returns a pointer to the AggregateStateRepository - through which you can inspect current state information.
virtual
DtAggregateStateRepository
asr () const
 Synonym for aggregateStateRep().
virtual DtStateRepositorystateRep () const
 Returns a pointer to the StateRepository - through which you can inspect current state information.
virtual DtAggregateStateDecoderdecoder ()
 Returns a pointer to the Decoder being used to decode state messages into our ASR.
virtual const DtEntityIdentifieraggregateID () const
 Returns the aggregate identifier.
virtual const DtObjectIdid () const
 Get the aggregate's id. (For DIS, DtObjectId is DtEntityIdentifier).
virtual const
DtGlobalObjectDesignator
globalId () const
 Get the aggregate's object's global object designator - for DIS, it's the same as its DtEntityIdentifier.
virtual void processStateMessage (const DtStateMsg &msg)
 Process an aggregate state PDU.
virtual void processRelativeLocation (const DtRelativeLocationPdu &pdu)
virtual DtReflectedAggregatenext () const
 Get the next and previous elements in the reflected aggregate list.
virtual DtReflectedAggregateprev () const
virtual DtReflectedAggregatewrapNext () const
 Get the next and previous elements, wrap at the ends of the list.
virtual DtReflectedAggregatewrapPrev () const
virtual void addPostUpdateCallback (DtAggregateCallbackFunction cb, void *userData)
 Entity state callback registration/deregistration.
virtual void removePostUpdateCallback (DtAggregateCallbackFunction cb, void *userData)
virtual const DtBaseHashKeyhashKey () const
 Get a hash key for this object.
virtual DtString idString () const
 Get a string identification of this object.
virtual void processAggregateState (const DtAggregateStatePdu &pdu)
 Process an entity state PDU.

Static Public Member Functions

static void setStateRepCreator (DtStateRepCreator creator)
 Give us a function to be used for creating SRs.
static DtStateRepCreator stateRepCreator (void)

Protected Member Functions

 DtReflectedAggregate (const DtReflectedAggregate &orig)
 copy constructor -- not implemented
DtReflectedAggregateoperator= (const DtReflectedAggregate &orig)
 assignment operator -- not implemented

Protected Attributes

DtEntityIdentifier myId
DtAggregateStateRepositorymyAggregateStateRep
DtAggregateStateDecodermyAggregateDecoder
DtEntityIdentifierHashKey myHashKey

Static Protected Attributes

static DtStateRepCreator theStateRepCreator

Detailed Description

Instances of this class provide a protocol independent interface to a reflected aggregate in a DIS environment.


Member Typedef Documentation

Function prototype for functions that create DtAggregateStateRepositorys.


Constructor & Destructor Documentation

Constructor.

Destructor.

copy constructor -- not implemented


Member Function Documentation

virtual void DtReflectedAggregate::addPostUpdateCallback ( DtAggregateCallbackFunction  cb,
void *  userData 
) [virtual]

Entity state callback registration/deregistration.

virtual const DtEntityIdentifier& DtReflectedAggregate::aggregateID ( ) const [virtual]

Returns the aggregate identifier.

Returns a pointer to the AggregateStateRepository - through which you can inspect current state information.

Synonym for aggregateStateRep().

Returns a pointer to the Decoder being used to decode state messages into our ASR.

virtual const DtGlobalObjectDesignator& DtReflectedAggregate::globalId ( ) const [virtual]

Get the aggregate's object's global object designator - for DIS, it's the same as its DtEntityIdentifier.

Implements DtReflectedObject.

virtual const DtBaseHashKey& DtReflectedAggregate::hashKey ( ) const [virtual]

Get a hash key for this object.

Implements DtReflectedObject.

virtual const DtObjectId& DtReflectedAggregate::id ( ) const [virtual]

Get the aggregate's id. (For DIS, DtObjectId is DtEntityIdentifier).

virtual DtString DtReflectedAggregate::idString ( ) const [virtual]

Get a string identification of this object.

Implements DtReflectedObject.

virtual DtReflectedAggregate* DtReflectedAggregate::next ( ) const [virtual]

Get the next and previous elements in the reflected aggregate list.

Reimplemented from DtListedObj.

DtReflectedAggregate& DtReflectedAggregate::operator= ( const DtReflectedAggregate orig) [protected]

assignment operator -- not implemented

virtual DtReflectedAggregate* DtReflectedAggregate::prev ( ) const [virtual]

Reimplemented from DtListedObj.

virtual void DtReflectedAggregate::processAggregateState ( const DtAggregateStatePdu pdu) [virtual]

Process an entity state PDU.

Also calls down to base class processStateMessage().

virtual void DtReflectedAggregate::processStateMessage ( const DtStateMsg msg) [virtual]

Process an aggregate state PDU.

Implementation for abstract base class.

Reimplemented from DtReflectedObject.

virtual void DtReflectedAggregate::removePostUpdateCallback ( DtAggregateCallbackFunction  cb,
void *  userData 
) [virtual]

Give us a function to be used for creating SRs.

virtual DtStateRepository* DtReflectedAggregate::stateRep ( ) const [virtual]

Returns a pointer to the StateRepository - through which you can inspect current state information.

Implementation for abstract base class. Calls asr().

Implements DtReflectedObject.

Get the next and previous elements, wrap at the ends of the list.

Reimplemented from DtListedObj.

Reimplemented from DtListedObj.


Member Data Documentation


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

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)