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

Instances of DtReflectedActiveSonar represent active sonar object simulated by remote applications. More...

+ Inheritance diagram for DtReflectedActiveSonar:
+ Collaboration diagram for DtReflectedActiveSonar:

Public Types

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

Public Member Functions

 DtReflectedActiveSonar (DtExerciseConn *conn, const DtGlobalObjectDesignator &hostEntity, int acousticId)
 Constructor. More...
 
virtual ~DtReflectedActiveSonar ()
 Destructor. More...
 
virtual
DtActiveSonarStateRepository
activeSonarRep () const
 Get the sonar's state repository. More...
 
virtual
DtActiveSonarStateRepository
asr () const
 Synonym for activeSonarRep(). More...
 
virtual DtStateRepositorystateRep () const
 Returns a pointer to the StateRepository through which you can inspect current state information. More...
 
virtual DtActiveSonarDecoderdecoder ()
 Returns a pointer to the Decoder being used to decode state messages. More...
 
virtual void processStateMessage (const DtStateMsg &msg)
 Overrides the implementation of the base class. More...
 
virtual DtReflectedActiveSonarnext () const
 Get the next active sonar. More...
 
virtual DtReflectedActiveSonarprev () const
 Get the previous active sonar. More...
 
virtual DtReflectedActiveSonarwrapNext () const
 Get the next active sonar. More...
 
virtual DtReflectedActiveSonarwrapPrev () const
 Get the previous active sonar. More...
 
virtual void addPostUpdateCallback (DtActiveSonarCallbackFunction cb, void *userData)
 Active sonar state callback registration/deregistration. More...
 
virtual void removePostUpdateCallback (DtActiveSonarCallbackFunction cb, void *userData)
 
virtual const DtBaseHashKeyhashKey () const
 Get a hash key for this object. More...
 
virtual DtString idString () const
 Get a string identification of this object. More...
 
virtual const
DtGlobalObjectDesignator
globalId () const
 Get the acitve sonar entityId. 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 ()
 

Protected Member Functions

 DtReflectedActiveSonar (const DtReflectedActiveSonar &)
 Copy constructor - not implemented. More...
 
DtReflectedActiveSonaroperator= (const DtReflectedActiveSonar &)
 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

DtSystemHashKey myHashKey
 
DtString myIdString
 
DtActiveSonarStateRepositorymyStateRepository
 
DtActiveSonarDecoder 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 DtReflectedActiveSonar represent active sonar object simulated by remote applications.

State data can be viewed through its state repository.

Member Typedef Documentation

typedef DtActiveSonarStateRepository*(* DtReflectedActiveSonar::DtStateRepCreator)()

Function prototype for functions that create DtActiveSonarStateRepository.

Constructor & Destructor Documentation

DtReflectedActiveSonar::DtReflectedActiveSonar ( DtExerciseConn conn,
const DtGlobalObjectDesignator hostEntity,
int  acousticId 
)

Constructor.

virtual DtReflectedActiveSonar::~DtReflectedActiveSonar ( )
virtual

Destructor.

DtReflectedActiveSonar::DtReflectedActiveSonar ( const DtReflectedActiveSonar )
protected

Copy constructor - not implemented.

Member Function Documentation

virtual DtActiveSonarStateRepository* DtReflectedActiveSonar::activeSonarRep ( ) const
inlinevirtual

Get the sonar's state repository.

virtual void DtReflectedActiveSonar::addPostUpdateCallback ( DtActiveSonarCallbackFunction  cb,
void *  userData 
)
virtual

Active sonar state callback registration/deregistration.

virtual DtActiveSonarStateRepository* DtReflectedActiveSonar::asr ( ) const
inlinevirtual

Synonym for activeSonarRep().

virtual DtActiveSonarDecoder* DtReflectedActiveSonar::decoder ( )
inlinevirtual

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

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

Get the acitve sonar entityId.

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

Implements DtReflectedObject.

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

Get a hash key for this object.

Implements DtReflectedObject.

virtual DtString DtReflectedActiveSonar::idString ( ) const
inlinevirtual

Get a string identification of this object.

Implements DtReflectedObject.

virtual DtReflectedActiveSonar* DtReflectedActiveSonar::next ( ) const
virtual

Get the next active sonar.

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

Assignment operator - not implemented.

virtual DtReflectedActiveSonar* DtReflectedActiveSonar::prev ( ) const
virtual

Get the previous active sonar.

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

Overrides the implementation of the base class.

Processes an Underwater Acoustic PDU.

Reimplemented from DtReflectedObject.

virtual void DtReflectedActiveSonar::removePostUpdateCallback ( DtActiveSonarCallbackFunction  cb,
void *  userData 
)
virtual
static void DtReflectedActiveSonar::setStateRepCreator ( DtStateRepCreator  creator)
static

Give us a function to be used for creating SRs.

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

Get the next active sonar.

If at the end, it will cycle back to the first active sonar.

virtual DtReflectedActiveSonar* DtReflectedActiveSonar::wrapPrev ( ) const
virtual

Get the previous active sonar.

If at the beginning, it will cycle back to the last active sonar.

Member Data Documentation

DtActiveSonarDecoder DtReflectedActiveSonar::myDecoder
protected
DtSystemHashKey DtReflectedActiveSonar::myHashKey
protected
DtString DtReflectedActiveSonar::myIdString
protected
DtActiveSonarStateRepository* DtReflectedActiveSonar::myStateRepository
protected
DtStateRepCreator DtReflectedActiveSonar::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)