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

Instances of DtReflectedGriddedData represent Gridded Data objects simulated by remote applications. More...

+ Inheritance diagram for DtReflectedGriddedData:
+ Collaboration diagram for DtReflectedGriddedData:

Public Types

typedef DtGriddedDataRepository *(* DtStateRepCreator )()
 Function prototype for functions that create DtGriddedDataRepositories.

Public Member Functions

 DtReflectedGriddedData (DtExerciseConn *conn, const DtEntityIdentifier &id, const DtEntityType &type)
 constructor
virtual ~DtReflectedGriddedData ()
 destructor
virtual DtGriddedDataRepositorygriddedDataStateRep () const
 Returns ptr to griddedDataStateRepository – through which you can inspect current state info.
virtual DtGriddedDataRepositorygdsr () const
 Synonym for griddedDataStateRep.
virtual DtStateRepositorystateRep () const
 Implementation for abstract base class. Calls gdsr().
virtual DtGriddedDataDecoderdecoder ()
 Returns a pointer to the Decoder being used to decode state messages into our GDSR.
virtual const DtEntityIdentifierentityId () const
 Returns the entity identifier.
virtual const DtObjectIdid () const
 Get the gridded data's id. (For DIS, DtObjectId is DtEntityIdentifier).
virtual const DtObjectIdlocalId () const
 Get the gridded data's local id. For DIS - same as id().
virtual const
DtGlobalObjectDesignator
globalId () const
 Get the gridded data's object's global object designator - for DIS, it's the same as its DtEntityIdentifier.
virtual void processStateMessage (const DtStateMsg &msg)
 Process an environment process state PDU.
virtual DtReflectedGriddedDatanext () const
 Get the next and previous elements in the reflected environment process list.
virtual DtReflectedGriddedDataprev () const
virtual DtReflectedGriddedDatawrapNext () const
 Get the next and previous elements, wrap at the ends of the list.
virtual DtReflectedGriddedDatawrapPrev () const
virtual void addPostUpdateCallback (DtGriddedDataCallbackFunction cb, void *userData)
 Environment Process callback registration/deregistration.
virtual void removePostUpdateCallback (DtGriddedDataCallbackFunction 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 processGriddedData (const DtGriddedDataPdu &pdu)
 Process an environmentalProcess PDU.
- Public Member Functions inherited from DtReflectedObject
 DtReflectedObject (DtExerciseConn *conn)
 constructor
virtual ~DtReflectedObject ()
 destructor
virtual DtStateRepositorysr () const
 Synonym for stateRep().
virtual DtTime lastTimeUpdated () const
 Returns the value of wallclock time at the time an update was last received for the entity.
virtual DtTime lastSimTimeUpdated () const
 Returns the value of sim time at the time an update was last received for the entity.
virtual DtTime lastReceivedTimeStamp () const
 Returns the value in seconds past the hour of the timeStamp from the last received PDU.
virtual void baseAddPostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData)
 Object state callback registration/deregistration.
virtual void baseRemovePostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData)
virtual DtReflectedObjectnextObj () const
 Get the next remote object.
virtual DtReflectedObjectprevObj () const
 Get the previous remote object.
virtual DtReflectedObjectwrapNextObj () const
 Get the next remote object.
virtual DtReflectedObjectwrapPrevObj () const
 Get the previous remote object.
- Public Member Functions inherited from DtListedObj
 DtListedObj ()
 Constructor.
virtual ~DtListedObj ()
 Destructor.

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

 DtReflectedGriddedData (const DtReflectedGriddedData &orig)
 copy constructor – not implemented
DtReflectedGriddedDataoperator= (const DtReflectedGriddedData &orig)
 assignment operator – not implemented
- Protected Member Functions inherited from DtReflectedObject
 DtReflectedObject (const DtReflectedObject &orig)
 copy constructor – not implemented
DtReflectedObjectoperator= (const DtReflectedObject &orig)
 assignment operator – not implemented
virtual void processPostUpdateCallbacks ()
 Process the post update callbacks.

Protected Attributes

DtEntityIdentifier myId
DtGriddedDataRepositorymyStateRep
DtGriddedDataDecodermyDecoder
DtEntityIdentifierHashKey myHashKey
- Protected Attributes inherited from DtReflectedObject
DtExerciseConnmyExConn
DtIntrusiveList myStateUpdateCallbacks
DtTime myLastTimeUpdated
DtTime myLastSimTimeUpdated
DtTime myLastReceivedTimeStamp
- Protected Attributes inherited from DtListedObj
DtListmyList
DtListItemmyItem

Static Protected Attributes

static DtStateRepCreator theStateRepCreator

Detailed Description

Instances of DtReflectedGriddedData represent Gridded Data objects simulated by remote applications.

State data can be viewed through its state repository.

Member Typedef Documentation

typedef DtGriddedDataRepository*(* DtReflectedGriddedData::DtStateRepCreator)()

Function prototype for functions that create DtGriddedDataRepositories.

Constructor & Destructor Documentation

DtReflectedGriddedData::DtReflectedGriddedData ( DtExerciseConn conn,
const DtEntityIdentifier id,
const DtEntityType type 
)

constructor

virtual DtReflectedGriddedData::~DtReflectedGriddedData ( )
virtual

destructor

DtReflectedGriddedData::DtReflectedGriddedData ( const DtReflectedGriddedData orig)
protected

copy constructor – not implemented

Member Function Documentation

virtual void DtReflectedGriddedData::addPostUpdateCallback ( DtGriddedDataCallbackFunction  cb,
void *  userData 
)
virtual

Environment Process callback registration/deregistration.

virtual DtGriddedDataDecoder* DtReflectedGriddedData::decoder ( )
virtual

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

virtual const DtEntityIdentifier& DtReflectedGriddedData::entityId ( ) const
virtual

Returns the entity identifier.

virtual DtGriddedDataRepository* DtReflectedGriddedData::gdsr ( ) const
virtual

Synonym for griddedDataStateRep.

virtual const DtGlobalObjectDesignator& DtReflectedGriddedData::globalId ( ) const
virtual

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

Implements DtReflectedObject.

virtual DtGriddedDataRepository* DtReflectedGriddedData::griddedDataStateRep ( ) const
virtual

Returns ptr to griddedDataStateRepository – through which you can inspect current state info.

virtual const DtBaseHashKey& DtReflectedGriddedData::hashKey ( ) const
virtual

Get a hash key for this object.

Implements DtReflectedObject.

virtual const DtObjectId& DtReflectedGriddedData::id ( ) const
virtual

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

virtual DtString DtReflectedGriddedData::idString ( ) const
virtual

Get a string identification of this object.

Implements DtReflectedObject.

virtual const DtObjectId& DtReflectedGriddedData::localId ( ) const
virtual

Get the gridded data's local id. For DIS - same as id().

virtual DtReflectedGriddedData* DtReflectedGriddedData::next ( ) const
virtual

Get the next and previous elements in the reflected environment process list.

Reimplemented from DtListedObj.

DtReflectedGriddedData& DtReflectedGriddedData::operator= ( const DtReflectedGriddedData orig)
protected

assignment operator – not implemented

virtual DtReflectedGriddedData* DtReflectedGriddedData::prev ( ) const
virtual

Reimplemented from DtListedObj.

virtual void DtReflectedGriddedData::processGriddedData ( const DtGriddedDataPdu pdu)
virtual

Process an environmentalProcess PDU.

Also calls down to base class processStateMessage().

virtual void DtReflectedGriddedData::processStateMessage ( const DtStateMsg msg)
virtual

Process an environment process state PDU.

Calls processGriddedData().

Reimplemented from DtReflectedObject.

virtual void DtReflectedGriddedData::removePostUpdateCallback ( DtGriddedDataCallbackFunction  cb,
void *  userData 
)
virtual
static void DtReflectedGriddedData::setStateRepCreator ( DtStateRepCreator  creator)
static

Give us a function to be used for creating SRs.

virtual DtStateRepository* DtReflectedGriddedData::stateRep ( ) const
virtual

Implementation for abstract base class. Calls gdsr().

Implements DtReflectedObject.

static DtStateRepCreator DtReflectedGriddedData::stateRepCreator ( void  )
static
virtual DtReflectedGriddedData* DtReflectedGriddedData::wrapNext ( ) const
virtual

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

Reimplemented from DtListedObj.

virtual DtReflectedGriddedData* DtReflectedGriddedData::wrapPrev ( ) const
virtual

Reimplemented from DtListedObj.

Member Data Documentation

DtGriddedDataDecoder* DtReflectedGriddedData::myDecoder
protected
DtEntityIdentifierHashKey DtReflectedGriddedData::myHashKey
protected
DtEntityIdentifier DtReflectedGriddedData::myId
protected
DtGriddedDataRepository* DtReflectedGriddedData::myStateRep
protected
DtStateRepCreator DtReflectedGriddedData::theStateRepCreator
staticprotected

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

Document ID: Generated on Wed Aug 14 15:35:11 EDT 2013 from SVN revision 130445
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)