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.

Public Member Functions
	DtReflectedActiveSonar (DtExerciseConn *conn, const DtGlobalObjectDesignator &hostEntity, int acousticId)
	Constructor.
virtual	~DtReflectedActiveSonar ()
	Destructor.
virtual DtActiveSonarStateRepository *	activeSonarRep () const
	Get the sonar's state repository.
virtual DtActiveSonarStateRepository *	asr () const
	Synonym for activeSonarRep().
virtual DtStateRepository *	stateRep () const
	Returns a pointer to the StateRepository through which you can inspect current state information.
virtual DtActiveSonarDecoder *	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 DtReflectedActiveSonar *	next () const
	Get the next active sonar.
virtual DtReflectedActiveSonar *	prev () const
	Get the previous active sonar.
virtual DtReflectedActiveSonar *	wrapNext () const
	Get the next active sonar.
virtual DtReflectedActiveSonar *	wrapPrev () const
	Get the previous active sonar.
virtual void	addPostUpdateCallback (DtActiveSonarCallbackFunction cb, void *userData)
	Active sonar state callback registration/deregistration.
virtual void	removePostUpdateCallback (DtActiveSonarCallbackFunction cb, void *userData)
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 acitve sonar 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
	DtReflectedActiveSonar (const DtReflectedActiveSonar &)
	Copy constructor - not implemented.
DtReflectedActiveSonar &	operator= (const DtReflectedActiveSonar &)
	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
DtSystemHashKey	myHashKey
DtString	myIdString
DtActiveSonarStateRepository *	myStateRepository
DtActiveSonarDecoder	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 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.

Reimplemented from DtListedObj.

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

protected

Assignment operator - not implemented.

virtual DtReflectedActiveSonar* DtReflectedActiveSonar::prev ( ) const

virtual

Get the previous active sonar.

Reimplemented from DtListedObj.

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.

Reimplemented from DtListedObj.

virtual DtReflectedActiveSonar* DtReflectedActiveSonar::wrapPrev ( ) const

virtual

Get the previous active sonar.

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

Reimplemented from DtListedObj.

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:

• reflectedActiveSonarDIS.h