VR-Link API Documentation for DIS
 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 | Protected Attributes | Static Protected Attributes
DtReflectedEnvironmentProcess Class Reference

The DtReflectedObject instance for an Environmental Process Object. More...

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

Public Types

typedef
DtEnvironmentProcessRepository *(* 
DtStateRepCreator )()
 Function prototype for functions that create DtEnvironmentProcessRepositories. More...
 

Public Member Functions

 DtReflectedEnvironmentProcess (DtExerciseConn *conn, const DtEntityIdentifier &id, const DtEntityType &type)
 constructor More...
 
virtual ~DtReflectedEnvironmentProcess ()
 destructor More...
 
virtual
DtEnvironmentProcessRepository
environmentProcessStateRep () const
 Returns ptr to environmentProcessStateRepository – through which you can inspect current state info. More...
 
virtual
DtEnvironmentProcessRepository
epsr () const
 Synonym for environmentStateRep. More...
 
virtual DtStateRepositorystateRep () const
 Implementation for abstract base class. Calls epsr(). More...
 
virtual
DtEnvironmentProcessDecoder
decoder ()
 Returns a pointer to the Decoder being used to decode state messages into our EPSR. More...
 
virtual const DtEntityIdentifierentityId () const
 Returns the entity identifier. More...
 
virtual const DtObjectIdid () const
 Get the environment process's id. (For DIS, DtObjectId is DtEntityIdentifier). More...
 
virtual const DtObjectIdlocalId () const
 Get the environment process's local id. For DIS - same as id(). More...
 
virtual const
DtGlobalObjectDesignator
globalId () const
 Get the environment process's object's global object designator - for DIS, it's the same as its DtEntityIdentifier. More...
 
virtual void processStateMessage (const DtStateMsg &msg)
 Process an environment process state PDU. More...
 
virtual
DtReflectedEnvironmentProcess
next () const
 Get the next and previous elements in the reflected environment process list. More...
 
virtual
DtReflectedEnvironmentProcess
prev () const
 
virtual
DtReflectedEnvironmentProcess
wrapNext () const
 Get the next and previous elements, wrap at the ends of the list. More...
 
virtual
DtReflectedEnvironmentProcess
wrapPrev () const
 
virtual void addPostUpdateCallback (DtEnvironmentProcessCallbackFunction cb, void *userData)
 Environment Process callback registration/deregistration. More...
 
virtual void removePostUpdateCallback (DtEnvironmentProcessCallbackFunction cb, void *userData)
 
virtual const DtBaseHashKeyhashKey () const
 Get a hhash key for this object. More...
 
virtual DtString idString () const
 Get a string identification of this object. More...
 
virtual void processEnvironmentProcess (const DtEnvironmentalProcessPdu &pdu)
 Process an environmentalProcess PDU. More...
 
- Public Member Functions inherited from DtReflectedObject
 DtReflectedObject (DtExerciseConn *conn)
 constructor More...
 
virtual ~DtReflectedObject ()
 destructor More...
 
virtual DtStateRepositorysr () const
 Synonym for stateRep(). More...
 
virtual DtTime lastTimeUpdated () const
 Returns the value of wallclock time at the time an update was last received for the entity. More...
 
virtual DtTime lastSimTimeUpdated () const
 Returns the value of sim time at the time an update was last received for the entity. More...
 
virtual DtTime lastReceivedTimeStamp () const
 Returns the value in seconds past the hour of the timeStamp from the last received PDU. 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...
 
- Public Member Functions inherited from DtListedObj
 DtListedObj ()
 Constructor. More...
 
virtual ~DtListedObj ()
 Destructor. More...
 
void * next () const
 Return next (previous) elements on the list, or NULL if hit the end (beginning) of the list. More...
 
void * prev () const
 
void * wrapNext () const
 Return next (previous) elements on the list, but wrap to the beginning (end) of the list when you hit the end (beginning). More...
 
void * wrapPrev () const
 

Static Public Member Functions

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

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...
 

Protected Attributes

DtEntityIdentifier myId
 
DtEnvironmentProcessRepositorymyStateRep
 
DtEnvironmentProcessDecodermyDecoder
 
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

The DtReflectedObject instance for an Environmental Process Object.

Examples: Environmental Process Example

Member Typedef Documentation

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

Function prototype for functions that create DtEnvironmentProcessRepositories.

Constructor & Destructor Documentation

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

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

Environment Process callback registration/deregistration.

virtual DtEnvironmentProcessDecoder* DtReflectedEnvironmentProcess::decoder ( )
virtual

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

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

Returns the entity identifier.

virtual DtEnvironmentProcessRepository* DtReflectedEnvironmentProcess::environmentProcessStateRep ( ) const
virtual

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

virtual DtEnvironmentProcessRepository* DtReflectedEnvironmentProcess::epsr ( ) const
virtual

Synonym for environmentStateRep.

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

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

Implements DtReflectedObject.

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

Get a hhash key for this object.

Implements DtReflectedObject.

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

Get the environment process's id. (For DIS, DtObjectId is DtEntityIdentifier).

virtual DtString DtReflectedEnvironmentProcess::idString ( ) const
virtual

Get a string identification of this object.

Implements DtReflectedObject.

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

Get the environment process's local id. For DIS - same as id().

virtual DtReflectedEnvironmentProcess* DtReflectedEnvironmentProcess::next ( ) const
virtual

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

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

assignment operator – not implemented

virtual DtReflectedEnvironmentProcess* DtReflectedEnvironmentProcess::prev ( ) const
virtual
virtual void DtReflectedEnvironmentProcess::processEnvironmentProcess ( const DtEnvironmentalProcessPdu pdu)
virtual

Process an environmentalProcess PDU.

Also calls down to base class processStateMessage().

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

Process an environment process state PDU.

Calls processEnvironmentProcess().

Reimplemented from DtReflectedObject.

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

Give us a function to be used for creating SRs.

virtual DtStateRepository* DtReflectedEnvironmentProcess::stateRep ( ) const
virtual

Implementation for abstract base class. Calls epsr().

Implements DtReflectedObject.

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

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

virtual DtReflectedEnvironmentProcess* DtReflectedEnvironmentProcess::wrapPrev ( ) const
virtual

Member Data Documentation

DtEnvironmentProcessDecoder* DtReflectedEnvironmentProcess::myDecoder
protected
DtEntityIdentifierHashKey DtReflectedEnvironmentProcess::myHashKey
protected
DtEntityIdentifier DtReflectedEnvironmentProcess::myId
protected
DtEnvironmentProcessRepository* DtReflectedEnvironmentProcess::myStateRep
protected
DtStateRepCreator DtReflectedEnvironmentProcess::theStateRepCreator
staticprotected

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)