![]() |
VR-Link API Documentation for DIS
|
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: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 DtStateRepository * | stateRep () const |
| Returns a pointer to the StateRepository - through which you can inspect current state information. | |
| virtual DtAggregateStateDecoder * | decoder () |
| Returns a pointer to the Decoder being used to decode state messages into our ASR. | |
| virtual const DtEntityIdentifier & | aggregateID () const |
| Returns the aggregate identifier. | |
| virtual const DtObjectId & | id () 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 DtReflectedAggregate * | next () const |
| Get the next and previous elements in the reflected aggregate list. | |
| virtual DtReflectedAggregate * | prev () const |
| virtual DtReflectedAggregate * | wrapNext () const |
| Get the next and previous elements, wrap at the ends of the list. | |
| virtual DtReflectedAggregate * | wrapPrev () const |
| virtual void | addPostUpdateCallback (DtAggregateCallbackFunction cb, void *userData) |
| Entity state callback registration/deregistration. | |
| virtual void | removePostUpdateCallback (DtAggregateCallbackFunction cb, void *userData) |
| virtual const DtBaseHashKey & | hashKey () 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 | |
| DtReflectedAggregate & | operator= (const DtReflectedAggregate &orig) |
| assignment operator -- not implemented | |
Protected Attributes | |
| DtEntityIdentifier | myId |
| DtAggregateStateRepository * | myAggregateStateRep |
| DtAggregateStateDecoder * | myAggregateDecoder |
| DtEntityIdentifierHashKey | myHashKey |
Static Protected Attributes | |
| static DtStateRepCreator | theStateRepCreator |
Instances of this class provide a protocol independent interface to a reflected aggregate in a DIS environment.
Function prototype for functions that create DtAggregateStateRepositorys.
| DtReflectedAggregate::DtReflectedAggregate | ( | DtExerciseConn * | conn, |
| const DtEntityIdentifier & | id, | ||
| const DtEntityType & | type | ||
| ) |
Constructor.
| virtual DtReflectedAggregate::~DtReflectedAggregate | ( | ) | [virtual] |
Destructor.
| DtReflectedAggregate::DtReflectedAggregate | ( | const DtReflectedAggregate & | orig | ) | [protected] |
copy constructor -- not implemented
| 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.
| virtual DtAggregateStateRepository* DtReflectedAggregate::aggregateStateRep | ( | ) | const [virtual] |
Returns a pointer to the AggregateStateRepository - through which you can inspect current state information.
| virtual DtAggregateStateRepository* DtReflectedAggregate::asr | ( | ) | const [virtual] |
Synonym for aggregateStateRep().
| virtual DtAggregateStateDecoder* DtReflectedAggregate::decoder | ( | ) | [virtual] |
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::processRelativeLocation | ( | const DtRelativeLocationPdu & | pdu | ) | [virtual] |
| 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] |
| static void DtReflectedAggregate::setStateRepCreator | ( | DtStateRepCreator | creator | ) | [static] |
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.
| static DtStateRepCreator DtReflectedAggregate::stateRepCreator | ( | void | ) | [static] |
| virtual DtReflectedAggregate* DtReflectedAggregate::wrapNext | ( | ) | const [virtual] |
Get the next and previous elements, wrap at the ends of the list.
Reimplemented from DtListedObj.
| virtual DtReflectedAggregate* DtReflectedAggregate::wrapPrev | ( | ) | const [virtual] |
Reimplemented from DtListedObj.
DtEntityIdentifier DtReflectedAggregate::myId [protected] |
DtStateRepCreator DtReflectedAggregate::theStateRepCreator [static, protected] |