YACS::ENGINE::Dispatcher Class Reference

Base class for dispatcher in observer pattern. More...

#include <Dispatcher.hxx>

Inheritance diagram for YACS::ENGINE::Dispatcher:

Collaboration diagram for YACS::ENGINE::Dispatcher:

Public Member Functions
virtual void	dispatch (Node *object, const std::string &event)
virtual void	dispatch2 (Node *object, const std::string &event, void *something)
virtual void	dispatchFromClone (Node *originalInstance, const std::string &event, Node *clonedInstanceGeneratingEvent)
virtual void	addObserver (Observer *observer, Node *object, const std::string &event)
virtual void	removeObserver (Observer *observer, Node *object, const std::string &event)
virtual void	printObservers ()
virtual	~Dispatcher ()

Static Public Member Functions
static Dispatcher *	getDispatcher ()
static void	setDispatcher (Dispatcher *dispatcher)

Protected Attributes
std::map< std::pair< Node *, std::string >, std::set< Observer * > >	_observers

Static Protected Attributes
static Dispatcher *	_singleton = 0

Detailed Description

Base class for dispatcher in observer pattern.

Dispatcher and Observer objects can be used to be notified about events that occurs in editing or executing a calculation schema.

When an object wants to notify an event, it calls the dispatch method of the dispatcher with 2 arguments : the object reference and an event type. The dispatcher which is a singleton is obtained by calling the class method getDispatcher. The dispatcher notifies all the registered observers by calling their notifyObserver method.

Observers can be registered by calling the addObserver method with two arguments : an object reference and an event type. This observer will be notify with events coming only from this object.

Limitation : emitting objects can be only Node

Definition at line 73 of file Dispatcher.hxx.

Constructor & Destructor Documentation

~Dispatcher()

Dispatcher::~Dispatcher ( )

virtual

Definition at line 50 of file Dispatcher.cxx.

{
  Dispatcher::_singleton =0;
}

References _singleton.

Member Function Documentation

addObserver()

void Dispatcher::addObserver ( Observer *  observer, Node *  object, const std::string &  event  )

virtual

Definition at line 125 of file Dispatcher.cxx.

{
  _observers[std::pair<Node*,std::string>(object,event)].insert(observer);
//  printObservers();
}

References _observers.

Referenced by DefineCustomObservers(), and YACS::HMI::SubjectNode::SubjectNode().

dispatch()

void Dispatcher::dispatch ( Node *  object, const std::string &  event  )

virtual

Reimplemented in MyDispatcher, and YACS::ENGINE::SALOMEDispatcher.

Definition at line 85 of file Dispatcher.cxx.

{
  DEBTRACE("Dispatcher::dispatch " << event );
  std::pair<Node*,std::string> key(object,event);
  std::map< std::pair<Node*,std::string> , std::set<Observer*> >::const_iterator it(_observers.find(key));
  if(it!=_observers.end())
    {
      for(std::set<Observer*>::const_iterator iter=(*it).second.begin();iter!=(*it).second.end();iter++)
        {
          (*iter)->notifyObserver(object,event);
        }
    }
}

References _observers, and DEBTRACE.

Referenced by YACS::ENGINE::Executor::sendEvent(), and YACS::ENGINE::Node::sendEvent().

dispatch2()

void Dispatcher::dispatch2 ( Node *  object, const std::string &  event, void *  something  )

virtual

Definition at line 99 of file Dispatcher.cxx.

{
  std::pair<Node*,std::string> key(object,event);
  std::map< std::pair<Node*,std::string> , std::set<Observer*> >::const_iterator it(_observers.find(key));
  if(it!=_observers.end())
    {
      for(std::set<Observer*>::const_iterator iter=(*it).second.begin();iter!=(*it).second.end();iter++)
        {
          (*iter)->notifyObserver2(object,event,something);
        }
    }
}

References _observers.

Referenced by YACS::ENGINE::Node::sendEvent2().

dispatchFromClone()

void Dispatcher::dispatchFromClone ( Node *  originalInstance, const std::string &  event, Node *  clonedInstanceGeneratingEvent  )

virtual

Definition at line 112 of file Dispatcher.cxx.

{
  std::pair<Node*,std::string> key(originalInstance,event);
  std::map< std::pair<Node*,std::string> , std::set<Observer*> >::const_iterator it(_observers.find(key));
  if(it!=_observers.end())
    {
      for(std::set<Observer*>::const_iterator iter=(*it).second.begin();iter!=(*it).second.end();iter++)
        {
          (*iter)->notifyObserverFromClone(originalInstance,event,clonedInstanceGeneratingEvent);
        }
    }
}

References _observers.

Referenced by YACS::ENGINE::Node::sendEvent().

getDispatcher()

Dispatcher * Dispatcher::getDispatcher ( )

static

Definition at line 55 of file Dispatcher.cxx.

{
  if ( !Dispatcher::_singleton )
    {
       Dispatcher::_singleton =new Dispatcher;
    }
  return Dispatcher::_singleton;
}

References _singleton.

Referenced by Yacs_i::addObserver(), main(), YACS::ENGINE::Executor::sendEvent(), YACS::ENGINE::Node::sendEvent(), and YACS::ENGINE::Node::sendEvent2().

printObservers()

void Dispatcher::printObservers ( )

virtual

Definition at line 69 of file Dispatcher.cxx.

{
  std::cerr << "Dispatcher::printObservers " << std::endl;
  typedef std::map< std::pair<Node*,std::string> , std::set<Observer*> >::iterator it;
  typedef std::set<Observer*>::iterator jt;
 
  for(it i=_observers.begin();i!=_observers.end();i++)
    {
      std::cerr << "Node*: " << (*i).first.first << " event: " << (*i).first.second << std::endl;
      for(jt j=(*i).second.begin();j!=(*i).second.end();j++)
        {
          std::cerr << "observer: " << *j << std::endl;
        }
    }
}

References _observers, and yacsorb.CORBAEngineTest::i.

removeObserver()

void Dispatcher::removeObserver ( Observer *  observer, Node *  object, const std::string &  event  )

virtual

Definition at line 131 of file Dispatcher.cxx.

{
  _observers[std::pair<Node*,std::string>(object,event)].erase(observer);
//  printObservers();
}

References _observers.

Referenced by PluginObserverKeeper::clean().

setDispatcher()

void Dispatcher::setDispatcher ( Dispatcher *  dispatcher )

static

Definition at line 64 of file Dispatcher.cxx.

{
  Dispatcher::_singleton=dispatcher;
}

References _singleton, and gui.CItems::dispatcher.

Referenced by main(), and YACS::ENGINE::SALOMEDispatcher::setSALOMEDispatcher().

Member Data Documentation

_observers

std::map< std::pair<Node*,std::string> , std::set<Observer*> > YACS::ENGINE::Dispatcher::_observers

protected

Definition at line 86 of file Dispatcher.hxx.

Referenced by addObserver(), dispatch(), dispatch2(), dispatchFromClone(), printObservers(), and removeObserver().

_singleton

Dispatcher * Dispatcher::_singleton = 0

staticprotected

Definition at line 87 of file Dispatcher.hxx.

Referenced by getDispatcher(), setDispatcher(), and ~Dispatcher().

---

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

• src/engine/Dispatcher.hxx
• src/engine/Dispatcher.cxx