DtReflectedActiveSonar Class Reference

Instances of DtReflectedActiveSonar are used to represent a simulated EmbeddedSystem.UnderwaterAcousticsEmission.ActiveSonar object reflected across a network. More...

Inheritance diagram for DtReflectedActiveSonar:

Collaboration diagram for DtReflectedActiveSonar:

Public Types
typedef DtActiveSonarStateRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtActiveSonarStateRepositories. More...
Public Types inherited from DtReflectedObject
typedef DtStateRepository *(*	DtBaseStateRepCreator )()
	Function prototype for functions that create DtStateRepositories. More...

Public Member Functions
	DtReflectedActiveSonar (DtHlaObject *obj, DtExerciseConn *conn, bool beamsUpdateSystem=true)
	constructor If beamsUpdateSystem == true, then a system's post-update callbacks are called whenever one of the beams in the system is updated. More...
	DtReflectedActiveSonar (const DtObjectId &id, const DtGlobalObjectDesignator &des, DtExerciseConn *conn, bool beamsUpdateSystem=true)
	Constructor used to construct a placeholder system when we discover a beam whose system hasn't been discovered yet. More...
virtual	~DtReflectedActiveSonar ()
	Destructor. More...
virtual DtActiveSonarStateRepository *	activeSonarRep () const
	Returns the ActiveSonar's state repository. More...
virtual DtActiveSonarStateRepository *	asr () const
	Shorter version of lifeformRep. More...
virtual DtReflectedActiveSonar *	next () const
	Returns the next reflected ActiveSonar in the DtReflectedActiveSonarList. More...
virtual DtReflectedActiveSonar *	prev () const
	Returns the previous reflected ActiveSonar in the DtReflectedActiveSonarList. More...
virtual DtReflectedActiveSonar *	wrapNext () const
	Returns the next reflected ActiveSonar. More...
virtual DtReflectedActiveSonar *	wrapPrev () const
	Returns the previous reflected ActiveSonar. More...
virtual void	addPostUpdateCallback (DtActiveSonarCallbackFunction cb, void *usr)
	Add a callback that is called when the DtReflectedActiveSonar is updated. More...
virtual void	removePostUpdateCallback (DtActiveSonarCallbackFunction cb, void *usr)
	Remove the callback that is called when the DtReflectedActiveSonar is updated. More...
virtual void	setAsr (DtActiveSonarStateRepository *asr)
	Set active sonar state repository. More...
virtual void	beamUpdated ()
	Tell the system that one of its beams has been updated. More...
Public Member Functions inherited from DtReflectedObject
	DtReflectedObject (DtExerciseConn *conn, DtStateRepository *stateRep)
	Primary constructor. More...
	DtReflectedObject (DtHlaObject *obj, DtExerciseConn *conn, DtBaseStateRepCreator creator)
	Older constructor. More...
	DtReflectedObject (const DtObjectId &id, const DtGlobalObjectDesignator &des, DtExerciseConn *conn, DtBaseStateRepCreator creator)
	Older constructor. More...
virtual	~DtReflectedObject ()
	destructor More...
virtual DtStateRepository *	stateRep () const
	Returns a pointer to the StateRepository - through which you can inspect current state information. More...
virtual DtStateRepository *	sr () const
	Synonym for stateRep(). More...
virtual DtHlaStateDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode state messages into our SR. More...
virtual DtHlaObjectWithStateRep *	hlaObject () const
	Get the entity's hlaObject (DtHlaObjectWithStateRep is derived from DtHlaObject). More...
virtual const DtObjectId &	objectId () const
	Get the HLA object's id. More...
virtual const DtObjectId &	id () const
	Get the HLA object's id (local ID). More...
virtual const DtObjectId &	localId () const
	Get the HLA object's id (local ID). More...
virtual const DtString &	name () const
	Get the HLA object name. More...
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the HLA object's global object designator - the object name in HLA. More...
virtual DtTime	lastSimTimeUpdated () const
	Returns the value of simulation time at the time an update was last received for the entity. More...
virtual DtTime	lastReceivedTimeStamp () const
	Returns the value of the time send in the last Update received for this entity. More...
virtual void	baseAddPostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Object state callback registration/deregistration. More...
virtual void	baseRemovePostUpdateCallback (DtReflectedObjectCallbackFunction cb, void *userData)
virtual DtReflectedObject *	nextObj () const
	Get the next remote object. More...
virtual DtReflectedObject *	prevObj () const
	Get the previous remote object. More...
virtual DtReflectedObject *	wrapNextObj () const
	Get the next remote object. More...
virtual DtReflectedObject *	wrapPrevObj () const
	Get the previous remote object. More...
void	setHlaObject (DtHlaObject *obj, DtHlaStateDecoder *decoder=NULL)
	Start reflecting this object, using this decoder. More...
virtual void	setNoHlaObject (const DtObjectId &id, const DtGlobalObjectDesignator &des)
	Used to set up a proxy DtReflectedEntity - one that is not actually managing a real reflected HLA object. More...
void	detachHlaObject ()
	Ends managing of current HLA object. More...
virtual void	requestUpdate ()
	Request that the owner of this entity send an attribute update. More...

Static Public Member Functions
static DtStateRepCreator	setStateRepCreator (DtStateRepCreator creator)
	Set the function to be called for creating state repositories. More...

Protected Member Functions
	DtReflectedActiveSonar (const DtReflectedActiveSonar &orig)
	Copy Constructor not implemented. More...
DtReflectedActiveSonar &	operator= (const DtReflectedActiveSonar &orig)
	Assignment operator not implemented. More...
Protected Member Functions inherited from DtReflectedObject
	DtReflectedObject (const DtReflectedObject &orig)
	copy constructor – Not Implemented More...
DtReflectedObject &	operator= (const DtReflectedObject &orig)
	assignment operator – Not Implemented More...
virtual void	processPostUpdateCallbacks ()
	Process the post update callbacks. More...

Protected Attributes
DtActiveSonarStateRepository *	myConstructedAsr
bool	myBeamsUpdateSystem
Protected Attributes inherited from DtReflectedObject
DtExerciseConn *	myExConn
DtHlaObjectWithStateRep *	myHlaObj
DtStateRepository *	myStateRep
DtHlaStateDecoder *	myDecoder
bool	myRequestCbRegistered
DtIntrusiveList	myStateUpdateCallbacks
DtObjectId	myId
DtString	myName
DtRefHlaObjectMap::iterator	myReflIterator
DtRefHlaObjectMap *	myReflMap

Static Protected Attributes
static DtStateRepCreator	theStateRepCreator
	The function called to create state repositories. More...

Additional Inherited Members
Static Protected Member Functions inherited from DtReflectedObject
static void	requestUpdatePostDrainCb (void *usr)
	Calls requestUpdate. More...
static void	processPostUpdateCallbacksCb (const DtStateMsg &stateMsg, DtHlaObject *obj, void *usr)
	Callback from HlaObject to process post update callbacks. More...

Detailed Description

Instances of DtReflectedActiveSonar are used to represent a simulated EmbeddedSystem.UnderwaterAcousticsEmission.ActiveSonar object reflected across a network.

Member Typedef Documentation

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

Function prototype for functions that create DtActiveSonarStateRepositories.

Constructor & Destructor Documentation

DtReflectedActiveSonar::DtReflectedActiveSonar	(	DtHlaObject *	obj,
		DtExerciseConn *	conn,
		bool	beamsUpdateSystem = true
	)

constructor If beamsUpdateSystem == true, then a system's post-update callbacks are called whenever one of the beams in the system is updated.

DtReflectedActiveSonar::DtReflectedActiveSonar	(	const DtObjectId &	id,
		const DtGlobalObjectDesignator &	des,
		DtExerciseConn *	conn,
		bool	beamsUpdateSystem = true
	)

Constructor used to construct a placeholder system when we discover a beam whose system hasn't been discovered yet.

virtual DtReflectedActiveSonar::~DtReflectedActiveSonar ( )

virtual

Destructor.

DtReflectedActiveSonar::DtReflectedActiveSonar ( const DtReflectedActiveSonar &  orig )

protected

Copy Constructor not implemented.

Member Function Documentation

DtActiveSonarStateRepository * DtReflectedActiveSonar::activeSonarRep ( ) const

inlinevirtual

Returns the ActiveSonar's state repository.

References DtReflectedObject::myStateRep.

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

virtual

Add a callback that is called when the DtReflectedActiveSonar is updated.

DtActiveSonarStateRepository * DtReflectedActiveSonar::asr ( ) const

inlinevirtual

Shorter version of lifeformRep.

References DtReflectedObject::myStateRep.

virtual void DtReflectedActiveSonar::beamUpdated ( )

virtual

Tell the system that one of its beams has been updated.

virtual DtReflectedActiveSonar* DtReflectedActiveSonar::next ( ) const

virtual

Returns the next reflected ActiveSonar in the DtReflectedActiveSonarList.

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

protected

Assignment operator not implemented.

virtual DtReflectedActiveSonar* DtReflectedActiveSonar::prev ( ) const

virtual

Returns the previous reflected ActiveSonar in the DtReflectedActiveSonarList.

virtual void DtReflectedActiveSonar::removePostUpdateCallback ( DtActiveSonarCallbackFunction  cb, void *  usr  )

virtual

Remove the callback that is called when the DtReflectedActiveSonar is updated.

virtual void DtReflectedActiveSonar::setAsr ( DtActiveSonarStateRepository *  asr )

virtual

Set active sonar state repository.

Only necessary when you want to use something other than the default, which is created internally.

static DtStateRepCreator DtReflectedActiveSonar::setStateRepCreator ( DtStateRepCreator  creator )

static

Set the function to be called for creating state repositories.

virtual DtReflectedActiveSonar* DtReflectedActiveSonar::wrapNext ( ) const

virtual

Returns the next reflected ActiveSonar.

Will cycle back to the first remote ActiveSonar in the DtReflectedActiveSonarList.

virtual DtReflectedActiveSonar* DtReflectedActiveSonar::wrapPrev ( ) const

virtual

Returns the previous reflected ActiveSonar.

Will cycle back to the first remote ActiveSonar in the DtReflectedActiveSonarList.

Member Data Documentation

bool DtReflectedActiveSonar::myBeamsUpdateSystem

protected

DtActiveSonarStateRepository* DtReflectedActiveSonar::myConstructedAsr

protected

DtStateRepCreator DtReflectedActiveSonar::theStateRepCreator

staticprotected

The function called to create state repositories.

---

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

• reflectedActiveSonarHLA.h