DtReflectedUnderwaterAcoustics Class Reference

Instances of DtReflectedUnderwaterAcoustics represent EmitterSystem 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 DtUnderwaterAcousticsStateRepositories.
Public Types inherited from DtReflectedObject
typedef DtStateRepository *(*	DtBaseStateRepCreator )()
	Function prototype for functions that create DtStateRepositories.

Public Member Functions
	DtReflectedUnderwaterAcoustics (DtHlaObject *obj, DtExerciseConn *conn)
	If beamsUpdateSystem == true, then a system's post-update callbacks are called whenever one of the beams in the system is updated.
	DtReflectedUnderwaterAcoustics (const DtObjectId &id, const DtGlobalObjectDesignator &hostId, DtExerciseConn *conn)
	Constructor used to construct a placeholder system when we discover a beam whose system hasn't been discovered yet.
virtual	~DtReflectedUnderwaterAcoustics ()
	destructor
virtual DtUnderwaterAcousticsStateRepository *	underwaterAcousticsStateRep () const
	Get the emitter system's state repository.
virtual DtUnderwaterAcousticsStateRepository *	usr () const
	Synonym for emitterSysRep().
virtual DtReflectedUnderwaterAcoustics *	next () const
	Get the next remote emitterSystem.
virtual DtReflectedUnderwaterAcoustics *	prev () const
	Get the previous remote emitterSystem.
virtual DtReflectedUnderwaterAcoustics *	wrapNext () const
	Get the next remote emitterSystem.
virtual DtReflectedUnderwaterAcoustics *	wrapPrev () const
	Get the previous remote emitterSystem.
virtual void	addPostUpdateCallback (DtUnderwaterAcousticsCallbackFunction cb, void *usr)
	underwater acoustics state callback registration/deregistration.
virtual void	removePostUpdateCallback (DtUnderwaterAcousticsCallbackFunction cb, void *usr)
virtual void	subsystemUpdated ()
	Tell the object that one of its active sonars has been updated.
Public Member Functions inherited from DtReflectedObject
	DtReflectedObject (DtExerciseConn *conn, DtStateRepository *stateRep)
	Primary constructor.
	DtReflectedObject (DtHlaObject *obj, DtExerciseConn *conn, DtBaseStateRepCreator creator)
	Older constructor.
	DtReflectedObject (const DtObjectId &id, const DtGlobalObjectDesignator &des, DtExerciseConn *conn, DtBaseStateRepCreator creator)
	Older constructor.
virtual	~DtReflectedObject ()
	destructor
virtual DtStateRepository *	stateRep () const
	Returns a pointer to the StateRepository - through which you can inspect current state information.
virtual DtStateRepository *	sr () const
	Synonym for stateRep().
virtual DtHlaStateDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode state messages into our SR.
virtual DtHlaObjectWithStateRep *	hlaObject () const
	Get the entity's hlaObject (DtHlaObjectWithStateRep is derived from DtHlaObject).
virtual const DtObjectId &	objectId () const
	Get the HLA object's id.
virtual const DtObjectId &	id () const
	Get the HLA object's id (local ID).
virtual const DtObjectId &	localId () const
	Get the HLA object's id (local ID).
virtual const DtString &	name () const
	Get the HLA object name.
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the HLA object's global object designator - the object name in HLA.
virtual const DtString &	lastProducingFederate () const
	Get the name of the last federate that produced a reflected update.
virtual DtTime	lastSimTimeUpdated () const
	Returns the value of simulation time at the time an update was last received for the entity.
virtual DtTime	lastReceivedTimeStamp () const
	Returns the value of the time send in the last Update received for this entity.
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.
void	setHlaObject (DtHlaObject *obj, DtHlaStateDecoder *decoder=NULL)
	Start reflecting this object, using this decoder.
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.
void	detachHlaObject ()
	Ends managing of current HLA object.
virtual void	requestUpdate ()
	Request that the owner of this entity send an attribute update.

Static Public Member Functions
static DtStateRepCreator	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs.

Protected Member Functions
	DtReflectedUnderwaterAcoustics (const DtReflectedUnderwaterAcoustics &orig)
	copy constructor
DtReflectedUnderwaterAcoustics &	operator= (const DtReflectedUnderwaterAcoustics &orig)
	assignment operator
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
bool	mySubsystemsCauseUpdate
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

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

Detailed Description

Instances of DtReflectedUnderwaterAcoustics represent EmitterSystem 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 DtUnderwaterAcousticsStateRepositories.

Constructor & Destructor Documentation

DtReflectedUnderwaterAcoustics::DtReflectedUnderwaterAcoustics	(	DtHlaObject *	obj,
		DtExerciseConn *	conn
	)

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

DtReflectedUnderwaterAcoustics::DtReflectedUnderwaterAcoustics	(	const DtObjectId &	id,
		const DtGlobalObjectDesignator &	hostId,
		DtExerciseConn *	conn
	)

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

virtual DtReflectedUnderwaterAcoustics::~DtReflectedUnderwaterAcoustics ( )

virtual

destructor

DtReflectedUnderwaterAcoustics::DtReflectedUnderwaterAcoustics ( const DtReflectedUnderwaterAcoustics &  orig )

protected

copy constructor

Member Function Documentation

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

virtual

underwater acoustics state callback registration/deregistration.

virtual DtReflectedUnderwaterAcoustics* DtReflectedUnderwaterAcoustics::next ( ) const

virtual

Get the next remote emitterSystem.

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

protected

assignment operator

virtual DtReflectedUnderwaterAcoustics* DtReflectedUnderwaterAcoustics::prev ( ) const

virtual

Get the previous remote emitterSystem.

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

virtual

static DtStateRepCreator DtReflectedUnderwaterAcoustics::setStateRepCreator ( DtStateRepCreator  creator )

static

Give us a function to be used for creating SRs.

virtual void DtReflectedUnderwaterAcoustics::subsystemUpdated ( )

virtual

Tell the object that one of its active sonars has been updated.

DtUnderwaterAcousticsStateRepository * DtReflectedUnderwaterAcoustics::underwaterAcousticsStateRep ( ) const

inlinevirtual

Get the emitter system's state repository.

References DtReflectedObject::myStateRep.

DtUnderwaterAcousticsStateRepository * DtReflectedUnderwaterAcoustics::usr ( ) const

inlinevirtual

Synonym for emitterSysRep().

References DtReflectedObject::myStateRep.

virtual DtReflectedUnderwaterAcoustics* DtReflectedUnderwaterAcoustics::wrapNext ( ) const

virtual

Get the next remote emitterSystem.

Will cycle back to the first remote emitterSystem.

virtual DtReflectedUnderwaterAcoustics* DtReflectedUnderwaterAcoustics::wrapPrev ( ) const

virtual

Get the previous remote emitterSystem.

Will cycle back to the last remote emitterSystem.

Member Data Documentation

bool DtReflectedUnderwaterAcoustics::mySubsystemsCauseUpdate

protected

DtStateRepCreator DtReflectedUnderwaterAcoustics::theStateRepCreator

staticprotected

---

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

• reflectedUnderwaterAcousticsHLA.h