OMK::SignalDispatcher Class Reference

this class implements signal dispatching More...

#include <OMKSignalDispatcher.h>

Collaboration diagram for OMK::SignalDispatcher:

[legend]List of all members.

Public Member Functions
	SignalDispatcher (Controller &controller)
	constructor
virtual	~SignalDispatcher ()
	destrcutor
virtual void	sendEventsForSignal (Event &event, const EventIdentifier &sigId)
	send the events correponding to signal sigId
virtual bool	registerForSignal (const EventIdentifier &sigId, const Name &registrant, const EventIdentifier &eventId)
	register an object for a signal
virtual bool	cancelRegistrationForSignal (const EventIdentifier &sigId, const Name &registrant)
	cancel the registration of an object for a signal
Protected Types
typedef std::vector< std::pair< Name, EventIdentifier > >	_VectorType
	the type of data structure associated to a signal
typedef std::map< EventIdentifier, _VectorType * >	_TableType
	the type of data structure remembering who is registred to what signal
Protected Attributes
Controller &	_controler
	the controller used to find the reference handles to objects registering
_TableType	_tableOfRegistredObjects
	the table of registref objects

---

Detailed Description

this class implements signal dispatching

Author:

David Margery

Version:

1.0

Definition at line 38 of file OMKSignalDispatcher.h.

---

Member Typedef Documentation

typedef std::vector<std::pair<Name,EventIdentifier> > OMK::SignalDispatcher::_VectorType [protected]

the type of data structure associated to a signal

Definition at line 74 of file OMKSignalDispatcher.h.

typedef std::map<EventIdentifier, _VectorType * > OMK::SignalDispatcher::_TableType [protected]

the type of data structure remembering who is registred to what signal

Definition at line 77 of file OMKSignalDispatcher.h.

---

Constructor & Destructor Documentation

SignalDispatcher::SignalDispatcher

(

Controller &

controller

)

constructor

Parameters:

controller

a controller used to get reference to object handles to send the events

Definition at line 28 of file OMKSignalDispatcher.cpp.

                                                     :
   _controler (ctrl) 
{

}

SignalDispatcher::~SignalDispatcher

(

)

[virtual]

destrcutor

Definition at line 34 of file OMKSignalDispatcher.cpp.

References _tableOfRegistredObjects.

                                    {
   for (_TableType::iterator i = _tableOfRegistredObjects.begin() ;
        i !=  _tableOfRegistredObjects.end() ;
        i++ )
      {
         delete (*i).second ;
      }
}

---

Member Function Documentation

void SignalDispatcher::sendEventsForSignal	(	Event &	event,
		const EventIdentifier &	sigId
	)			[virtual]

send the events correponding to signal sigId

Parameters:

	event	a prototype for the event send
	sigId	the signal for wich the events are dispatched

Definition at line 43 of file OMKSignalDispatcher.cpp.

References _controler, _tableOfRegistredObjects, OMK::Event::eventId, OMK::SimulatedObject::getObjectHandle(), OMK::Controller::getPointerToSimulatedObjectNamed(), OMK::ObjectHandle::receiveEvent(), and OMK::Event::receiver.

Referenced by OMK::Controller::broadcastEventsForSignal(), and OMK::ReferenceObjectHandle::sendEventsForSignal().

{
   //cerr<<"SignalDispatcher:"<<this<<":sendEventsForSignal "<<sigId<<endl;
#ifdef _OMK_MUTEX_
   _mutexForRegistredObjectsTable.protect() ;
#endif
   _TableType::iterator i = _tableOfRegistredObjects.find ( sigId ) ;
   if (i != _tableOfRegistredObjects.end() )
      {
         _VectorType::iterator listIterator = (*i).second->begin();
         while ( listIterator != (*i).second->end() )
            {
               event.receiver = listIterator->first ;
               event.eventId = listIterator->second ;
               SimulatedObject * receiver = _controler.getPointerToSimulatedObjectNamed(event.receiver) ;
               if ( receiver != NULL ) 
                  {
                     receiver->getObjectHandle()->receiveEvent(event) ;
                     listIterator ++ ;
                  }
               else 
                  {
                     // we suppose the objet no longer exists
                     cerr<<"WARNING : OMKReferenceObjectHandle::sendSignalAsEvent "
                         <<receiver
                         << "no longer seems to exists : deleted from data structure "<<endl;
                     listIterator = (*i).second->erase ( listIterator ) ; 
                  }
            }
      }
#ifdef _OMK_MUTEX_
   _mutexForRegistredObjectsTable.unprotect() ;
#endif
}

bool SignalDispatcher::registerForSignal	(	const EventIdentifier &	sigId,
		const Name &	registrant,
		const EventIdentifier &	eventId
	)			[virtual]

register an object for a signal

Parameters:

	sigId	the signal to react to
	registrant	the simulated object registering to signal sigId
	eventId	the eventId to send to registrant when sigId is emitted

Definition at line 79 of file OMKSignalDispatcher.cpp.

References _tableOfRegistredObjects.

Referenced by OMK::DistributedController::processEvent(), OMK::ReferenceObjectHandle::receiveRegistrationForSignal(), and OMK::Controller::receiveRegistrationForSignal().

{
//   cerr << "SignalDispatcher: " << this << " :registerForSignal on "<< sigId <<" send "<< eventId <<" to " << registrant << endl ;
#ifdef _OMK_MUTEX_
  _mutexForRegistredObjectsTable.protect() ;
#endif
  _TableType::iterator i = _tableOfRegistredObjects.find ( sigId ) ;
  if (i == _tableOfRegistredObjects.end() )
    {
      _tableOfRegistredObjects[sigId] = new _VectorType( 1, pair<Name, EventIdentifier>( registrant, eventId ) );
    }
  else 
    {
      _VectorType::iterator j = (*i).second->begin() ;
      while ( j != (*i).second->end() )
        {
          if ( ( *j ).first == registrant )
            {
              j = (*i).second->erase( j ) ;
            }
          else
            {
              ++j ;
            }
        }
      ( *i ).second->push_back( pair <Name, EventIdentifier> 
                                ( registrant, eventId ) );
    }
  
#ifdef _OMK_MUTEX_
  _mutexForRegistredObjectsTable.unprotect() ;
#endif
  return true ;
}

bool SignalDispatcher::cancelRegistrationForSignal	(	const EventIdentifier &	sigId,
		const Name &	registrant
	)			[virtual]

cancel the registration of an object for a signal

Parameters:

	sigId	the signal for wich there is a cancellation
	registrant	the object cancelling registration

Definition at line 117 of file OMKSignalDispatcher.cpp.

References _tableOfRegistredObjects.

Referenced by OMK::ReferenceObjectHandle::cancelRegistrationForSignal(), OMK::DistributedController::processEvent(), and OMK::Controller::receiveCancellationForSignal().

{
#ifdef _OMK_MUTEX_
   _mutexForRegistredObjectsTable.protect() ;
#endif
   _TableType::iterator i = _tableOfRegistredObjects.find ( sigId ) ;
   if (i != _tableOfRegistredObjects.end() )
      {
         _VectorType::iterator listIterator = (*i).second->begin();
         while ( listIterator != (*i).second->end() )
            {
               if (listIterator->first == registrant ) 
                  {
                     listIterator = (*i).second->erase( listIterator ) ;
                  }
               else
                  {
                     listIterator++ ;
                  }
            }
      }
#ifdef _OMK_MUTEX_
   _mutexForRegistredObjectsTable.unprotect() ;   
#endif
   return true ;
}

---

Member Data Documentation

Controller& OMK::SignalDispatcher::_controler [protected]

the controller used to find the reference handles to objects registering

Definition at line 71 of file OMKSignalDispatcher.h.

Referenced by sendEventsForSignal().

_TableType OMK::SignalDispatcher::_tableOfRegistredObjects [protected]

the table of registref objects

Definition at line 80 of file OMKSignalDispatcher.h.

Referenced by cancelRegistrationForSignal(), registerForSignal(), sendEventsForSignal(), and ~SignalDispatcher().

---