Salome HOME
Update of CheckDone
[modules/smesh.git] / src / SMESH / SMESH_subMesh.hxx
index 0c956cea623af7fa8627fde9e16b659e71c95be7..0358cc6627db822bdf029efcfb4911dd81dd3f68 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2024  CEA, EDF, OPEN CASCADE
 //
 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
@@ -6,7 +6,7 @@
 // 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.
+// 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
 
 #include "SMESH_SMESH.hxx"
 
-#include "SMESHDS_Mesh.hxx"
-#include "SMESHDS_SubMesh.hxx"
-#include "SMESH_Hypothesis.hxx"
+#include "SMDS_Iterator.hxx"
 #include "SMESH_ComputeError.hxx"
 #include "SMESH_Algo.hxx"
 
 #include "Utils_SALOME_Exception.hxx"
 
 #include <TopoDS_Shape.hxx>
+#include <TopTools_IndexedMapOfShape.hxx>
 
 #include <list>
 #include <map>
 
-class SMESH_Mesh;
-class SMESH_Hypothesis;
+class SMESHDS_Mesh;
+class SMESHDS_SubMesh;
 class SMESH_Algo;
 class SMESH_Gen;
-class SMESH_subMeshEventListener;
-class SMESH_subMeshEventListenerData;
+class SMESH_Hypothesis;
+class SMESH_Mesh;
 class SMESH_subMesh;
+class SMESH_subMeshEventListener;
+struct SMESH_subMeshEventListenerData;
 
 typedef SMESH_subMeshEventListener     EventListener;
 typedef SMESH_subMeshEventListenerData EventListenerData;
@@ -68,7 +69,7 @@ class SMESH_EXPORT SMESH_subMesh
   int GetId() const; // == meshDS->ShapeToIndex( aSubShape )
 
   SMESH_Mesh* GetFather() { return _father; }
-  
+
   SMESHDS_SubMesh *       GetSubMeshDS();
   const SMESHDS_SubMesh * GetSubMeshDS() const;
 
@@ -78,20 +79,26 @@ class SMESH_EXPORT SMESH_subMesh
   SMESH_subMesh *GetFirstToCompute();
 
   SMESH_Algo* GetAlgo() const;
+  SMESH_Algo* CopyAlgo() const;
 
   const std::map < int, SMESH_subMesh * >& DependsOn();
+  bool DependsOn( const SMESH_subMesh* other ) const;
+  bool DependsOn( const int shapeID ) 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;
+                                                const bool complexShapeFirst=false) const;
+
+  const std::vector< SMESH_subMesh * > & GetAncestors() const;
+  void ClearAncestors();
 
   const TopoDS_Shape & GetSubShape() const;
 
   enum compute_state
   {
-    NOT_READY, READY_TO_COMPUTE,
-    COMPUTE_OK, FAILED_TO_COMPUTE
+    NOT_READY, READY_TO_COMPUTE, COMPUTE_OK, FAILED_TO_COMPUTE
   };
   enum algo_state
   {
@@ -107,7 +114,7 @@ class SMESH_EXPORT SMESH_subMesh
   };
   enum compute_event
   {
-    MODIF_ALGO_STATE, COMPUTE, COMPUTE_CANCELED,
+    MODIF_ALGO_STATE, COMPUTE, COMPUTE_SUBMESH, COMPUTE_NOGEOM, COMPUTE_CANCELED,
     CLEAN, SUBMESH_COMPUTED, SUBMESH_RESTORED, SUBMESH_LOADED,
     MESH_ENTITY_REMOVED, CHECK_COMPUTE_STATE
   };
@@ -117,15 +124,15 @@ class SMESH_EXPORT SMESH_subMesh
   };
 
   // ==================================================================
-  // Members to track non hierarchical dependencies between submeshes 
+  // Members to track non hierarchical dependencies between sub-meshes
   // ==================================================================
 
   /*!
-   * \brief Sets an event listener and its data to a submesh
+   * \brief Set an event listener and its data to a submesh
     * \param listener - the listener to store
     * \param data - the listener data to store
     * \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
    * it when HYP_OK algo_state is lost
    * After being set, event listener is notified on each event of \awhere submesh.
@@ -137,16 +144,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;
+  EventListenerData* GetEventListenerData(const std::string& listenerName,
+                                          const bool         myOwn=false) const;
 
   /*!
    * \brief Unregister the listener and delete it and it's data
@@ -173,13 +186,13 @@ protected:
    * \brief Sets an event listener and its data to a submesh
     * \param listener - the listener to store
     * \param data - the listener data to store
-   * 
+   *
    * After being set, event listener is notified on each event of a submesh.
    */
   void setEventListener(EventListener* listener, EventListenerData* data);
 
   /*!
-   * \brief Notify stored event listeners on the occured event
+   * \brief Notify stored event listeners on the occurred event
    * \param event - algo_event or compute_event itself
    * \param eventType - algo_event or compute_event
    * \param hyp - hypothesis, if eventType is algo_event
@@ -204,19 +217,19 @@ protected:
 public:
 
   SMESH_Hypothesis::Hypothesis_Status
-    AlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
+    AlgoStateEngine(algo_event event, SMESH_Hypothesis * anHyp);
 
   SMESH_Hypothesis::Hypothesis_Status
-    SubMeshesAlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
+    SubMeshesAlgoStateEngine(algo_event event, SMESH_Hypothesis * anHyp, bool exitOnFatal=false);
 
   algo_state             GetAlgoState() const    { return _algoState; }
-  compute_state          GetComputeState() const { return _computeState; };
+  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 ComputeStateEngine(compute_event event);
+  void ComputeSubMeshStateEngine(compute_event event, const bool includeSelf=false);
 
   bool Evaluate(MapShapeNbElems& aResMap);
 
@@ -225,17 +238,16 @@ public:
 
   bool CanAddHypothesis(const SMESH_Hypothesis* theHypothesis) const;
   // return true if theHypothesis can be attached to me:
-  // its dimention is checked
+  // its dimension is checked
 
-  static bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis,
+  static bool IsApplicableHypothesis(const SMESH_Hypothesis* theHypothesis,
                                     const TopAbs_ShapeEnum  theShapeType);
 
-  bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis) const
-  { return IsApplicableHypotesis( theHypothesis, _subShape.ShapeType() ); }
+  bool IsApplicableHypothesis(const SMESH_Hypothesis* theHypothesis) const;
   // return true if theHypothesis can be used to mesh me:
   // its shape type is checked
-  
-  SMESH_Hypothesis::Hypothesis_Status CheckConcurentHypothesis (const int theHypType);
+
+  SMESH_Hypothesis::Hypothesis_Status CheckConcurrentHypothesis (SMESH_Hypothesis* theHypothesis);
   // check if there are several applicable hypothesis on fathers
 
   /*!
@@ -244,18 +256,29 @@ public:
   bool IsEmpty() const;
 
   bool IsMeshComputed() const;
-  // check if _subMeshDS contains mesh elements
+  // check if _subMeshDS contains mesh elements unless _alwaysComputed==true
+
+  bool IsComputedPartially() const;
+  // check if any upper level sub-shape is not computed
+
+  /*!
+   * \brief Set sub-shapes that are allowed to compute at once by a multidimensional algo
+   */
+  void SetAllowedSubShapes( const TopTools_IndexedMapOfShape* subShapes )
+  { _allowedSubShapes = subShapes; }
 
   /*!
    * \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 IsAlwaysComputed() const { return _alwaysComputed; }
 
-  bool SubMeshesComputed() const;
+  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
@@ -267,13 +290,15 @@ public:
 
 protected:
   // ==================================================================
-  void insertDependence(const TopoDS_Shape aSubShape);
+  void insertDependence(const TopoDS_Shape aShape,
+                        TopAbs_ShapeEnum   aSubType,
+                        TopAbs_ShapeEnum   avoidType=TopAbs_SHAPE);
 
   void removeSubMeshElementsAndNodes();
   void updateDependantsState(const compute_event theEvent);
   void updateSubMeshState(const compute_state theState);
   void cleanDependants();
-  void cleanDependsOn();
+  void cleanDependsOn( SMESH_Algo* algoRequiringCleaning=0 );
   void setAlgoState(algo_state state);
 
   /*!
@@ -282,7 +307,9 @@ protected:
    */
   TopoDS_Shape getCollection(SMESH_Gen * theGen,
                              SMESH_Algo* theAlgo,
-                             bool &      theSubComputed);
+                             bool &      theSubComputed,
+                             bool &      theSubFailed,
+                             std::vector<SMESH_subMesh*>& theSubs);
   /*!
    * \brief Update compute_state by _computeError
     * \retval bool - false if there are errors
@@ -293,7 +320,7 @@ protected:
 
   /*!
    * \brief Return a hypothesis attached to theShape.
-   * 
+   *
    * If theHyp is provided, similar but not same hypotheses
    * is returned; else an applicable ones having theHypType
    * is returned
@@ -301,7 +328,8 @@ protected:
   const SMESH_Hypothesis* getSimilarAttached(const TopoDS_Shape&      theShape,
                                              const SMESH_Hypothesis * theHyp,
                                              const int                theHypType = 0);
-  // 
+  //
+  int computeCost() const;
 
 protected:
 
@@ -311,17 +339,24 @@ protected:
   int                   _Id;
 
   std::map < int, SMESH_subMesh * >_mapDepend;
-  bool                  _dependenceAnalysed;
+  bool                             _dependenceAnalysed;
+  std::vector< SMESH_subMesh * >   _ancestors;
 
+  SMESH_Algo *          _algo; // the algorithm found by last *StateEngine() call
+  TopoDS_Shape          _algoShape; // shape the algorithm is assigned to
   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;
 
+  const TopTools_IndexedMapOfShape* _allowedSubShapes; // allowed to be returned by getCollection()
+
 };
 
 #endif