Salome HOME
52447: Re-compute fails after hypothesis modification
[modules/smesh.git] / src / SMESH / SMESH_subMesh.hxx
index 9770d6da0a0c7200e52febbb24516c8ea804b612..36a37740080173452ce1e9322e33a44836d31b5e 100644 (file)
@@ -1,31 +1,29 @@
-//  SMESH SMESH : implementaion of SMESH idl descriptions
+// Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
 //
-//  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
-// 
-//  This library is free software; you can redistribute it and/or 
-//  modify it under the terms of the GNU Lesser General Public 
-//  License as published by the Free Software Foundation; either 
-//  version 2.1 of the License. 
-// 
-//  This library is distributed in the hope that it will be useful, 
-//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
-//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
-//  Lesser General Public License for more details. 
-// 
-//  You should have received a copy of the GNU Lesser General Public 
-//  License along with this library; if not, write to the Free Software 
-//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
-// 
-// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
 //
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
 //
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
 //  File   : SMESH_subMesh.hxx
 //  Author : Paul RASCLE, EDF
 //  Module : SMESH
-//  $Header$
-
+//
 #ifndef _SMESH_SUBMESH_HXX_
 #define _SMESH_SUBMESH_HXX_
 
@@ -35,6 +33,7 @@
 #include "SMESHDS_SubMesh.hxx"
 #include "SMESH_Hypothesis.hxx"
 #include "SMESH_ComputeError.hxx"
+#include "SMESH_Algo.hxx"
 
 #include "Utils_SALOME_Exception.hxx"
 
@@ -60,28 +59,34 @@ typedef boost::shared_ptr< SMDS_Iterator<SMESH_subMesh*> > SMESH_subMeshIterator
 class SMESH_EXPORT SMESH_subMesh
 {
  public:
-  SMESH_subMesh(int Id, SMESH_Mesh * father, SMESHDS_Mesh * meshDS,
-               const TopoDS_Shape & aSubShape);
+  SMESH_subMesh(int                  Id,
+                SMESH_Mesh *         father,
+                SMESHDS_Mesh *       meshDS,
+                const TopoDS_Shape & aSubShape);
   virtual ~ SMESH_subMesh();
 
-  int GetId() const;
+  int GetId() const; // == meshDS->ShapeToIndex( aSubShape )
 
   SMESH_Mesh* GetFather() { return _father; }
   
-  SMESHDS_SubMesh * GetSubMeshDS();
+  SMESHDS_SubMesh *       GetSubMeshDS();
+  const SMESHDS_SubMesh * GetSubMeshDS() const;
 
   SMESHDS_SubMesh* CreateSubMeshDS();
   // Explicit SMESHDS_SubMesh creation method, required for persistence mechanism
 
   SMESH_subMesh *GetFirstToCompute();
 
-  const map < int, SMESH_subMesh * >& DependsOn();
-  //const map < int, SMESH_subMesh * >&Dependants();
+  SMESH_Algo* GetAlgo() const;
+
+  const std::map < int, SMESH_subMesh * >& DependsOn();
+  bool DependsOn( const SMESH_subMesh* other ) const;
   /*!
-   * \brief Return iterator on the submeshes this one depends on
+   * \brief Return iterator on the sub-meshes this one depends on. By default
+   *        most simple sub-meshes go first.
    */
   SMESH_subMeshIteratorPtr getDependsOnIterator(const bool includeSelf,
-                                                const bool complexShapeFirst);
+                                                const bool complexShapeFirst=false) const;
 
   const TopoDS_Shape & GetSubShape() const;
 
@@ -89,11 +94,11 @@ class SMESH_EXPORT SMESH_subMesh
   {
     NOT_READY, READY_TO_COMPUTE,
     COMPUTE_OK, FAILED_TO_COMPUTE
-    };
+  };
   enum algo_state
   {
     NO_ALGO, MISSING_HYP, HYP_OK
-    };
+  };
   enum algo_event
   {
     ADD_HYP          , ADD_ALGO,
@@ -101,13 +106,13 @@ class SMESH_EXPORT SMESH_subMesh
     ADD_FATHER_HYP   , ADD_FATHER_ALGO,
     REMOVE_FATHER_HYP, REMOVE_FATHER_ALGO,
     MODIF_HYP
-    };
+  };
   enum compute_event
   {
-    MODIF_ALGO_STATE, COMPUTE,
-    CLEAN, SUBMESH_COMPUTED, SUBMESH_RESTORED,
+    MODIF_ALGO_STATE, COMPUTE, COMPUTE_SUBMESH, COMPUTE_CANCELED,
+    CLEAN, SUBMESH_COMPUTED, SUBMESH_RESTORED, SUBMESH_LOADED,
     MESH_ENTITY_REMOVED, CHECK_COMPUTE_STATE
-    };
+  };
   enum event_type
   {
     ALGO_EVENT, COMPUTE_EVENT
@@ -124,7 +129,7 @@ class SMESH_EXPORT SMESH_subMesh
     * \param where - the submesh to store the listener and it's data
    * 
    * The method remembers the submesh \awhere it puts the listener in order to delete
-   * them when HYP_OK algo_state is lost
+   * it when HYP_OK algo_state is lost
    * After being set, event listener is notified on each event of \awhere submesh.
    */
   void SetEventListener(EventListener*     listener,
@@ -134,9 +139,22 @@ class SMESH_EXPORT SMESH_subMesh
   /*!
    * \brief Return an event listener data
     * \param listener - the listener whose data is
+    * \param myOwn - if \c true, returns a listener set by this sub-mesh,
+    *        else returns a listener listening to events of this sub-mesh
     * \retval EventListenerData* - found data, maybe NULL
    */
-  EventListenerData* GetEventListenerData(EventListener* listener) const;
+  EventListenerData* GetEventListenerData(EventListener* listener,
+                                          const bool     myOwn=false) const;
+
+  /*!
+   * \brief Return an event listener data
+    * \param listenerName - the listener name
+    * \param myOwn - if \c true, returns a listener set by this sub-mesh,
+    *        else returns a listener listening to events of this sub-mesh
+    * \retval EventListenerData* - found data, maybe NULL
+   */
+  EventListenerData* GetEventListenerData(const std::string& listenerName,
+                                          const bool         myOwn=false) const;
 
   /*!
    * \brief Unregister the listener and delete it and it's data
@@ -147,9 +165,17 @@ class SMESH_EXPORT SMESH_subMesh
 protected:
 
   //!< event listeners to notify
-  std::map< EventListener*, EventListenerData* >           myEventListeners;
+  std::map< EventListener*, EventListenerData* > _eventListeners;
+
   //!< event listeners to delete when HYP_OK algo_state is lost
-  std::list< std::pair< SMESH_subMesh*, EventListener* > > myOwnListeners;
+  struct OwnListenerData {
+    SMESH_subMesh* mySubMesh;
+    int            myMeshID; // id of mySubMesh->GetFather()
+    int            mySubMeshID;
+    EventListener* myListener;
+    OwnListenerData( SMESH_subMesh* sm=0, EventListener* el=0);
+  };
+  std::list< OwnListenerData >                    _ownListeners;
 
   /*!
    * \brief Sets an event listener and its data to a submesh
@@ -158,7 +184,7 @@ protected:
    * 
    * After being set, event listener is notified on each event of a submesh.
    */
-  void SetEventListener(EventListener* listener, EventListenerData* data);
+  void setEventListener(EventListener* listener, EventListenerData* data);
 
   /*!
    * \brief Notify stored event listeners on the occured event
@@ -166,16 +192,22 @@ protected:
    * \param eventType - algo_event or compute_event
    * \param hyp - hypothesis, if eventType is algo_event
    */
-  void NotifyListenersOnEvent( const int         event,
+  void notifyListenersOnEvent( const int         event,
                                const event_type  eventType,
                                SMESH_Hypothesis* hyp = 0);
 
   /*!
    * \brief Delete event listeners depending on algo of this submesh
    */
-  void DeleteOwnListeners();
+  void deleteOwnListeners();
 
-  // ==================================================================
+  /*!
+   * \brief loads dependent meshes on SUBMESH_LOADED event
+   */
+  void loadDependentMeshes();
+
+  // END: Members to track non hierarchical dependencies between submeshes
+  // =====================================================================
 
 public:
 
@@ -185,13 +217,16 @@ public:
   SMESH_Hypothesis::Hypothesis_Status
     SubMeshesAlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
 
-  int GetAlgoState() const { return _algoState; }
-  int GetComputeState() const { return _computeState; };
-  SMESH_ComputeErrorPtr& GetComputeError() { return _computeError; }
+  algo_state             GetAlgoState() const    { return _algoState; }
+  compute_state          GetComputeState() const { return _computeState; };
+  SMESH_ComputeErrorPtr& GetComputeError()       { return _computeError; }
 
   void DumpAlgoState(bool isMain);
 
   bool ComputeStateEngine(int event);
+  void ComputeSubMeshStateEngine(int event, const bool includeSelf=false);
+
+  bool Evaluate(MapShapeNbElems& aResMap);
 
   bool IsConform(const SMESH_Algo* theAlgo);
   // check if a conform mesh will be produced by the Algo
@@ -211,49 +246,62 @@ public:
   SMESH_Hypothesis::Hypothesis_Status CheckConcurentHypothesis (const int theHypType);
   // check if there are several applicable hypothesis on fathers
 
+  /*!
+   * \brief Return true if no mesh entities is bound to the submesh
+   */
+  bool IsEmpty() const;
+
   bool IsMeshComputed() const;
-  // check if _subMeshDS contains mesh elements
+  // check if _subMeshDS contains mesh elements unless _alwaysComputed==true
 
   /*!
    * \brief Allow algo->Compute() if a subshape of lower dim is meshed but
    *        none mesh entity is bound to it
    */
   void SetIsAlwaysComputed(bool isAlCo);
+  bool IsAlwaysComputed() { return _alwaysComputed; }
+
+  bool SubMeshesComputed(bool * isFailedToCompute=0) const;
 
+  int GetComputeCost() const;
+  // how costly is to compute this sub-mesh
+  
+  /*!
+   * \brief  Find common submeshes (based on shared subshapes with other
+   * \param theOther submesh to check
+   * \param theCommonIds set of common submesh IDs
+   * NOTE: this method does not cleat set before collect common IDs
+   */
+  bool FindIntersection( const SMESH_subMesh *           theOther,
+                         std::set<const SMESH_subMesh*>& theSetOfCommon ) const;
 
 protected:
   // ==================================================================
-  void InsertDependence(const TopoDS_Shape aSubShape);
-
-  bool SubMeshesComputed();
-
-  bool SubMeshesReady();
+  void insertDependence(const TopoDS_Shape aSubShape);
 
-  void RemoveSubMeshElementsAndNodes();
-  void UpdateDependantsState(const compute_event theEvent);
-  void UpdateSubMeshState(const compute_state theState);
-  void ComputeSubMeshStateEngine(int event);
-  void CleanDependants();
-  void CleanDependsOn();
-  void SetAlgoState(int state);
+  void removeSubMeshElementsAndNodes();
+  void updateDependantsState(const compute_event theEvent);
+  void updateSubMeshState(const compute_state theState);
+  void cleanDependants();
+  void cleanDependsOn( SMESH_Algo* algoRequiringCleaning=0 );
+  void setAlgoState(algo_state state);
 
   /*!
    * \brief Return a shape containing all sub-shapes of the MainShape that can be
    * meshed at once along with _subShape
    */
-  TopoDS_Shape GetCollection(SMESH_Gen * theGen, SMESH_Algo* theAlgo);
-
-  /*!
-   * \brief Apply theAlgo to all subshapes in theCollection
-   */
-  bool ApplyToCollection (SMESH_Algo*         theAlgo,
-                          const TopoDS_Shape& theCollection);
-
+  TopoDS_Shape getCollection(SMESH_Gen * theGen,
+                             SMESH_Algo* theAlgo,
+                             bool &      theSubComputed,
+                             bool &      theSubFailed,
+                             std::vector<SMESH_subMesh*>& theSubs);
   /*!
    * \brief Update compute_state by _computeError
     * \retval bool - false if there are errors
    */
-  bool CheckComputeError(SMESH_Algo* theAlgo, const TopoDS_Shape& theShape=TopoDS_Shape());
+  bool checkComputeError(SMESH_Algo*         theAlgo,
+                         const bool          theComputeOK,
+                         const TopoDS_Shape& theShape=TopoDS_Shape());
 
   /*!
    * \brief Return a hypothesis attached to theShape.
@@ -262,10 +310,11 @@ protected:
    * is returned; else an applicable ones having theHypType
    * is returned
    */
-  const SMESH_Hypothesis* GetSimilarAttached(const TopoDS_Shape&      theShape,
+  const SMESH_Hypothesis* getSimilarAttached(const TopoDS_Shape&      theShape,
                                              const SMESH_Hypothesis * theHyp,
                                              const int                theHypType = 0);
   // 
+  int computeCost() const;
 
 protected:
 
@@ -274,14 +323,17 @@ protected:
   SMESH_Mesh *          _father;
   int                   _Id;
 
-  map < int, SMESH_subMesh * >_mapDepend;
+  std::map < int, SMESH_subMesh * >_mapDepend;
   bool                  _dependenceAnalysed;
 
-  int                   _algoState;
-  int                   _computeState;
+  SMESH_Algo *          _algo; // the algorithm found by last *StateEngine() call
+  algo_state            _algoState;
+  compute_state         _computeState;
   SMESH_ComputeErrorPtr _computeError;
+  int                   _computeCost;     // how costly is to compute this sub-mesh
+  int                   _realComputeCost; // _computeCost depending on presence of needed hypotheses
 
-  // allow algo->Compute() if a subshape of lower dim is meshed but
+  // allow algo->Compute() if a sub-shape of lower dim is meshed but
   // none mesh entity is bound to it. Eg StdMeshers_CompositeSegment_1D can
   // mesh several edges as a whole and leave some of them  without mesh entities
   bool                  _alwaysComputed;