src/engine/Dispatcher.hxx

   1 // Copyright (C) 2006-2015  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef __DISPATCHER_HXX__
  21 #define __DISPATCHER_HXX__
  22
  23 #include "YACSlibEngineExport.hxx"
  24
  25 #include <set>
  26 #include <string>
  27 #include <map>
  28
  29 namespace YACS
  30 {
  31   namespace ENGINE
  32   {
  33     class Node;
  34     class Executor;
  35
  36 /*! \brief Base class for observer in observer pattern
  37  *
  38  * When an event occurs, a registered observer is notified by
  39  * calling its notifyObserver method with 2 arguments : the object
  40  * which has emitted the event and the event type. There is no more
  41  * data. It's the responsability of the observer to request all needed
  42  * information from the emitting object.
  43  *
  44  */
  45     class YACSLIBENGINE_EXPORT Observer
  46     {
  47     public:
  48       virtual void notifyObserver(Node* object,const std::string& event);
  49       virtual ~Observer();
  50     };
  51
  52 /*! \brief Base class for dispatcher in observer pattern
  53  *
  54  * Dispatcher and Observer objects can be used to be notified about events
  55  * that occurs in editing or executing a calculation schema.
  56  *
  57  * When an object wants to notify an event, it calls the dispatch method
  58  * of the dispatcher with 2 arguments : the object reference and an event type.
  59  * The dispatcher which is a singleton is obtained by calling the class method
  60  * getDispatcher.
  61  * The dispatcher notifies all the registered observers by calling their notifyObserver
  62  * method.
  63  *
  64  * Observers can be registered by calling the addObserver method with two
  65  * arguments : an object reference and an event type. This observer will be
  66  * notify with events coming only from this object.
  67  *
  68  * Limitation : emitting objects can be only Node
  69  *
  70  */
  71     class YACSLIBENGINE_EXPORT Dispatcher
  72     {
  73     public:
  74       virtual void dispatch(Node* object,const std::string& event);
  75       virtual void addObserver(Observer* observer,Node* object,const std::string& event);
  76       virtual void removeObserver(Observer* observer,Node* object,const std::string& event);
  77       virtual void printObservers();
  78       static Dispatcher* getDispatcher();
  79       static void setDispatcher(Dispatcher* dispatcher);
  80       virtual ~Dispatcher();
  81     protected:
  82       std::map< std::pair<Node*,std::string> , std::set<Observer*> > _observers;
  83       std::map< std::pair<Executor*,std::string> , std::set<Observer*> > _observExec;
  84       static Dispatcher* _singleton;
  85     };
  86
  87   }
  88 }
  89
  90 #endif