DtReflectedRadioReceiverList Class Reference

Inheritance diagram for DtReflectedRadioReceiverList:

Collaboration diagram for DtReflectedRadioReceiverList:

Public Member Functions
	DtReflectedRadioReceiverList (DtExerciseConn *conn)
	constructor
virtual	~DtReflectedRadioReceiverList ()
virtual DtReflectedRadioReceiver *	lookup (const DtObjectId &id, int radioId=1) const
	lookup an entity from its object ID and radio ID
virtual DtReflectedRadioReceiver *	first () const
	get the first and last elements of the radio receiver list
virtual DtReflectedRadioReceiver *	last () const
virtual void	addRadioReceiverAdditionCallback (DtRadioReceiverCallbackFunction cb, void *userData)
	RadioReceiver added callback registration/deregistration.
virtual void	removeRadioReceiverAdditionCallback (DtRadioReceiverCallbackFunction cb, void *userData)
virtual void	addRadioReceiverRemovalCallback (DtRadioReceiverCallbackFunction cb, void *userData)
	RadioReceiver removed callback registration/deregistration.
virtual void	removeRadioReceiverRemovalCallback (DtRadioReceiverCallbackFunction cb, void *userData)
virtual void	print ()
	Print the SRs of all objects.
virtual DtReflectedRadioReceiver *	processRadioReceiver (const DtReceiverPdu &pdu)
	process an incoming environment process pdu.
Public Member Functions inherited from DtReflectedObjectList
	DtReflectedObjectList (DtExerciseConn *exConn)
	Constructor.
virtual	~DtReflectedObjectList ()
	destructor Warning: makes non-virtual call to removeAndDelete
virtual DtReflectedObject *	firstObj () const
	Get the first/last object in the list.
virtual DtReflectedObject *	lastObj () const
virtual int	count () const
	Get number of objects.
virtual DtReflectedObject *	lookupObj (const DtBaseHashKey &key) const
	Search for an object.
virtual DtExerciseConn *	exerciseConn () const
	Get my exerciseConn.
virtual void	addObjectAdditionCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Object added callback registration/deregistration.
virtual void	removeObjectAdditionCallback (DtReflectedObjectCallbackFunction cb, void *userData)
virtual void	addObjectRemovalCallback (DtReflectedObjectCallbackFunction cb, void *userData)
	Object removed callback registration/deregistration.
virtual void	removeObjectRemovalCallback (DtReflectedObjectCallbackFunction cb, void *userData)
virtual void	print () const
	Print the SRs of all objects.
virtual void	setTimeoutProcessing (bool onOff)
	Set whether or not timeout processing occurs.
virtual void	setTimeoutInterval (DtTime time)
	Set/Get the remote object timeout period.
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.
virtual void	clearDiscoveryCondition ()
	Unregisters the checker function set in setDiscoverCondition.

Protected Member Functions
DtReflectedRadioReceiverList &	operator= (const DtReflectedRadioReceiverList &orig)
	Assignment operator – not implemented.
	DtReflectedRadioReceiverList (const DtReflectedRadioReceiverList &orig)
	Copy constructor – not implemented.
virtual DtReflectedObject *	newReflectedObj (const DtStateMsg &msg)
	Create a new object from a state message.
virtual DtReflectedObject *	processStateMessage (const DtStateMsg &msg)
	process an incoming state message. Calls processRadioReceiver().
virtual void	objectAdded (DtReflectedObject *obj)
	Called after an env process is added and before addition callbacks are processed.
virtual void	finalPduIsSetAction (DtReflectedRadioReceiver *envProcess)
	Called when an env process sends its final PDU.
virtual const DtBaseHashKey &	hashKeyFromStateMessage (const DtStateMsg *msg)
	Get a hash key from a state message.
virtual DtReflectedRadioReceiver *	newReflectedRadioReceiver (const DtEntityIdentifier &id, int radioId) const
	Create a new reflected env process.
virtual void	radioReceiverAdded (DtReflectedRadioReceiver *ent)
	Called after an env process is added and before addition callbacks are processed.
Protected Member Functions inherited from DtReflectedObjectList
	DtReflectedObjectList (const DtReflectedObjectList &orig)
	copy constructor – not implemented
DtReflectedObjectList &	operator= (const DtReflectedObjectList &orig)
	assignment operator – not implemented
virtual void	doTimeouts ()
	Remove any remote objects which have not been updated during the timeout period.
virtual void	removeAndDelete (DtReflectedObject *obj, char *msg=NULL)
	Remove the remote object from the list if found and delete it.
virtual bool	shouldBeTimedOut (DtReflectedObject *object)
	Returns whether or not the object should be timed out.
void	emptyLists ()
	Empty the object list and the timeout list.
void	emptyCallbackLists ()
virtual void	processObjectAdditionCallbacks (DtReflectedObject *object)
	Process object addition/removal callbacks.
virtual void	processObjectRemovalCallbacks (DtReflectedObject *object)
virtual int	acceptPdu (const DtStateMsg &) const
	Determines if a PDU should be processed or not.
virtual bool	readyToAdd (DtReflectedObject *obj)
	Returns true if the obj is ready to be added to myObjectList; calls myDiscoveryCondition from within.

Static Protected Member Functions
static void	radioReceiverCb (DtReceiverPdu *pdu, void *usr)
	callback for the exercise connection
Static Protected Member Functions inherited from DtReflectedObjectList
static void	doTimeoutsPostDrainCb (void *usr)
	Calls doTimeouts.

Protected Attributes
DtStringHashKey *	myHashKey
Protected Attributes inherited from DtReflectedObjectList
DtExerciseConn *	myExConn
DtIntrusiveList	myObjectAddedCallbacks
DtIntrusiveList	myObjectRemovedCallbacks
DtIntrusiveList	myObjectList
DtIntrusiveList	myWaitList
DtHashlist	myObjectHashlist
DtHashlist	myWaitHashlist
DtTime	myTimeoutInterval
bool	myTimeoutProcessingFlag
DtDiscoveryCondition	myDiscoveryCondition
void *	myDiscoveryConditionParameter

Constructor & Destructor Documentation

DtReflectedRadioReceiverList::DtReflectedRadioReceiverList

(

DtExerciseConn *

conn

)

constructor

virtual DtReflectedRadioReceiverList::~DtReflectedRadioReceiverList ( )

virtual

DtReflectedRadioReceiverList::DtReflectedRadioReceiverList ( const DtReflectedRadioReceiverList &  orig )

protected

Copy constructor – not implemented.

Member Function Documentation

virtual void DtReflectedRadioReceiverList::addRadioReceiverAdditionCallback ( DtRadioReceiverCallbackFunction  cb, void *  userData  )

virtual

RadioReceiver added callback registration/deregistration.

virtual void DtReflectedRadioReceiverList::addRadioReceiverRemovalCallback ( DtRadioReceiverCallbackFunction  cb, void *  userData  )

virtual

RadioReceiver removed callback registration/deregistration.

virtual void DtReflectedRadioReceiverList::finalPduIsSetAction ( DtReflectedRadioReceiver *  envProcess )

protectedvirtual

Called when an env process sends its final PDU.

Currently, this removes and deletes the env process.

virtual DtReflectedRadioReceiver* DtReflectedRadioReceiverList::first ( ) const

virtual

get the first and last elements of the radio receiver list

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

protectedvirtual

Get a hash key from a state message.

Implements DtReflectedObjectList.

virtual DtReflectedRadioReceiver* DtReflectedRadioReceiverList::last ( ) const

virtual

virtual DtReflectedRadioReceiver* DtReflectedRadioReceiverList::lookup ( const DtObjectId &  id, int  radioId = 1  ) const

virtual

lookup an entity from its object ID and radio ID

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

protectedvirtual

Create a new object from a state message.

Calls newReflectedRadioReceiver() to create a new env process

Implements DtReflectedObjectList.

virtual DtReflectedRadioReceiver* DtReflectedRadioReceiverList::newReflectedRadioReceiver ( const DtEntityIdentifier &  id, int  radioId  ) const

protectedvirtual

Create a new reflected env process.

virtual void DtReflectedRadioReceiverList::objectAdded ( DtReflectedObject *  obj )

protectedvirtual

Called after an env process is added and before addition callbacks are processed.

Calls radioReceiverAdded().

Reimplemented from DtReflectedObjectList.

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

protected

Assignment operator – not implemented.

virtual void DtReflectedRadioReceiverList::print ( )

virtual

Print the SRs of all objects.

virtual DtReflectedRadioReceiver* DtReflectedRadioReceiverList::processRadioReceiver ( const DtReceiverPdu &  pdu )

virtual

process an incoming environment process pdu.

Then calls down to base class processStateMessage().

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

protectedvirtual

process an incoming state message. Calls processRadioReceiver().

Reimplemented from DtReflectedObjectList.

virtual void DtReflectedRadioReceiverList::radioReceiverAdded ( DtReflectedRadioReceiver *  ent )

protectedvirtual

Called after an env process is added and before addition callbacks are processed.

Right now, this function only calls DtInfo.

static void DtReflectedRadioReceiverList::radioReceiverCb ( DtReceiverPdu *  pdu, void *  usr  )

staticprotected

callback for the exercise connection

virtual void DtReflectedRadioReceiverList::removeRadioReceiverAdditionCallback ( DtRadioReceiverCallbackFunction  cb, void *  userData  )

virtual

virtual void DtReflectedRadioReceiverList::removeRadioReceiverRemovalCallback ( DtRadioReceiverCallbackFunction  cb, void *  userData  )

virtual

Member Data Documentation

DtStringHashKey* DtReflectedRadioReceiverList::myHashKey

protected

---

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

• dRefRadRcvrList.h