src/SMESH/SMESH_subMesh.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_subMesh.hxx
  25 //  Author : Paul RASCLE, EDF
  26 //  Module : SMESH
  27 //  $Header$
  28
  29 #ifndef _SMESH_SUBMESH_HXX_
  30 #define _SMESH_SUBMESH_HXX_
  31
  32 #include "SMESHDS_Mesh.hxx"
  33 #include "SMESHDS_SubMesh.hxx"
  34 #include "SMESH_Hypothesis.hxx"
  35 #include "Utils_SALOME_Exception.hxx"
  36 #include <TopoDS_Shape.hxx>
  37 #include <TColStd_IndexedMapOfTransient.hxx>
  38 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
  39
  40 #include <set>
  41 #include <list>
  42 #include <map>
  43
  44 class SMESH_Mesh;
  45 class SMESH_Hypothesis;
  46 class SMESH_Algo;
  47 class SMESH_Gen;
  48 class SMESH_subMeshEventListener;
  49 class SMESH_subMeshEventListenerData;
  50
  51 typedef SMESH_subMeshEventListener     EventListener;
  52 typedef SMESH_subMeshEventListenerData EventListenerData;
  53
  54 class SMESH_subMesh
  55 {
  56  public:
  57   SMESH_subMesh(int Id, SMESH_Mesh * father, SMESHDS_Mesh * meshDS,
  58                 const TopoDS_Shape & aSubShape);
  59   virtual ~ SMESH_subMesh();
  60
  61   int GetId() const;
  62
  63   //   bool Contains(const TopoDS_Shape & aSubShape)
  64   //     throw (SALOME_Exception);
  65
  66   SMESH_Mesh* GetFather() { return _father; }
  67
  68   SMESHDS_SubMesh * GetSubMeshDS();
  69
  70   SMESHDS_SubMesh* CreateSubMeshDS();
  71   // Explicit SMESHDS_SubMesh creation method, required for persistence mechanism
  72
  73   SMESH_subMesh *GetFirstToCompute();
  74
  75   const map < int, SMESH_subMesh * >&DependsOn();
  76   //const map < int, SMESH_subMesh * >&Dependants();
  77
  78   const TopoDS_Shape & GetSubShape() const;
  79
  80   enum compute_state
  81   {
  82     NOT_READY, READY_TO_COMPUTE,
  83     COMPUTE_OK, FAILED_TO_COMPUTE
  84     };
  85   enum algo_state
  86   {
  87     NO_ALGO, MISSING_HYP, HYP_OK
  88     };
  89   enum algo_event
  90   {
  91     ADD_HYP, ADD_ALGO,
  92     REMOVE_HYP, REMOVE_ALGO,
  93     ADD_FATHER_HYP, ADD_FATHER_ALGO,
  94     REMOVE_FATHER_HYP, REMOVE_FATHER_ALGO
  95     };
  96   enum compute_event
  97   {
  98     MODIF_HYP, MODIF_ALGO_STATE, COMPUTE,
  99     CLEAN, SUBMESH_COMPUTED, SUBMESH_RESTORED,
 100     MESH_ENTITY_REMOVED, CHECK_COMPUTE_STATE
 101     };
 102   enum event_type
 103   {
 104     ALGO_EVENT, COMPUTE_EVENT
 105   };
 106
 107   // ==================================================================
 108   // Members to track non hierarchical dependencies between submeshes
 109   // ==================================================================
 110
 111   /*!
 112    * \brief Sets an event listener and its data to a submesh
 113     * \param listener - the listener to store
 114     * \param data - the listener data to store
 115     * \param where - the submesh to store the listener and it's data
 116     * \param deleteListener - if true then the listener will be deleted as
 117     *        it is removed from where submesh
 118    *
 119    * It remembers the submesh where it puts the listener in order to delete
 120    * them when HYP_OK algo_state is lost
 121    * After being set, event listener is notified on each event of where submesh.
 122    */
 123   void SetEventListener(EventListener*     listener,
 124                         EventListenerData* data,
 125                         SMESH_subMesh*     where);
 126
 127   /*!
 128    * \brief Return an event listener data
 129     * \param listener - the listener whose data is
 130     * \retval EventListenerData* - found data, maybe NULL
 131    */
 132   EventListenerData* GetEventListenerData(EventListener* listener) const;
 133
 134   /*!
 135    * \brief Unregister the listener and delete it and it's data
 136     * \param listener - the event listener to delete
 137    */
 138   void DeleteEventListener(EventListener* listener);
 139
 140 protected:
 141
 142   //!< event listeners to notify
 143   std::map< EventListener*, EventListenerData* >           myEventListeners;
 144   //!< event listeners to delete when HYP_OK algo_state is lost
 145   std::list< std::pair< SMESH_subMesh*, EventListener* > > myOwnListeners;
 146
 147   /*!
 148    * \brief Sets an event listener and its data to a submesh
 149     * \param listener - the listener to store
 150     * \param data - the listener data to store
 151    *
 152    * After being set, event listener is notified on each event of a submesh.
 153    */
 154   void SetEventListener(EventListener* listener, EventListenerData* data);
 155
 156   /*!
 157    * \brief Notify stored event listeners on the occured event
 158    * \param event - algo_event or compute_event itself
 159    * \param eventType - algo_event or compute_event
 160    * \param hyp - hypothesis, if eventType is algo_event
 161    */
 162   void NotifyListenersOnEvent( const int         event,
 163                                const event_type  eventType,
 164                                SMESH_Hypothesis* hyp = 0);
 165
 166   /*!
 167    * \brief Delete event listeners depending on algo of this submesh
 168    */
 169   void DeleteOwnListeners();
 170
 171   // ==================================================================
 172
 173 public:
 174
 175   SMESH_Hypothesis::Hypothesis_Status
 176     AlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
 177
 178   SMESH_Hypothesis::Hypothesis_Status
 179     SubMeshesAlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
 180
 181   int GetAlgoState() const { return _algoState; }
 182   int GetComputeState() const { return _computeState; };
 183
 184   void DumpAlgoState(bool isMain);
 185
 186   bool ComputeStateEngine(int event);
 187
 188   bool IsConform(const SMESH_Algo* theAlgo);
 189   // check if a conform mesh will be produced by the Algo
 190
 191   bool CanAddHypothesis(const SMESH_Hypothesis* theHypothesis) const;
 192   // return true if theHypothesis can be attached to me:
 193   // its dimention is checked
 194
 195   static bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis,
 196                                     const TopAbs_ShapeEnum  theShapeType);
 197
 198   bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis) const
 199   { return IsApplicableHypotesis( theHypothesis, _subShape.ShapeType() ); }
 200   // return true if theHypothesis can be used to mesh me:
 201   // its shape type is checked
 202
 203   SMESH_Hypothesis::Hypothesis_Status CheckConcurentHypothesis (const int theHypType);
 204   // check if there are several applicable hypothesis on fathers
 205
 206   bool IsMeshComputed() const;
 207   // check if _subMeshDS contains mesh elements
 208
 209 protected:
 210   // ==================================================================
 211   void InsertDependence(const TopoDS_Shape aSubShape);
 212
 213   bool SubMeshesComputed();
 214
 215   bool SubMeshesReady();
 216
 217   void RemoveSubMeshElementsAndNodes();
 218   void UpdateDependantsState(const compute_event theEvent);
 219   void UpdateSubMeshState(const compute_state theState);
 220   void ComputeSubMeshStateEngine(int event);
 221   void CleanDependants();
 222   void CleanDependsOn();
 223   void SetAlgoState(int state);
 224
 225   TopoDS_Shape GetCollection(SMESH_Gen * theGen, SMESH_Algo* theAlgo);
 226   // return a shape containing all sub-shapes of the MainShape that can be
 227   // meshed at once along with _subShape
 228
 229   bool ApplyToCollection (SMESH_Algo*         theAlgo,
 230                           const TopoDS_Shape& theCollection);
 231   // Apply theAlgo to all subshapes in theCollection
 232
 233   const SMESH_Hypothesis* GetSimilarAttached(const TopoDS_Shape&      theShape,
 234                                              const SMESH_Hypothesis * theHyp,
 235                                              const int                theHypType = 0);
 236   // return a hypothesis attached to theShape.
 237   // If theHyp is provided, similar but not same hypotheses
 238   // is returned; else an applicable ones having theHypType
 239   // is returned
 240
 241   TopoDS_Shape _subShape;
 242   SMESHDS_Mesh * _meshDS;
 243   SMESHDS_SubMesh * _subMeshDS;
 244   int _Id;
 245   SMESH_Mesh *_father;
 246   map < int, SMESH_subMesh * >_mapDepend;
 247   bool _dependenceAnalysed;
 248
 249   int _algoState;
 250   int _computeState;
 251
 252 };
 253
 254 #endif