VR-Link API Documentation for HLA Evolved
List of all members | Public Member Functions | Protected Member Functions
DtReflectedGenericObject Class Reference

Instances of DtReflectedGenericObject are used to represent "GenericObject" objects simulated remotely, that we hear about through the RTI. More...

+ Inheritance diagram for DtReflectedGenericObject:
+ Collaboration diagram for DtReflectedGenericObject:

Public Member Functions

 DtReflectedGenericObject (DtHlaObject *obj, DtExerciseConn *conn)
 constructor
virtual ~DtReflectedGenericObject ()
 destructor
virtual DtGenericStateRepositorygenericStateRep () const
 Returns a pointer to the DtGenericStateRepository, through which you can inspect current state information.
virtual DtGenericStateRepositorygsr () const
 Synonym for genericStateRep().
virtual DtReflectedGenericObjectnext () const
 Functions to get the next and previous objects in the list.
virtual DtReflectedGenericObjectprev () const
virtual DtReflectedGenericObjectwrapNext () const
 Return next (previous) elements on the list, but wrap to the beginning (end) of the list when you hit the end (beginning).
virtual DtReflectedGenericObjectwrapPrev () const
virtual void addPostUpdateCallback (DtGenericObjectCallbackFunction cb, void *userData)
 Registration/deregistration of postUpdate callbacks.
virtual void removePostUpdateCallback (DtGenericObjectCallbackFunction 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 DtStateRepositorystateRep () const
 Returns a pointer to the StateRepository - through which you can inspect current state information.
virtual DtStateRepositorysr () const
 Synonym for stateRep().
virtual DtHlaStateDecoderdecoder ()
 Returns a pointer to the Decoder being used to decode state messages into our SR.
virtual DtHlaObjectWithStateRephlaObject () const
 Get the entity's hlaObject (DtHlaObjectWithStateRep is derived from DtHlaObject).
virtual const DtObjectIdobjectId () const
 Get the HLA object's id.
virtual const DtObjectIdid () const
 Get the HLA object's id (local ID).
virtual const DtObjectIdlocalId () const
 Get the HLA object's id (local ID).
virtual const DtStringname () 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 DtStringlastProducingFederate () 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 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.
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.

Protected Member Functions

 DtReflectedGenericObject (const DtReflectedGenericObject &other)
 Copy Ctor – Not Implemented.
DtReflectedGenericObjectoperator= (const DtReflectedGenericObject &other)
 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.

Additional Inherited Members

- Public Types inherited from DtReflectedObject
typedef DtStateRepository *(* DtBaseStateRepCreator )()
 Function prototype for functions that create DtStateRepositories.
- 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
DtExerciseConnmyExConn
DtHlaObjectWithStateRepmyHlaObj
DtStateRepositorymyStateRep
DtHlaStateDecodermyDecoder
bool myRequestCbRegistered
DtIntrusiveList myStateUpdateCallbacks
DtObjectId myId
DtString myName

Detailed Description

Instances of DtReflectedGenericObject are used to represent "GenericObject" objects simulated remotely, that we hear about through the RTI.

Instances are created and deleted automatically by DtReflectedGenericObjectList in response to discover and remove RTI service invocations. This class is derived from DtDtReflectedObject, which does most of the work. The derived class mostly exists to provide type safety, and to configure the base class object.

Constructor & Destructor Documentation

DtReflectedGenericObject::DtReflectedGenericObject ( DtHlaObject obj,
DtExerciseConn conn 
)

constructor

virtual DtReflectedGenericObject::~DtReflectedGenericObject ( )
virtual

destructor

DtReflectedGenericObject::DtReflectedGenericObject ( const DtReflectedGenericObject other)
protected

Copy Ctor – Not Implemented.

Member Function Documentation

virtual void DtReflectedGenericObject::addPostUpdateCallback ( DtGenericObjectCallbackFunction  cb,
void *  userData 
)
virtual

Registration/deregistration of postUpdate callbacks.

virtual DtGenericStateRepository* DtReflectedGenericObject::genericStateRep ( ) const
virtual

Returns a pointer to the DtGenericStateRepository, through which you can inspect current state information.

virtual DtGenericStateRepository* DtReflectedGenericObject::gsr ( ) const
virtual

Synonym for genericStateRep().

virtual DtReflectedGenericObject* DtReflectedGenericObject::next ( ) const
virtual

Functions to get the next and previous objects in the list.

The "wrap" functions cycle to the beginning/end of the list.

Reimplemented from DtListedObj.

DtReflectedGenericObject& DtReflectedGenericObject::operator= ( const DtReflectedGenericObject other)
protected

Assignment Operator – Not Implemented.

virtual DtReflectedGenericObject* DtReflectedGenericObject::prev ( ) const
virtual

Reimplemented from DtListedObj.

virtual void DtReflectedGenericObject::removePostUpdateCallback ( DtGenericObjectCallbackFunction  cb,
void *  userData 
)
virtual
virtual DtReflectedGenericObject* DtReflectedGenericObject::wrapNext ( ) const
virtual

Return next (previous) elements on the list, but wrap to the beginning (end) of the list when you hit the end (beginning).

Only returns NULL when the list is totally empty.

Reimplemented from DtListedObj.

virtual DtReflectedGenericObject* DtReflectedGenericObject::wrapPrev ( ) const
virtual

Reimplemented from DtListedObj.


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)