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

class DtReflectedGriddedData: More...

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

Public Types

typedef DtGriddedDataRepository *(* DtStateRepCreator )()
 Function prototype for functions that create DtGriddedDataRepositories.
- Public Types inherited from DtReflectedObject
typedef DtStateRepository *(* DtBaseStateRepCreator )()
 Function prototype for functions that create DtStateRepositories.

Public Member Functions

 DtReflectedGriddedData (DtHlaObject *obj, DtExerciseConn *conn)
 constructor
virtual ~DtReflectedGriddedData ()
 destructor
virtual DtGriddedDataRepository * gridDataRep () const
 Get the designator's state repository.
virtual DtGriddedDataRepository * gdsr () const
 Synonym for designatorRep().
virtual DtReflectedGriddedData * next () const
 Get the next remote designator.
virtual DtReflectedGriddedData * prev () const
 Get the previous remote designator.
virtual DtReflectedGriddedData * wrapNext () const
 Get the next remote designator.
virtual DtReflectedGriddedData * wrapPrev () const
 Get the previous remote designator.
virtual void addPostUpdateCallback (DtGriddedDataCallbackFunction cb, void *userData)
 Designator state callback registration/deregistration.
virtual void removePostUpdateCallback (DtGriddedDataCallbackFunction cb, void *userData)
- Public Member Functions inherited from DtReflectedObject
 DtReflectedObject (DtExerciseConn *conn, DtStateRepository *stateRep)
 Primary constructor.
 DtReflectedObject (DtHlaObject *obj, DtExerciseConn *conn, DtBaseStateRepCreator creator)
 Older constructor.
 DtReflectedObject (const DtObjectId &id, const DtGlobalObjectDesignator &des, DtExerciseConn *conn, DtBaseStateRepCreator creator)
 Older constructor.
virtual ~DtReflectedObject ()
 destructor
virtual DtStateRepository * stateRep () const
 Returns a pointer to the StateRepository - through which you can inspect current state information.
virtual DtStateRepository * sr () const
 Synonym for stateRep().
virtual DtHlaStateDecoder * decoder ()
 Returns a pointer to the Decoder being used to decode state messages into our SR.
virtual DtHlaObjectWithStateRep * hlaObject () const
 Get the entity's hlaObject (DtHlaObjectWithStateRep is derived from DtHlaObject).
virtual const DtObjectId & objectId () const
 Get the HLA object's id.
virtual const DtObjectId & id () const
 Get the HLA object's id (local ID).
virtual const DtObjectId & localId () const
 Get the HLA object's id (local ID).
virtual const DtString & name () const
 Get the HLA object name.
virtual const
DtGlobalObjectDesignator & 
globalId () const
 Get the HLA object's global object designator - the object name in HLA.
virtual const DtString & lastProducingFederate () const
 Get the name of the last federate that produced a reflected update.
virtual DtTime lastSimTimeUpdated () const
 Returns the value of simulation time at the time an update was last received for the entity.
virtual DtTime lastReceivedTimeStamp () const
 Returns the value of the time send in the last Update received for this entity.
virtual void baseAddPostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData)
 Object state callback registration/deregistration.
virtual void baseRemovePostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData)
virtual DtReflectedObject * nextObj () const
 Get the next remote object.
virtual DtReflectedObject * prevObj () const
 Get the previous remote object.
virtual DtReflectedObject * wrapNextObj () const
 Get the next remote object.
virtual DtReflectedObject * wrapPrevObj () const
 Get the previous remote object.
void setHlaObject (DtHlaObject *obj, DtHlaStateDecoder *decoder=NULL)
 Start reflecting this object, using this decoder.
virtual void setNoHlaObject (const DtObjectId &id, const DtGlobalObjectDesignator &des)
 Used to set up a proxy DtReflectedEntity - one that is not actually managing a real reflected HLA object.
void detachHlaObject ()
 Ends managing of current HLA object.
virtual void requestUpdate ()
 Request that the owner of this entity send an attribute update.
- Public Member Functions inherited from DtListedObj
 DtListedObj ()
 Constructor.
virtual ~DtListedObj ()
 Destructor.

Static Public Member Functions

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

Protected Member Functions

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

Static Protected Attributes

static DtStateRepCreator theStateRepCreator

Additional Inherited Members

- Static Protected Member Functions inherited from DtReflectedObject
static void requestUpdatePostDrainCb (void *usr)
 Calls requestUpdate.
static void processPostUpdateCallbacksCb (const DtStateMsg &stateMsg, DtHlaObject *obj, void *usr)
 Callback from HlaObject to process post update callbacks.
- Protected Attributes inherited from DtReflectedObject
DtExerciseConn * myExConn
DtHlaObjectWithStateRep * myHlaObj
DtStateRepository * myStateRep
DtHlaStateDecoder * myDecoder
bool myRequestCbRegistered
DtIntrusiveList myStateUpdateCallbacks
DtObjectId myId
DtString myName

Detailed Description

class DtReflectedGriddedData:

Instances of DtReflectedGriddedData are used to represent a GriddedData Object which has been published remotely.

Member Typedef Documentation

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

Function prototype for functions that create DtGriddedDataRepositories.

Constructor & Destructor Documentation

DtReflectedGriddedData::DtReflectedGriddedData ( DtHlaObject *  obj,
DtExerciseConn *  conn 
)

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

Designator state callback registration/deregistration.

DtGriddedDataRepository * DtReflectedGriddedData::gdsr ( ) const
inlinevirtual

Synonym for designatorRep().

References DtReflectedObject::myStateRep.

DtGriddedDataRepository * DtReflectedGriddedData::gridDataRep ( ) const
inlinevirtual

Get the designator's state repository.

References DtReflectedObject::myStateRep.

virtual DtReflectedGriddedData* DtReflectedGriddedData::next ( ) const
virtual

Get the next remote designator.

Reimplemented from DtListedObj.

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

assignment operator – not implemented

virtual DtReflectedGriddedData* DtReflectedGriddedData::prev ( ) const
virtual

Get the previous remote designator.

Reimplemented from DtListedObj.

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

Give us a function to be used for creating SRs.

virtual DtReflectedGriddedData* DtReflectedGriddedData::wrapNext ( ) const
virtual

Get the next remote designator.

Will cycle back to the first remote designator.

Reimplemented from DtListedObj.

virtual DtReflectedGriddedData* DtReflectedGriddedData::wrapPrev ( ) const
virtual

Get the previous remote designator.

Will cycle back to the last remote designator.

Reimplemented from DtListedObj.

Member Data Documentation

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)