Salome HOME
Merge from V4_1_0_maintainance branch (from tag mergeto_BR_QT4_Dev_08Jul08)
[modules/smesh.git] / src / SMESH / SMESH_subMesh.hxx
index 8e09b5c6f46ffd4bf248142b763d530a6e235efa..9b3860ae0fd6a5e9d111726b890b9eaf881051dc 100644 (file)
 #include "SMESHDS_Mesh.hxx"
 #include "SMESHDS_SubMesh.hxx"
 #include "SMESH_Hypothesis.hxx"
+#include "SMESH_ComputeError.hxx"
+
 #include "Utils_SALOME_Exception.hxx"
+
 #include <TopoDS_Shape.hxx>
-#include <TColStd_IndexedMapOfTransient.hxx>
-#include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
 
-#include <set>
 #include <list>
 #include <map>
 
@@ -49,10 +49,14 @@ class SMESH_Algo;
 class SMESH_Gen;
 class SMESH_subMeshEventListener;
 class SMESH_subMeshEventListenerData;
+class SMESH_subMesh;
 
 typedef SMESH_subMeshEventListener     EventListener;
 typedef SMESH_subMeshEventListenerData EventListenerData;
 
+typedef boost::shared_ptr< SMDS_Iterator<SMESH_subMesh*> > SMESH_subMeshIteratorPtr;
+
+
 class SMESH_EXPORT SMESH_subMesh
 {
  public:
@@ -62,9 +66,6 @@ class SMESH_EXPORT SMESH_subMesh
 
   int GetId() const;
 
-  //   bool Contains(const TopoDS_Shape & aSubShape)
-  //     throw (SALOME_Exception);
-
   SMESH_Mesh* GetFather() { return _father; }
   
   SMESHDS_SubMesh * GetSubMeshDS();
@@ -74,8 +75,13 @@ class SMESH_EXPORT SMESH_subMesh
 
   SMESH_subMesh *GetFirstToCompute();
 
-  const map < int, SMESH_subMesh * >&DependsOn();
+  const std::map < int, SMESH_subMesh * >& DependsOn();
   //const map < int, SMESH_subMesh * >&Dependants();
+  /*!
+   * \brief Return iterator on the submeshes this one depends on
+   */
+  SMESH_subMeshIteratorPtr getDependsOnIterator(const bool includeSelf,
+                                                const bool complexShapeFirst);
 
   const TopoDS_Shape & GetSubShape() const;
 
@@ -90,14 +96,15 @@ class SMESH_EXPORT SMESH_subMesh
     };
   enum algo_event
   {
-    ADD_HYP, ADD_ALGO,
-    REMOVE_HYP, REMOVE_ALGO,
-    ADD_FATHER_HYP, ADD_FATHER_ALGO,
-    REMOVE_FATHER_HYP, REMOVE_FATHER_ALGO
+    ADD_HYP          , ADD_ALGO,
+    REMOVE_HYP       , REMOVE_ALGO,
+    ADD_FATHER_HYP   , ADD_FATHER_ALGO,
+    REMOVE_FATHER_HYP, REMOVE_FATHER_ALGO,
+    MODIF_HYP
     };
   enum compute_event
   {
-    MODIF_HYP, MODIF_ALGO_STATE, COMPUTE,
+    MODIF_ALGO_STATE, COMPUTE,
     CLEAN, SUBMESH_COMPUTED, SUBMESH_RESTORED,
     MESH_ENTITY_REMOVED, CHECK_COMPUTE_STATE
     };
@@ -115,12 +122,10 @@ class SMESH_EXPORT SMESH_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
-    * \param deleteListener - if true then the listener will be deleted as
-    *        it is removed from where submesh
    * 
-   * It remembers the submesh where it puts the listener in order to delete
+   * The method remembers the submesh \awhere it puts the listener in order to delete
    * them when HYP_OK algo_state is lost
-   * After being set, event listener is notified on each event of where submesh.
+   * After being set, event listener is notified on each event of \awhere submesh.
    */
   void SetEventListener(EventListener*     listener,
                         EventListenerData* data,
@@ -182,6 +187,7 @@ public:
 
   int GetAlgoState() const { return _algoState; }
   int GetComputeState() const { return _computeState; };
+  SMESH_ComputeErrorPtr& GetComputeError() { return _computeError; }
 
   void DumpAlgoState(bool isMain);
 
@@ -208,6 +214,13 @@ public:
   bool IsMeshComputed() const;
   // check if _subMeshDS contains mesh elements
 
+  /*!
+   * \brief Allow algo->Compute() if a subshape of lower dim is meshed but
+   *        none mesh entity is bound to it
+   */
+  void SetIsAlwaysComputed(bool isAlCo);
+
+
 protected:
   // ==================================================================
   void InsertDependence(const TopoDS_Shape aSubShape);
@@ -224,32 +237,56 @@ protected:
   void CleanDependsOn();
   void SetAlgoState(int state);
 
-  TopoDS_Shape GetCollection(SMESH_Gen * theGen, SMESH_Algo* theAlgo);
-  // return a shape containing all sub-shapes of the MainShape that can be
-  // meshed at once along with _subShape
+  /*!
+   * \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,
+                             bool &      theSubComputed);
 
+  /*!
+   * \brief Apply theAlgo to all subshapes in theCollection
+   */
   bool ApplyToCollection (SMESH_Algo*         theAlgo,
                           const TopoDS_Shape& theCollection);
-  // Apply theAlgo to all subshapes in theCollection
 
+  /*!
+   * \brief Update compute_state by _computeError
+    * \retval bool - false if there are errors
+   */
+  bool CheckComputeError(SMESH_Algo* theAlgo, const TopoDS_Shape& theShape=TopoDS_Shape());
+
+  /*!
+   * \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
+   */
   const SMESH_Hypothesis* GetSimilarAttached(const TopoDS_Shape&      theShape,
                                              const SMESH_Hypothesis * theHyp,
                                              const int                theHypType = 0);
-  // 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
-  
-  TopoDS_Shape _subShape;
-  SMESHDS_Mesh * _meshDS;
-  SMESHDS_SubMesh * _subMeshDS;
-  int _Id;
-  SMESH_Mesh *_father;
-  map < int, SMESH_subMesh * >_mapDepend;
-  bool _dependenceAnalysed;
-
-  int _algoState;
-  int _computeState;
+  // 
+
+protected:
+
+  TopoDS_Shape          _subShape;
+  SMESHDS_SubMesh *     _subMeshDS;
+  SMESH_Mesh *          _father;
+  int                   _Id;
+
+  std::map < int, SMESH_subMesh * >_mapDepend;
+  bool                  _dependenceAnalysed;
+
+  int                   _algoState;
+  int                   _computeState;
+  SMESH_ComputeErrorPtr _computeError;
+
+  // allow algo->Compute() if a subshape 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;
 
 };