DtReflectedPropulsionNoise Class Reference

Instances of DtReflectedPropulsionNoise represent propulsion noise object simulated by remote applications. More...

Inheritance diagram for DtReflectedPropulsionNoise:

Collaboration diagram for DtReflectedPropulsionNoise:

Public Types
typedef DtPropulsionNoiseStateRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtPropulsionNoiseStateRepositories.

Public Member Functions
	DtReflectedPropulsionNoise (DtExerciseConn *conn, const DtGlobalObjectDesignator &hostEntity)
	Constructor.
virtual	~DtReflectedPropulsionNoise ()
	Destructor.
virtual DtPropulsionNoiseStateRepository *	propulsionNoiseRep () const
	Get the propulsion noise state repository.
virtual DtPropulsionNoiseStateRepository *	psr () const
	Synonym for propulsionNoiseRep().
virtual DtStateRepository *	stateRep () const
	Returns a pointer to the StateRepository through which you can inspect current state information.
virtual DtPropulsionNoiseDecoder *	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 DtReflectedPropulsionNoise *	next () const
	Get the next propulsion noise object.
virtual DtReflectedPropulsionNoise *	prev () const
	Get the previous propulsion noise object.
virtual DtReflectedPropulsionNoise *	wrapNext () const
	Get the next propulsion noise object.
virtual DtReflectedPropulsionNoise *	wrapPrev () const
	Get the previous propulsion noise object.
virtual void	addPostUpdateCallback (DtPropNoiseCallbackFunction cb, void *userData)
	Propulsion noise state callback registration/deregistration.
virtual void	removePostUpdateCallback (DtPropNoiseCallbackFunction 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 propulsion noise 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
	DtReflectedPropulsionNoise (const DtReflectedPropulsionNoise &)
	Copy constructor - not implemented.
DtReflectedPropulsionNoise &	operator= (const DtReflectedPropulsionNoise &)
	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
DtPropulsionNoiseStateRepository *	myStateRepository
DtPropulsionNoiseDecoder	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 DtReflectedPropulsionNoise represent propulsion noise object simulated by remote applications.

State data can be viewed through its state repository.

Member Typedef Documentation

typedef DtPropulsionNoiseStateRepository*(* DtReflectedPropulsionNoise::DtStateRepCreator)()

Function prototype for functions that create DtPropulsionNoiseStateRepositories.

Constructor & Destructor Documentation

DtReflectedPropulsionNoise::DtReflectedPropulsionNoise	(	DtExerciseConn *	conn,
		const DtGlobalObjectDesignator &	hostEntity
	)

Constructor.

virtual DtReflectedPropulsionNoise::~DtReflectedPropulsionNoise ( )

virtual

Destructor.

DtReflectedPropulsionNoise::DtReflectedPropulsionNoise ( const DtReflectedPropulsionNoise &  )

protected

Copy constructor - not implemented.

Member Function Documentation

virtual void DtReflectedPropulsionNoise::addPostUpdateCallback ( DtPropNoiseCallbackFunction  cb, void *  userData  )

virtual

Propulsion noise state callback registration/deregistration.

virtual DtPropulsionNoiseDecoder* DtReflectedPropulsionNoise::decoder ( )

inlinevirtual

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

virtual const DtGlobalObjectDesignator& DtReflectedPropulsionNoise::globalId ( ) const

virtual

Get the propulsion noise entityId.

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

Implements DtReflectedObject.

virtual const DtBaseHashKey& DtReflectedPropulsionNoise::hashKey ( ) const

inlinevirtual

Get a hash key for this object.

Implements DtReflectedObject.

virtual DtString DtReflectedPropulsionNoise::idString ( ) const

inlinevirtual

Get a string identification of this object.

Implements DtReflectedObject.

virtual DtReflectedPropulsionNoise* DtReflectedPropulsionNoise::next ( ) const

virtual

Get the next propulsion noise object.

Reimplemented from DtListedObj.

DtReflectedPropulsionNoise& DtReflectedPropulsionNoise::operator= ( const DtReflectedPropulsionNoise &  )

protected

Assignment operator - not implemented.

virtual DtReflectedPropulsionNoise* DtReflectedPropulsionNoise::prev ( ) const

virtual

Get the previous propulsion noise object.

Reimplemented from DtListedObj.

virtual void DtReflectedPropulsionNoise::processStateMessage ( const DtStateMsg &  msg )

virtual

Overrides the implementation of the base class.

Processes an Underwater Acoustic PDU.

Reimplemented from DtReflectedObject.

virtual DtPropulsionNoiseStateRepository* DtReflectedPropulsionNoise::propulsionNoiseRep ( ) const

inlinevirtual

Get the propulsion noise state repository.

virtual DtPropulsionNoiseStateRepository* DtReflectedPropulsionNoise::psr ( ) const

inlinevirtual

Synonym for propulsionNoiseRep().

virtual void DtReflectedPropulsionNoise::removePostUpdateCallback ( DtPropNoiseCallbackFunction  cb, void *  userData  )

virtual

static void DtReflectedPropulsionNoise::setStateRepCreator ( DtStateRepCreator  creator )

static

Give us a function to be used for creating SRs.

virtual DtStateRepository* DtReflectedPropulsionNoise::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 DtReflectedPropulsionNoise::stateRepCreator ( )

static

virtual DtReflectedPropulsionNoise* DtReflectedPropulsionNoise::wrapNext ( ) const

virtual

Get the next propulsion noise object.

If at the end, it will cycle back to the first propulsion noise object.

Reimplemented from DtListedObj.

virtual DtReflectedPropulsionNoise* DtReflectedPropulsionNoise::wrapPrev ( ) const

virtual

Get the previous propulsion noise object.

If at the beginning, it will cycle back to the last propulsion noise object.

Reimplemented from DtListedObj.

Member Data Documentation

DtPropulsionNoiseDecoder DtReflectedPropulsionNoise::myDecoder

protected

DtObjectIdHashKey DtReflectedPropulsionNoise::myHashKey

protected

DtString DtReflectedPropulsionNoise::myIdString

protected

DtPropulsionNoiseStateRepository* DtReflectedPropulsionNoise::myStateRepository

protected

DtStateRepCreator DtReflectedPropulsionNoise::theStateRepCreator

staticprotected

---

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

• reflectedPropulsionNoiseDIS.h