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.

Public Member Functions
	DtReflectedUnderwaterAcoustics (DtExerciseConn *conn, const DtGlobalObjectDesignator &hostEntity)
	Constructor.
virtual	~DtReflectedUnderwaterAcoustics ()
	Destructor.
virtual DtUnderwaterAcousticsStateRepository *	underwaterAcousticsStateRep () const
	Get the underwater acoustic object's state repository.
virtual DtUnderwaterAcousticsStateRepository *	usr () const
	Synonym for underwaterAcousticsStateRep().
virtual DtStateRepository *	stateRep () const
	Returns a pointer to the StateRepository through which you can inspect current state information.
virtual DtUnderwaterAcousticsDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode state messages.
virtual void	processStateMessage (const DtStateMsg &msg)
	Overrides the implementation of the base class.
virtual DtReflectedUnderwaterAcoustics *	next () const
	Get the next underwater acoustics.
virtual DtReflectedUnderwaterAcoustics *	prev () const
	Get the previous underwater acoustics.
virtual DtReflectedUnderwaterAcoustics *	wrapNext () const
	Get the next underwater acoustics.
virtual DtReflectedUnderwaterAcoustics *	wrapPrev () const
	Get the previous underwater acoustics.
virtual void	addPostUpdateCallback (DtUnderwaterAcousticsCallbackFunction cb, void *usr)
	Underwater acoustics state callback registration/deregistration.
virtual void	removePostUpdateCallback (DtUnderwaterAcousticsCallbackFunction cb, void *usr)
virtual const DtBaseHashKey &	hashKey () 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 underwater acoustics entityId.
Public Member Functions inherited from DtReflectedObject
	DtReflectedObject (DtExerciseConn *conn)
	constructor
virtual	~DtReflectedObject ()
	destructor
virtual DtStateRepository *	sr () 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 DtReflectedObject *	nextObj () const
	Get the next remote object.
virtual DtReflectedObject *	prevObj () const
	Get the previous remote object.
virtual DtReflectedObject *	wrapNextObj () const
	Get the next remote object.
virtual DtReflectedObject *	wrapPrevObj () 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
	DtReflectedUnderwaterAcoustics (const DtReflectedUnderwaterAcoustics &)
	Copy constructor - not implemented.
DtReflectedUnderwaterAcoustics &	operator= (const DtReflectedUnderwaterAcoustics &)
	Assignment operator - not implemented.
Protected Member Functions inherited from DtReflectedObject
	DtReflectedObject (const DtReflectedObject &orig)
	copy constructor – not implemented
DtReflectedObject &	operator= (const DtReflectedObject &orig)
	assignment operator – not implemented
virtual void	processPostUpdateCallbacks ()
	Process the post update callbacks.

Protected Attributes
DtObjectIdHashKey	myHashKey
DtString	myIdString
DtUnderwaterAcousticsStateRepository *	myStateRepository
DtUnderwaterAcousticsDecoder	myDecoder
Protected Attributes inherited from DtReflectedObject
DtExerciseConn *	myExConn
DtIntrusiveList	myStateUpdateCallbacks
DtTime	myLastTimeUpdated
DtTime	myLastSimTimeUpdated
DtTime	myLastReceivedTimeStamp
Protected Attributes inherited from DtListedObj
DtList *	myList
DtListItem *	myItem

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.

Reimplemented from DtListedObj.

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

protected

Assignment operator - not implemented.

virtual DtReflectedUnderwaterAcoustics* DtReflectedUnderwaterAcoustics::prev ( ) const

virtual

Get the previous underwater acoustics.

Reimplemented from DtListedObj.

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

Synonym for underwaterAcousticsStateRep().

virtual DtReflectedUnderwaterAcoustics* DtReflectedUnderwaterAcoustics::wrapNext ( ) const

virtual

Get the next underwater acoustics.

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

Reimplemented from DtListedObj.

virtual DtReflectedUnderwaterAcoustics* DtReflectedUnderwaterAcoustics::wrapPrev ( ) const

virtual

Get the previous underwater acoustics.

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

Reimplemented from DtListedObj.

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:

• reflectedUnderwaterAcousticsDIS.h