Instances of this class provide a protocol independent interface to a list of WaterSurface in a DIS environment. More...

Inheritance diagram for DtReflectedWaterSurfaceList:

Collaboration diagram for DtReflectedWaterSurfaceList:

Public Member Functions
	DtReflectedWaterSurfaceList (DtExerciseConn *exConn)
	Constructor. More...

virtual	~DtReflectedWaterSurfaceList ()
	Destructor. More...

virtual DtReflectedWaterSurface *	first () const

virtual DtReflectedWaterSurface *	last () const

virtual void	addWaterSurfaceAdditionCallback (DtWaterSurfaceCallbackFunction cb, void *userData)
	WaterSurface added callback registration/deregistration. More...

virtual void	removeWaterSurfaceAdditionCallback (DtWaterSurfaceCallbackFunction cb, void *userData)

virtual void	addWaterSurfaceRemovalCallback (DtWaterSurfaceCallbackFunction cb, void *userData)
	WaterSurface removed callback registration/deregistration. More...

virtual void	removeWaterSurfaceRemovalCallback (DtWaterSurfaceCallbackFunction cb, void *userData)

virtual void	print ()
	Print the SRs of all objects. More...

virtual DtReflectedWaterSurface *	processWaterSurfaceState (const DtMetocPdu &pdu)
	Process an incoming WaterSurface state pdu. More...

Public Member Functions inherited from DtReflectedObjectList
	DtReflectedObjectList (DtExerciseConn *exConn, int numBucketsPrimeNumber=503)
	Constructor. More...

virtual	~DtReflectedObjectList ()
	destructor Warning: makes non-virtual call to removeAndDelete More...

virtual void	initializeAttributePduKindsOfInterest (const std::set< DtPduKind > &pduKinds)
	This initializes which PDU kinds will be processed when receiving an Attribute PDU. More...

virtual DtReflectedObject *	firstObj () const
	Get the first/last object in the list. More...

virtual DtReflectedObject *	lastObj () const

virtual int	count () const
	Get number of objects. More...

virtual DtReflectedObject *	lookupObj (const DtBaseHashKey &key) const
	Search for an object. More...

virtual DtExerciseConn *	exerciseConn () const
	Get my exerciseConn. More...

virtual void	addObjectAdditionCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Object added callback registration/deregistration. More...

virtual void	removeObjectAdditionCallback (DtReflectedObjectCallbackFunction cb, void *userData)

virtual void	addObjectRemovalCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Object removed callback registration/deregistration. More...

virtual void	removeObjectRemovalCallback (DtReflectedObjectCallbackFunction cb, void *userData)

virtual void	print () const
	Print the SRs of all objects. More...

virtual void	setTimeoutProcessing (bool onOff)
	Set whether or not timeout processing occurs. More...

virtual void	setTimeoutInterval (DtTime time)
	Set/Get the remote object timeout period. More...

virtual DtTime	timeoutInterval ()

virtual void	setDiscoveryCondition (DtDiscoveryCondition fn, void *usr)
	Set the checker function which will determine when an object gets discovered and put into the ref. More...

virtual void	clearDiscoveryCondition ()
	Unregisters the checker function set in setDiscoverCondition. More...

virtual void	removeAndDelete (DtReflectedObject obj, const char msg=NULL)
	Remove the remote object from the list if found and delete it. More...

virtual void	removeObject (DtReflectedObject *obj)
	This is the same as removeAndDelete, it exists to maintain equality with HLA objects. More...

virtual DtTime	timeoutCheckInterval () const

virtual void	setTimeoutCheckInterval (DtTime interval)

virtual void	addWaitlistAdditionCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Callback registration for when objects are added or removed from the waitlist. More...

virtual void	removeWaitlistAdditionCallback (DtReflectedObjectCallbackFunction cb, void *userData)

virtual void	addWaitlistRemovalCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Waitlist removed callback registration/deregistration. More...

virtual void	removeWaitlistRemovalCallback (DtReflectedObjectCallbackFunction cb, void *userData)

Protected Member Functions
virtual DtReflectedObject *	newReflectedObj (const DtStateMsg &msg)
	Create a new object from a state message. More...

virtual DtReflectedObject *	processStateMessage (const DtStateMsg &msg)
	Process an incoming state message. More...

virtual void	objectAdded (DtReflectedObject *obj)
	Called after an WaterSurface is added and before additional callbacks are processed. More...

virtual int	acceptPdu (const DtStateMsg &msg) const
	Determines if a PDU should be processed or not. More...

virtual const DtBaseHashKey &	hashKeyFromStateMessage (const DtStateMsg *msg)
	Get a hash key from a state message. More...

virtual DtReflectedWaterSurface *	newReflectedWaterSurface () const
	Create a new reflected WaterSurface. More...

virtual void	waterSurfaceAdded (DtReflectedWaterSurface *agg)
	Called after a WaterSurface is added and before additional callbacks are processed. More...

Protected Member Functions inherited from DtReflectedObjectList
virtual void	doTimeouts ()
	Remove any remote objects which have not been updated during the timeout period. More...

virtual bool	shouldBeTimedOut (DtReflectedObject *object)
	Returns whether or not the object should be timed out. More...

void	emptyLists ()
	Empty the object list and the timeout list. More...

void	emptyCallbackLists ()

virtual void	processObjectAdditionCallbacks (DtReflectedObject *object)
	Process object addition/removal callbacks. More...

virtual void	processObjectRemovalCallbacks (DtReflectedObject *object)

virtual void	processWaitlistAdditionCallbacks (DtReflectedObject *object)
	Process waitlist addition/removal callbacks. More...

virtual void	processWaitlistRemovalCallbacks (DtReflectedObject *object)

virtual DtBaseHashKey *	hashKeyFromAttributeRecordSet (const DtAttributeRecordSet &recordSet)
	Get a hash key from an attribute record set. More...

virtual bool	readyToAdd (DtReflectedObject *obj)
	Returns true if the obj is ready to be added to myObjectList; calls myDiscoveryCondition from within. More...

virtual void	processAttributePduCb (DtAttributeInteraction *inter)

virtual void	processAttributePduRecordSet (const DtAttributeRecordSet &recordSet, const DtSimulationAddress &simAddr, DtReflectedObject *obj=0)

virtual void	processAttributePduWaitListCb (DtReflectedObject *obj)

virtual void	deleteRecordSetBySimulationAddressMap (DtRecordSetBySimulationAddressMap &recordSetMap, const DtSimulationAddress &simAddr=DtSimulationAddress()) const

Static Protected Member Functions
static void	waterSurfaceStateCb (DtMetocPdu pdu, void usr)
	Callback for the exercise connection. More...

Static Protected Member Functions inherited from DtReflectedObjectList
static void	doTimeoutsPostDrainCb (void *usr)
	Calls doTimeouts. More...

static void	processAttributePduCb (DtAttributeInteraction inter, void usr)

static void	processAttributePduWaitListCb (DtReflectedObject obj, void userData)

Private Member Functions
DtReflectedWaterSurfaceList &	operator= (const DtReflectedWaterSurfaceList &orig)
	Assignment operator – not implemented. More...

	DtReflectedWaterSurfaceList (const DtReflectedWaterSurfaceList &orig)
	Copy constructor – not implemented. More...

Detailed Description

Instances of this class provide a protocol independent interface to a list of WaterSurface in a DIS environment.

WaterSurface PDUs are used by VR-Forces to send weather area info to other applications. These WaterSurface objects have longer timeout and heartbeat values than other DIS objects. The default Timeout/Heartbeat times are 25 seconds and 10 seconds respectively.

Constructor & Destructor Documentation

DtReflectedWaterSurfaceList::DtReflectedWaterSurfaceList ( DtExerciseConn * exConn )

Constructor.

virtual DtReflectedWaterSurfaceList::~DtReflectedWaterSurfaceList ( )

virtual

Destructor.

DtReflectedWaterSurfaceList::DtReflectedWaterSurfaceList ( const DtReflectedWaterSurfaceList & orig )

private

Copy constructor – not implemented.

Member Function Documentation

virtual int DtReflectedWaterSurfaceList::acceptPdu ( const DtStateMsg & msg ) const

protectedvirtual

Determines if a PDU should be processed or not.

Looks at the METOC Layer Record Type in the PDU for a WaterSurfaceRecord

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedWaterSurfaceList::addWaterSurfaceAdditionCallback	(	DtWaterSurfaceCallbackFunction	cb,
		void *	userData
	)

virtual

WaterSurface added callback registration/deregistration.

virtual void DtReflectedWaterSurfaceList::addWaterSurfaceRemovalCallback	(	DtWaterSurfaceCallbackFunction	cb,
		void *	userData
	)

virtual

WaterSurface removed callback registration/deregistration.

virtual DtReflectedWaterSurface* DtReflectedWaterSurfaceList::first ( ) const

virtual

virtual const DtBaseHashKey& DtReflectedWaterSurfaceList::hashKeyFromStateMessage ( const DtStateMsg * msg )

protectedvirtual

Get a hash key from a state message.

Implements DtReflectedObjectList.

virtual DtReflectedWaterSurface* DtReflectedWaterSurfaceList::last ( ) const

virtual

virtual DtReflectedObject* DtReflectedWaterSurfaceList::newReflectedObj ( const DtStateMsg & msg )

protectedvirtual

Create a new object from a state message.

Implements DtReflectedObjectList.

virtual DtReflectedWaterSurface* DtReflectedWaterSurfaceList::newReflectedWaterSurface ( ) const

protectedvirtual

Create a new reflected WaterSurface.

virtual void DtReflectedWaterSurfaceList::objectAdded ( DtReflectedObject * obj )

protectedvirtual

Called after an WaterSurface is added and before additional callbacks are processed.

Right now, this function only calls DtInfo.

Reimplemented from DtReflectedObjectList.

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

private

Assignment operator – not implemented.

virtual void DtReflectedWaterSurfaceList::print ( )

virtual

Print the SRs of all objects.

virtual DtReflectedObject* DtReflectedWaterSurfaceList::processStateMessage ( const DtStateMsg & msg )

protectedvirtual

Process an incoming state message.

Reimplemented from DtReflectedObjectList.

virtual DtReflectedWaterSurface* DtReflectedWaterSurfaceList::processWaterSurfaceState ( const DtMetocPdu & pdu )

virtual

Process an incoming WaterSurface state pdu.

Then calls down to base class processStateMessage().

virtual void DtReflectedWaterSurfaceList::removeWaterSurfaceAdditionCallback	(	DtWaterSurfaceCallbackFunction	cb,
		void *	userData
	)

virtual

virtual void DtReflectedWaterSurfaceList::removeWaterSurfaceRemovalCallback	(	DtWaterSurfaceCallbackFunction	cb,
		void *	userData
	)

virtual

virtual void DtReflectedWaterSurfaceList::waterSurfaceAdded ( DtReflectedWaterSurface * agg )

protectedvirtual

Called after a WaterSurface is added and before additional callbacks are processed.

Right now, this function only calls DtInfo.

static void DtReflectedWaterSurfaceList::waterSurfaceStateCb	(	DtMetocPdu *	pdu,
		void *	usr
	)

staticprotected

Callback for the exercise connection.

Member Data Documentation

DtEntityIdentifierHashKey DtReflectedWaterSurfaceList::myHashKey

protected

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

reflectedWaterSurfaceListDIS.h

Protected Attributes
DtEntityIdentifierHashKey	myHashKey

Protected Attributes inherited from DtReflectedObjectList
DtExerciseConn *	myExConn

DtIntrusiveList	myObjectAddedCallbacks

DtIntrusiveList	myObjectRemovedCallbacks

DtIntrusiveList	myWaitlistAddedCallbacks

DtIntrusiveList	myWaitlistRemovedCallbacks

DtIntrusiveList	myObjectList

DtIntrusiveList	myWaitList

DtHashlist	myObjectHashlist

DtHashlist	myWaitHashlist

DtAttributesByObjectIdMap	myAttributeWaitHashlist

DtTime	myTimeoutInterval

DtTime	myNextTimeoutCheck

DtTime	myTimeoutCheckInterval

bool	myTimeoutProcessingFlag

DtDiscoveryCondition	myDiscoveryCondition

void *	myDiscoveryConditionParameter

std::set< DtPduKind >	myPduKindSet

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation