src/SMESH/SMESH_subMeshEventListener.hxx

   1 //  SMESH SMESH : implementaion of SMESH idl descriptions
   2 //
   3 //  Copyright (C) 2003  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 //
  24 // File      : SMESH_subMeshEventListener.hxx
  25 // Created   : Mon Nov 13 10:45:49 2006
  26 // Author    : Edward AGAPOV (eap)
  27
  28
  29 #ifndef SMESH_subMeshEventListener_HeaderFile
  30 #define SMESH_subMeshEventListener_HeaderFile
  31
  32 #include "SMESH_SMESH.hxx"
  33
  34 #include <list>
  35
  36 class  SMESH_subMesh;
  37 class  SMESH_Hypothesis;
  38 struct SMESH_subMeshEventListenerData;
  39
  40 // ------------------------------------------------------------------
  41 /*!
  42  * \brief A base for objects reacting on submesh events
  43  */
  44 // ------------------------------------------------------------------
  45
  46 class SMESH_EXPORT SMESH_subMeshEventListener {
  47   bool myIsDeletable; //!< if true, it will be deleted by SMESH_subMesh
  48 public:
  49   SMESH_subMeshEventListener(bool isDeletable):myIsDeletable(isDeletable) {}
  50   bool IsDeletable() const { return myIsDeletable; }
  51   /*!
  52    * \brief Do something on a certain event
  53    * \param event - algo_event or compute_event itself (of SMESH_subMesh)
  54    * \param eventType - ALGO_EVENT or COMPUTE_EVENT (of SMESH_subMesh)
  55    * \param subMesh - the submesh where the event occures
  56    * \param data - listener data stored in the subMesh
  57    * \param hyp - hypothesis, if eventType is algo_event
  58    *
  59    * The base implementation translates CLEAN event to the subMesh stored
  60    * in the listener data. Also it sends SUBMESH_COMPUTED event in case of
  61    * successful COMPUTE event.
  62    */
  63   virtual void ProcessEvent(const int          event,
  64                             const int          eventType,
  65                             SMESH_subMesh*     subMesh,
  66                             SMESH_subMeshEventListenerData* data,
  67                             const SMESH_Hypothesis*         hyp = 0);
  68 };
  69
  70 // ------------------------------------------------------------------
  71 /*!
  72  * \brief Data specific for EventListener and to be stored in a submesh
  73  */
  74 // ------------------------------------------------------------------
  75
  76 struct SMESH_subMeshEventListenerData
  77 {
  78   bool myIsDeletable; //!< if true, it will be deleted by SMESH_subMesh
  79   int myType;         //!< to recognize data type
  80   std::list<SMESH_subMesh*> mySubMeshes; //!< generally: submeshes depending
  81                                          // on the one storing this data
  82 public:
  83   SMESH_subMeshEventListenerData(bool isDeletable):myIsDeletable(isDeletable) {}
  84   bool IsDeletable() const { return myIsDeletable; }
  85
  86   /*!
  87    * \brief Create a default listener data.
  88    * \param dependentSM - subMesh to store
  89    * \param type - data type
  90    * \retval SMESH_subMeshEventListenerData* - a new listener data
  91    *
  92    * See SMESH_subMeshEventListener::ProcessEvent() to know how the default
  93    * listener uses it (implementation is in SMESH_subMesh.cxx)
  94    */
  95   static SMESH_subMeshEventListenerData* MakeData(SMESH_subMesh* dependentSM,
  96                                                   const int      type = 0)
  97   {
  98     SMESH_subMeshEventListenerData* data = new SMESH_subMeshEventListenerData(true);
  99     data->mySubMeshes.push_back( dependentSM );
 100     data->myType = type;
 101     return data;
 102   }
 103 };
 104
 105
 106 #endif