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

Instances of DtReflectedUnderwaterAcoustics represent underwater acoustics objects simulated by remote applications. More...

+ Inheritance diagram for DtReflectedUnderwaterAcoustics:
+ Collaboration diagram for DtReflectedUnderwaterAcoustics:

Public Types

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

Public Member Functions

 DtReflectedUnderwaterAcoustics (DtExerciseConn *conn, const DtGlobalObjectDesignator &hostEntity)
 Constructor. More...
 
virtual ~DtReflectedUnderwaterAcoustics ()
 Destructor. More...
 
virtual
DtUnderwaterAcousticsStateRepository
underwaterAcousticsStateRep () const
 Get the underwater acoustic object's state repository. More...
 
virtual
DtUnderwaterAcousticsStateRepository
usr () const
 Synonym for underwaterAcousticsStateRep(). More...
 
virtual DtStateRepositorystateRep () const
 Returns a pointer to the StateRepository through which you can inspect current state information. More...
 
virtual
DtUnderwaterAcousticsDecoder
decoder ()
 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
DtReflectedUnderwaterAcoustics
next () const
 Get the next underwater acoustics. More...
 
virtual
DtReflectedUnderwaterAcoustics
prev () const
 Get the previous underwater acoustics. More...
 
virtual
DtReflectedUnderwaterAcoustics
wrapNext () const
 Get the next underwater acoustics. More...
 
virtual
DtReflectedUnderwaterAcoustics
wrapPrev () const
 Get the previous underwater acoustics. More...
 
virtual void addPostUpdateCallback (DtUnderwaterAcousticsCallbackFunction cb, void *usr)
 Underwater acoustics state callback registration/deregistration. More...
 
virtual void removePostUpdateCallback (DtUnderwaterAcousticsCallbackFunction cb, void *usr)
 
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 underwater acoustics 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

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

DtObjectIdHashKey myHashKey
 
DtString myIdString
 
DtUnderwaterAcousticsStateRepositorymyStateRepository
 
DtUnderwaterAcousticsDecoder 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 DtReflectedUnderwaterAcoustics represent underwater acoustics objects simulated by remote applications.

State data can be viewed through its state repository.

Member Typedef Documentation

typedef DtUnderwaterAcousticsStateRepository*(* DtReflectedUnderwaterAcoustics::DtStateRepCreator)()

Function prototype for functions that create DtUnderwaterAcousticsStateRepository.

Constructor & Destructor Documentation

DtReflectedUnderwaterAcoustics::DtReflectedUnderwaterAcoustics ( DtExerciseConn conn,
const DtGlobalObjectDesignator hostEntity 
)

Constructor.

virtual DtReflectedUnderwaterAcoustics::~DtReflectedUnderwaterAcoustics ( )
virtual

Destructor.

DtReflectedUnderwaterAcoustics::DtReflectedUnderwaterAcoustics ( const DtReflectedUnderwaterAcoustics )
protected

Copy constructor - not implemented.

Member Function Documentation

virtual void DtReflectedUnderwaterAcoustics::addPostUpdateCallback ( DtUnderwaterAcousticsCallbackFunction  cb,
void *  usr 
)
virtual

Underwater acoustics state callback registration/deregistration.

virtual DtUnderwaterAcousticsDecoder* DtReflectedUnderwaterAcoustics::decoder ( )
inlinevirtual

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

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

Get the underwater acoustics entityId.

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

Implements DtReflectedObject.

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

Get a hash key for this object.

Implements DtReflectedObject.

virtual DtString DtReflectedUnderwaterAcoustics::idString ( ) const
inlinevirtual

Get a string identification of this object.

Implements DtReflectedObject.

virtual DtReflectedUnderwaterAcoustics* DtReflectedUnderwaterAcoustics::next ( ) const
virtual

Get the next underwater acoustics.

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

Assignment operator - not implemented.

virtual DtReflectedUnderwaterAcoustics* DtReflectedUnderwaterAcoustics::prev ( ) const
virtual

Get the previous underwater acoustics.

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

Overrides the implementation of the base class.

Processes an Underwater Acoustic PDU.

Reimplemented from DtReflectedObject.

virtual void DtReflectedUnderwaterAcoustics::removePostUpdateCallback ( DtUnderwaterAcousticsCallbackFunction  cb,
void *  usr 
)
virtual
static void DtReflectedUnderwaterAcoustics::setStateRepCreator ( DtStateRepCreator  creator)
static

Give us a function to be used for creating SRs.

virtual DtStateRepository* DtReflectedUnderwaterAcoustics::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 DtReflectedUnderwaterAcoustics::stateRepCreator ( )
static
virtual DtUnderwaterAcousticsStateRepository* DtReflectedUnderwaterAcoustics::underwaterAcousticsStateRep ( ) const
inlinevirtual

Get the underwater acoustic object's state repository.

virtual DtUnderwaterAcousticsStateRepository* DtReflectedUnderwaterAcoustics::usr ( ) const
inlinevirtual
virtual DtReflectedUnderwaterAcoustics* DtReflectedUnderwaterAcoustics::wrapNext ( ) const
virtual

Get the next underwater acoustics.

If at the end, it will cycle back to the first underwater acoustics.

virtual DtReflectedUnderwaterAcoustics* DtReflectedUnderwaterAcoustics::wrapPrev ( ) const
virtual

Get the previous underwater acoustics.

If at the beginning, it will cycle back to the last underwater acoustics.

Member Data Documentation

DtUnderwaterAcousticsDecoder DtReflectedUnderwaterAcoustics::myDecoder
protected
DtObjectIdHashKey DtReflectedUnderwaterAcoustics::myHashKey
protected
DtString DtReflectedUnderwaterAcoustics::myIdString
protected
DtUnderwaterAcousticsStateRepository* DtReflectedUnderwaterAcoustics::myStateRepository
protected
DtStateRepCreator DtReflectedUnderwaterAcoustics::theStateRepCreator
staticprotected

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

Document ID: Generated on Tue Feb 2 21:02:17 EST 2021 from SVN revision 223668
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)