VR-Link API Documentation for HLA Evolved
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes
DtReflectedVRLinkState Class Reference

Instances of DtReflectedVRLinkState are used to represent a simulated VRLinkState object reflected across a network. More...

+ Inheritance diagram for DtReflectedVRLinkState:
+ Collaboration diagram for DtReflectedVRLinkState:

Public Types

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

Public Member Functions

 DtReflectedVRLinkState (DtHlaObject *obj, DtExerciseConn *exConn)
 Constructor. More...
 
virtual ~DtReflectedVRLinkState ()
 Destructor. More...
 
virtual
DtVRLinkStateStateRepository
vrlinkStateStateRep () const
 Returns the VRLinkState's state repository. More...
 
virtual
DtVRLinkStateStateRepository
vsr () const
 Shorter version of lifeformRep. More...
 
virtual DtReflectedVRLinkStatenext () const
 Returns the next reflected VRLinkState in the DtReflectedVRLinkStateList. More...
 
virtual DtReflectedVRLinkStateprev () const
 Returns the previous reflected VRLinkState in the DtReflectedVRLinkStateList. More...
 
virtual DtReflectedVRLinkStatewrapNext () const
 Returns the next reflected VRLinkState. More...
 
virtual DtReflectedVRLinkStatewrapPrev () const
 Returns the previous reflected VRLinkState. More...
 
virtual void addPostUpdateCallback (DtVRLinkStateCallbackFunction cb, void *userData)
 Add a callback that is called when the DtReflectedVRLinkState is updated. More...
 
virtual void removePostUpdateCallback (DtVRLinkStateCallbackFunction cb, void *userData)
 Remove the callback that is called when the DtReflectedVRLinkState is updated. More...
 
- Public Member Functions inherited from DtReflectedObject
 DtReflectedObject (DtExerciseConn *conn, DtStateRepository *stateRep)
 Primary constructor. More...
 
 DtReflectedObject (DtHlaObject *obj, DtExerciseConn *conn, DtBaseStateRepCreator creator)
 Older constructor. More...
 
 DtReflectedObject (const DtObjectId &id, const DtGlobalObjectDesignator &des, DtExerciseConn *conn, DtBaseStateRepCreator creator)
 Older constructor. More...
 
virtual ~DtReflectedObject ()
 destructor More...
 
virtual DtStateRepositorystateRep () const
 Returns a pointer to the StateRepository - through which you can inspect current state information. More...
 
virtual DtStateRepositorysr () const
 Synonym for stateRep(). More...
 
virtual DtHlaStateDecoderdecoder ()
 Returns a pointer to the Decoder being used to decode state messages into our SR. More...
 
virtual DtHlaObjectWithStateRephlaObject () const
 Get the entity's hlaObject (DtHlaObjectWithStateRep is derived from DtHlaObject). More...
 
virtual const DtObjectIdobjectId () const
 Get the HLA object's id. More...
 
virtual const DtObjectIdid () const
 Get the HLA object's id (local ID). More...
 
virtual const DtObjectIdlocalId () const
 Get the HLA object's id (local ID). More...
 
virtual const DtStringname () const
 Get the HLA object name. More...
 
virtual const
DtGlobalObjectDesignator
globalId () const
 Get the HLA object's global object designator - the object name in HLA. More...
 
virtual const DtStringlastProducingFederate () const
 Get the name of the last federate that produced a reflected update. More...
 
virtual DtTime lastSimTimeUpdated () const
 Returns the value of simulation time at the time an update was last received for the entity. More...
 
virtual DtTime lastReceivedTimeStamp () const
 Returns the value of the time send in the last Update received for this entity. More...
 
virtual void baseAddPostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData)
 Object state callback registration/deregistration. More...
 
virtual void baseRemovePostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData)
 
virtual DtReflectedObjectnextObj () const
 Get the next remote object. More...
 
virtual DtReflectedObjectprevObj () const
 Get the previous remote object. More...
 
virtual DtReflectedObjectwrapNextObj () const
 Get the next remote object. More...
 
virtual DtReflectedObjectwrapPrevObj () const
 Get the previous remote object. More...
 
void setHlaObject (DtHlaObject *obj, DtHlaStateDecoder *decoder=NULL)
 Start reflecting this object, using this decoder. More...
 
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. More...
 
void detachHlaObject ()
 Ends managing of current HLA object. More...
 
virtual void requestUpdate ()
 Request that the owner of this entity send an attribute update. More...
 
virtual DtTime keyTime () const
 Set/Get the time value used with ID to define a map key Key is used to store objects by time but still allow index by ID (using this keyTime) More...
 
virtual void setKeyTime (DtTime timeValue)
 Set/Get the time value used with ID to define a map key Key is used to store objects by time but still allow index by ID (using this keyTime) More...
 

Static Public Member Functions

static DtStateRepCreator setStateRepCreator (DtStateRepCreator creator)
 Set the function to be called for creating state repositories. More...
 

Protected Member Functions

 DtReflectedVRLinkState (const DtReflectedVRLinkState &orig)
 Copy Constructor not implemented. More...
 
DtReflectedVRLinkStateoperator= (const DtReflectedVRLinkState &orig)
 Assignment operator not implemented. More...
 
- Protected Member Functions inherited from DtReflectedObject
 DtReflectedObject (const DtReflectedObject &orig)
 copy constructor – Not Implemented More...
 
DtReflectedObjectoperator= (const DtReflectedObject &orig)
 assignment operator – Not Implemented More...
 
virtual void processPostUpdateCallbacks ()
 Process the post update callbacks. More...
 

Static Protected Attributes

static DtStateRepCreator theStateRepCreator
 The function called to create state repositories. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from DtReflectedObject
static void processPostUpdateCallbacksCb (const DtStateMsg &stateMsg, DtHlaObject *obj, void *usr)
 Callback from HlaObject to process post update callbacks. More...
 
- Protected Attributes inherited from DtReflectedObject
DtExerciseConnmyExConn
 
DtHlaObjectWithStateRepmyHlaObj
 
DtStateRepositorymyStateRep
 
DtHlaStateDecodermyDecoder
 
DtIntrusiveList myStateUpdateCallbacks
 
DtObjectId myId
 
DtString myName
 
DtTime myKeyTime
 
DtRefHlaObjectMap::iterator myReflIterator
 
DtRefHlaObjectMapmyReflMap
 

Detailed Description

Instances of DtReflectedVRLinkState are used to represent a simulated VRLinkState object reflected across a network.

Member Typedef Documentation

typedef DtVRLinkStateStateRepository*(* DtReflectedVRLinkState::DtStateRepCreator)()

Function prototype for functions that create a DtVRLinkStateStateRepository.

Constructor & Destructor Documentation

DtReflectedVRLinkState::DtReflectedVRLinkState ( DtHlaObject obj,
DtExerciseConn exConn 
)

Constructor.

virtual DtReflectedVRLinkState::~DtReflectedVRLinkState ( )
virtual

Destructor.

DtReflectedVRLinkState::DtReflectedVRLinkState ( const DtReflectedVRLinkState orig)
protected

Copy Constructor not implemented.

Member Function Documentation

virtual void DtReflectedVRLinkState::addPostUpdateCallback ( DtVRLinkStateCallbackFunction  cb,
void *  userData 
)
virtual

Add a callback that is called when the DtReflectedVRLinkState is updated.

virtual DtReflectedVRLinkState* DtReflectedVRLinkState::next ( ) const
virtual

Returns the next reflected VRLinkState in the DtReflectedVRLinkStateList.

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

Assignment operator not implemented.

virtual DtReflectedVRLinkState* DtReflectedVRLinkState::prev ( ) const
virtual

Returns the previous reflected VRLinkState in the DtReflectedVRLinkStateList.

virtual void DtReflectedVRLinkState::removePostUpdateCallback ( DtVRLinkStateCallbackFunction  cb,
void *  userData 
)
virtual

Remove the callback that is called when the DtReflectedVRLinkState is updated.

static DtStateRepCreator DtReflectedVRLinkState::setStateRepCreator ( DtStateRepCreator  creator)
static

Set the function to be called for creating state repositories.

DtVRLinkStateStateRepository * DtReflectedVRLinkState::vrlinkStateStateRep ( ) const
inlinevirtual

Returns the VRLinkState's state repository.

References DtReflectedObject::myStateRep.

DtVRLinkStateStateRepository * DtReflectedVRLinkState::vsr ( ) const
inlinevirtual

Shorter version of lifeformRep.

References DtReflectedObject::myStateRep.

virtual DtReflectedVRLinkState* DtReflectedVRLinkState::wrapNext ( ) const
virtual

Returns the next reflected VRLinkState.

Will cycle back to the first remote VRLinkState in the DtReflectedVRLinkStateList.

virtual DtReflectedVRLinkState* DtReflectedVRLinkState::wrapPrev ( ) const
virtual

Returns the previous reflected VRLinkState.

Will cycle back to the first remote VRLinkState in the DtReflectedVRLinkStateList.

Member Data Documentation

DtStateRepCreator DtReflectedVRLinkState::theStateRepCreator
staticprotected

The function called to create state repositories.


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

Document ID: Generated on Mon Apr 25 03:39:01 EDT 2022 from SVN revision 242502
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)