src/SMESH/SMESH_subMesh.hxx

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