VR-Link API Documentation for HLA 1.3
 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
DtReflectedEnvironmentProcess Class Reference

Instances of DtReflectedEnvironmentProcess are used to represent an Instance of an EnvironmentProcess HLA Object which was published remotely. More...

+ Inheritance diagram for DtReflectedEnvironmentProcess:
+ Collaboration diagram for DtReflectedEnvironmentProcess:

Public Types

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

Public Member Functions

 DtReflectedEnvironmentProcess (DtHlaObject *obj, DtExerciseConn *conn)
 constructor More...
 
virtual ~DtReflectedEnvironmentProcess ()
 destructor More...
 
virtual
DtEnvironmentProcessRepository
environmentProcessStateRep () const
 Get the environmental process's state repository. More...
 
virtual
DtEnvironmentProcessRepository
epsr () const
 Synonym for environmentProcessRep(). More...
 
virtual
DtReflectedEnvironmentProcess
next () const
 Get the next remote environmental process. More...
 
virtual
DtReflectedEnvironmentProcess
prev () const
 Get the previous remote environmental process. More...
 
virtual
DtReflectedEnvironmentProcess
wrapNext () const
 Get the next remote environmental process. More...
 
virtual
DtReflectedEnvironmentProcess
wrapPrev () const
 Get the previous remote environmental process. More...
 
virtual void addPostUpdateCallback (DtEnvironmentProcessCallbackFunction cb, void *userData)
 Environmental process state callback registration/deregistration. More...
 
virtual void removePostUpdateCallback (DtEnvironmentProcessCallbackFunction cb, void *userData)
 
- 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 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)
 Give us a function to be used for creating SRs. More...
 

Protected Member Functions

 DtReflectedEnvironmentProcess (const DtReflectedEnvironmentProcess &orig)
 copy constructor – not implemented More...
 
DtReflectedEnvironmentProcessoperator= (const DtReflectedEnvironmentProcess &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
 

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 DtReflectedEnvironmentProcess are used to represent an Instance of an EnvironmentProcess HLA Object which was published remotely.

Examples: Environmental Process Example

Member Typedef Documentation

typedef DtEnvironmentProcessRepository*(* DtReflectedEnvironmentProcess::DtStateRepCreator)()

Function prototype for functions that create DtEnvironmentProcessRepositories.

Constructor & Destructor Documentation

DtReflectedEnvironmentProcess::DtReflectedEnvironmentProcess ( DtHlaObject obj,
DtExerciseConn conn 
)

constructor

virtual DtReflectedEnvironmentProcess::~DtReflectedEnvironmentProcess ( )
virtual

destructor

DtReflectedEnvironmentProcess::DtReflectedEnvironmentProcess ( const DtReflectedEnvironmentProcess orig)
protected

copy constructor – not implemented

Member Function Documentation

virtual void DtReflectedEnvironmentProcess::addPostUpdateCallback ( DtEnvironmentProcessCallbackFunction  cb,
void *  userData 
)
virtual

Environmental process state callback registration/deregistration.

DtEnvironmentProcessRepository * DtReflectedEnvironmentProcess::environmentProcessStateRep ( ) const
inlinevirtual

Get the environmental process's state repository.

References DtReflectedObject::myStateRep.

DtEnvironmentProcessRepository * DtReflectedEnvironmentProcess::epsr ( ) const
inlinevirtual

Synonym for environmentProcessRep().

References DtReflectedObject::myStateRep.

virtual DtReflectedEnvironmentProcess* DtReflectedEnvironmentProcess::next ( ) const
virtual

Get the next remote environmental process.

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

assignment operator – not implemented

virtual DtReflectedEnvironmentProcess* DtReflectedEnvironmentProcess::prev ( ) const
virtual

Get the previous remote environmental process.

virtual void DtReflectedEnvironmentProcess::removePostUpdateCallback ( DtEnvironmentProcessCallbackFunction  cb,
void *  userData 
)
virtual
static DtStateRepCreator DtReflectedEnvironmentProcess::setStateRepCreator ( DtStateRepCreator  creator)
static

Give us a function to be used for creating SRs.

virtual DtReflectedEnvironmentProcess* DtReflectedEnvironmentProcess::wrapNext ( ) const
virtual

Get the next remote environmental process.

Will cycle back to the first remote designator.

virtual DtReflectedEnvironmentProcess* DtReflectedEnvironmentProcess::wrapPrev ( ) const
virtual

Get the previous remote environmental process.

Will cycle back to the last remote designator.

Member Data Documentation

DtStateRepCreator DtReflectedEnvironmentProcess::theStateRepCreator
staticprotected

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

Document ID: Generated on Wed Mar 27 02:04:30 EDT 2024 from SVN revision 264570
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)