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
DtReflectedArealObject Class Reference

Instances of DtReflectedArealObject represent Areal Objects simulated by remote applications. More...

+ Inheritance diagram for DtReflectedArealObject:
+ Collaboration diagram for DtReflectedArealObject:

Public Types

typedef DtArealObjectRepository *(* DtStateRepCreator )()
 Function prototype for functions that create DtArealObjectRepositories.

Public Member Functions

 DtReflectedArealObject (DtExerciseConn *conn, const DtEntityIdentifier &id)
 Constructor.
virtual ~DtReflectedArealObject ()
 Destructor.
virtual DtArealObjectRepositoryarealObjectStateRep () const
 Get the areal object's state repository.
virtual DtArealObjectRepositoryaosr () const
 Synonym for arealObjectStateRep().
virtual DtStateRepositorystateRep () const
 Returns a pointer to the StateRepository through which you can inspect current state information.
virtual void processStateMessage (const DtStateMsg &msg)
 Overrides the implementation of the base class.
virtual DtReflectedArealObjectnext () const
 Get the next remote areal object.
virtual DtReflectedArealObjectprev () const
 Get the previous remote areal object.
virtual DtReflectedArealObjectwrapNext () const
 Get the next remote areal object.
virtual DtReflectedArealObjectwrapPrev () const
 Get the previous remote areal object.
virtual void addPostUpdateCallback (DtArealObjectCallbackFunction cb, void *usr)
 areal object state callback registration/deregistration.
virtual void removePostUpdateCallback (DtArealObjectCallbackFunction cb, void *usr)
virtual const DtBaseHashKeyhashKey () const
 Get a hash key for this object.
virtual DtString idString () const
 Get a string identification of this object.
virtual const
DtGlobalObjectDesignator
globalId () const
 Get the areal object entityId.
- Public Member Functions inherited from DtReflectedObject
 DtReflectedObject (DtExerciseConn *conn)
 constructor
virtual ~DtReflectedObject ()
 destructor
virtual DtStateRepositorysr () const
 Synonym for stateRep().
virtual DtTime lastTimeUpdated () const
 Returns the value of wallclock time at the time an update was last received for the entity.
virtual DtTime lastSimTimeUpdated () const
 Returns the value of sim time at the time an update was last received for the entity.
virtual DtTime lastReceivedTimeStamp () const
 Returns the value in seconds past the hour of the timeStamp from the last received PDU.
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.
- Public Member Functions inherited from DtListedObj
 DtListedObj ()
 Constructor.
virtual ~DtListedObj ()
 Destructor.

Static Public Member Functions

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

Protected Member Functions

 DtReflectedArealObject (const DtReflectedArealObject &)
 Copy constructor - not implemented.
DtReflectedArealObjectoperator= (const DtReflectedArealObject &)
 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.

Protected Attributes

DtEntityIdentifierHashKey myHashKey
DtString myIdString
DtArealObjectRepositorymyStateRepository
DtArealObjectDecodermyDecoder
- 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

Instances of DtReflectedArealObject represent Areal Objects simulated by remote applications.

State data can be viewed through its state repository.

Member Typedef Documentation

typedef DtArealObjectRepository*(* DtReflectedArealObject::DtStateRepCreator)()

Function prototype for functions that create DtArealObjectRepositories.

Constructor & Destructor Documentation

DtReflectedArealObject::DtReflectedArealObject ( DtExerciseConn conn,
const DtEntityIdentifier id 
)

Constructor.

virtual DtReflectedArealObject::~DtReflectedArealObject ( )
virtual

Destructor.

DtReflectedArealObject::DtReflectedArealObject ( const DtReflectedArealObject )
protected

Copy constructor - not implemented.

Member Function Documentation

virtual void DtReflectedArealObject::addPostUpdateCallback ( DtArealObjectCallbackFunction  cb,
void *  usr 
)
virtual

areal object state callback registration/deregistration.

virtual DtArealObjectRepository* DtReflectedArealObject::aosr ( ) const
inlinevirtual

Synonym for arealObjectStateRep().

virtual DtArealObjectRepository* DtReflectedArealObject::arealObjectStateRep ( ) const
inlinevirtual

Get the areal object's state repository.

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

Get the areal object entityId.

For DIS, it's the same as its DtEntityIdentifier.

Implements DtReflectedObject.

virtual const DtBaseHashKey& DtReflectedArealObject::hashKey ( ) const
inlinevirtual

Get a hash key for this object.

Implements DtReflectedObject.

virtual DtString DtReflectedArealObject::idString ( ) const
inlinevirtual

Get a string identification of this object.

Implements DtReflectedObject.

virtual DtReflectedArealObject* DtReflectedArealObject::next ( ) const
virtual

Get the next remote areal object.

Reimplemented from DtListedObj.

DtReflectedArealObject& DtReflectedArealObject::operator= ( const DtReflectedArealObject )
protected

Assignment operator - not implemented.

virtual DtReflectedArealObject* DtReflectedArealObject::prev ( ) const
virtual

Get the previous remote areal object.

Reimplemented from DtListedObj.

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

Overrides the implementation of the base class.

Processes an areal object PDU.

Reimplemented from DtReflectedObject.

virtual void DtReflectedArealObject::removePostUpdateCallback ( DtArealObjectCallbackFunction  cb,
void *  usr 
)
virtual
static void DtReflectedArealObject::setStateRepCreator ( DtStateRepCreator  creator)
static

Give us a function to be used for creating SRs.

virtual DtStateRepository* DtReflectedArealObject::stateRep ( ) const
inlinevirtual

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

Implementation for abstract base class.

Implements DtReflectedObject.

static DtStateRepCreator DtReflectedArealObject::stateRepCreator ( )
static
virtual DtReflectedArealObject* DtReflectedArealObject::wrapNext ( ) const
virtual

Get the next remote areal object.

If at the end, it will cycle back to the first remote areal object.

Reimplemented from DtListedObj.

virtual DtReflectedArealObject* DtReflectedArealObject::wrapPrev ( ) const
virtual

Get the previous remote areal object.

If at the beginning, it will cycle back to the last remote areal object.

Reimplemented from DtListedObj.

Member Data Documentation

DtArealObjectDecoder* DtReflectedArealObject::myDecoder
protected
DtEntityIdentifierHashKey DtReflectedArealObject::myHashKey
protected
DtString DtReflectedArealObject::myIdString
protected
DtArealObjectRepository* DtReflectedArealObject::myStateRepository
protected
DtStateRepCreator DtReflectedArealObject::theStateRepCreator
staticprotected

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

Document ID: Generated on Mon Jun 22 21:18:40 EDT 2020 from SVN revision 213785
Copyright © 2005-2018 MAK Technologies. All Rights Reserved (www.mak.com)