src/SMESH/SMESH_subMeshEventListener.hxx

   1 // Copyright (C) 2007-2011  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 // File    : SMESH_subMeshEventListener.hxx
  24 // Created : Mon Nov 13 10:45:49 2006
  25 // Author  : Edward AGAPOV (eap)
  26 //
  27 #ifndef SMESH_subMeshEventListener_HeaderFile
  28 #define SMESH_subMeshEventListener_HeaderFile
  29
  30 #include "SMESH_SMESH.hxx"
  31
  32 #include <list>
  33 #include <set>
  34
  35 class  SMESH_subMesh;
  36 class  SMESH_Hypothesis;
  37 struct SMESH_subMeshEventListenerData;
  38
  39 // ------------------------------------------------------------------
  40 /*!
  41  * \brief A base for objects reacting on submesh events
  42  */
  43 // ------------------------------------------------------------------
  44
  45 class SMESH_EXPORT SMESH_subMeshEventListener
  46 {
  47   bool myIsDeletable; //!< if true, it will be deleted by SMESH_subMesh
  48   mutable std::set<SMESH_subMesh*> myBusySM; //!< to avoid infinite recursion via events
  49   friend class SMESH_subMesh;
  50 public:
  51   SMESH_subMeshEventListener(bool isDeletable):myIsDeletable(isDeletable) {}
  52   bool IsDeletable() const { return myIsDeletable; }
  53   /*!
  54    * \brief Do something on a certain event
  55    * \param event - algo_event or compute_event itself (of SMESH_subMesh)
  56    * \param eventType - ALGO_EVENT or COMPUTE_EVENT (of SMESH_subMesh)
  57    * \param subMesh - the submesh where the event occures
  58    * \param data - listener data stored in the subMesh
  59    * \param hyp - hypothesis, if eventType is algo_event
  60    *
  61    * The base implementation (see SMESH_subMesh.cxx) translates CLEAN event
  62    * to the subMeshes stored in the listener data. Also it sends SUBMESH_COMPUTED
  63    * event in case of successful COMPUTE event.
  64    */
  65   virtual void ProcessEvent(const int          event,
  66                             const int          eventType,
  67                             SMESH_subMesh*     subMesh,
  68                             SMESH_subMeshEventListenerData* data,
  69                             const SMESH_Hypothesis*         hyp = 0);
  70 };
  71
  72 // ------------------------------------------------------------------
  73 /*!
  74  * \brief Data specific for EventListener and to be stored in a submesh
  75  */
  76 // ------------------------------------------------------------------
  77
  78 struct SMESH_subMeshEventListenerData
  79 {
  80   bool myIsDeletable; //!< if true, it will be deleted by SMESH_subMesh
  81   int myType;         //!< to recognize data type
  82   std::list<SMESH_subMesh*> mySubMeshes; //!< generally: submeshes depending
  83                                          // on the one storing this data
  84 public:
  85   SMESH_subMeshEventListenerData(bool isDeletable):myIsDeletable(isDeletable) {}
  86   virtual ~SMESH_subMeshEventListenerData() {}
  87   bool IsDeletable() const { return myIsDeletable; }
  88
  89   /*!
  90    * \brief Create a default listener data.
  91    * \param dependentSM - subMesh to store
  92    * \param type - data type
  93    * \retval SMESH_subMeshEventListenerData* - a new listener data
  94    *
  95    * See SMESH_subMeshEventListener::ProcessEvent() to know how the default
  96    * listener uses it (implementation is in SMESH_subMesh.cxx)
  97    */
  98   static SMESH_subMeshEventListenerData* MakeData(SMESH_subMesh* dependentSM,
  99                                                   const int      type = 0)
 100   {
 101     SMESH_subMeshEventListenerData* data = new SMESH_subMeshEventListenerData(true);
 102     data->mySubMeshes.push_back( dependentSM );
 103     data->myType = type;
 104     return data;
 105   }
 106 };
 107
 108
 109 #endif