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

Instances of DtReflectedLinearObject represent Linear Object simulated by remote applications. More...

+ Inheritance diagram for DtReflectedLinearObject:
+ Collaboration diagram for DtReflectedLinearObject:

Public Types

typedef
DtLinearObjectRepository *(* 
DtStateRepCreator )()
 Function prototype for functions that create DtLinearObjectRepositories.

Public Member Functions

 DtReflectedLinearObject (DtExerciseConn *conn, const DtEntityIdentifier &id)
 Constructor.
virtual ~DtReflectedLinearObject ()
 Destructor.
virtual DtLinearObjectRepositorylinearObjectStateRep () const
 Get the linear object's state repository.
virtual DtLinearObjectRepositorylosr () const
 Synonym for linearObjectStateRep().
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 DtReflectedLinearObjectnext () const
 Get the next remote linear object.
virtual DtReflectedLinearObjectprev () const
 Get the previous remote linear object.
virtual DtReflectedLinearObjectwrapNext () const
 Get the next remote linear object.
virtual DtReflectedLinearObjectwrapPrev () const
 Get the previous remote linear object.
virtual void addPostUpdateCallback (DtLinearObjectCallbackFunction cb, void *usr)
 linear object state callback registration/deregistration.
virtual void removePostUpdateCallback (DtLinearObjectCallbackFunction 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 linear 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

 DtReflectedLinearObject (const DtReflectedLinearObject &)
 Copy constructor - not implemented.
DtReflectedLinearObjectoperator= (const DtReflectedLinearObject &)
 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
DtLinearObjectRepositorymyStateRepository
DtLinearObjectDecoder myDecoder
- 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 DtReflectedLinearObject represent Linear Object simulated by remote applications.

State data can be viewed through its state repository.

Member Typedef Documentation

typedef DtLinearObjectRepository*(* DtReflectedLinearObject::DtStateRepCreator)()

Function prototype for functions that create DtLinearObjectRepositories.

Constructor & Destructor Documentation

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

Constructor.

virtual DtReflectedLinearObject::~DtReflectedLinearObject ( )
virtual

Destructor.

DtReflectedLinearObject::DtReflectedLinearObject ( const DtReflectedLinearObject )
protected

Copy constructor - not implemented.

Member Function Documentation

virtual void DtReflectedLinearObject::addPostUpdateCallback ( DtLinearObjectCallbackFunction  cb,
void *  usr 
)
virtual

linear object state callback registration/deregistration.

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

Get the linear object entityId.

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

Implements DtReflectedObject.

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

Get a hash key for this object.

Implements DtReflectedObject.

virtual DtString DtReflectedLinearObject::idString ( ) const
inlinevirtual

Get a string identification of this object.

Implements DtReflectedObject.

virtual DtLinearObjectRepository* DtReflectedLinearObject::linearObjectStateRep ( ) const
inlinevirtual

Get the linear object's state repository.

virtual DtLinearObjectRepository* DtReflectedLinearObject::losr ( ) const
inlinevirtual

Synonym for linearObjectStateRep().

virtual DtReflectedLinearObject* DtReflectedLinearObject::next ( ) const
virtual

Get the next remote linear object.

Reimplemented from DtListedObj.

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

Assignment operator - not implemented.

virtual DtReflectedLinearObject* DtReflectedLinearObject::prev ( ) const
virtual

Get the previous remote linear object.

Reimplemented from DtListedObj.

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

Overrides the implementation of the base class.

Processes a linear object PDU.

Reimplemented from DtReflectedObject.

virtual void DtReflectedLinearObject::removePostUpdateCallback ( DtLinearObjectCallbackFunction  cb,
void *  usr 
)
virtual
static void DtReflectedLinearObject::setStateRepCreator ( DtStateRepCreator  creator)
static

Give us a function to be used for creating SRs.

virtual DtStateRepository* DtReflectedLinearObject::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 DtReflectedLinearObject::stateRepCreator ( )
static
virtual DtReflectedLinearObject* DtReflectedLinearObject::wrapNext ( ) const
virtual

Get the next remote linear object.

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

Reimplemented from DtListedObj.

virtual DtReflectedLinearObject* DtReflectedLinearObject::wrapPrev ( ) const
virtual

Get the previous remote linear object.

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

Reimplemented from DtListedObj.

Member Data Documentation

DtLinearObjectDecoder DtReflectedLinearObject::myDecoder
protected
DtEntityIdentifierHashKey DtReflectedLinearObject::myHashKey
protected
DtString DtReflectedLinearObject::myIdString
protected
DtLinearObjectRepository* DtReflectedLinearObject::myStateRepository
protected
DtStateRepCreator DtReflectedLinearObject::theStateRepCreator
staticprotected

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

Document ID: Generated on Wed Jan 7 13:31:29 EST 2015 from SVN revision 149162
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)