Salome HOME
Using AutoTools for build procedure
[modules/smesh.git] / src / SMESH / SMESH_subMesh.hxx
index 307ddf2c9af537c000554b9458821ce3dd7d8d35..8e09b5c6f46ffd4bf248142b763d530a6e235efa 100644 (file)
@@ -17,7 +17,7 @@
 //  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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 //
 //
@@ -29,6 +29,8 @@
 #ifndef _SMESH_SUBMESH_HXX_
 #define _SMESH_SUBMESH_HXX_
 
+#include "SMESH_SMESH.hxx"
+
 #include "SMESHDS_Mesh.hxx"
 #include "SMESHDS_SubMesh.hxx"
 #include "SMESH_Hypothesis.hxx"
@@ -45,8 +47,13 @@ class SMESH_Mesh;
 class SMESH_Hypothesis;
 class SMESH_Algo;
 class SMESH_Gen;
+class SMESH_subMeshEventListener;
+class SMESH_subMeshEventListenerData;
+
+typedef SMESH_subMeshEventListener     EventListener;
+typedef SMESH_subMeshEventListenerData EventListenerData;
 
-class SMESH_subMesh
+class SMESH_EXPORT SMESH_subMesh
 {
  public:
   SMESH_subMesh(int Id, SMESH_Mesh * father, SMESHDS_Mesh * meshDS,
@@ -58,6 +65,8 @@ class SMESH_subMesh
   //   bool Contains(const TopoDS_Shape & aSubShape)
   //     throw (SALOME_Exception);
 
+  SMESH_Mesh* GetFather() { return _father; }
+  
   SMESHDS_SubMesh * GetSubMeshDS();
 
   SMESHDS_SubMesh* CreateSubMeshDS();
@@ -68,9 +77,7 @@ class SMESH_subMesh
   const map < int, SMESH_subMesh * >&DependsOn();
   //const map < int, SMESH_subMesh * >&Dependants();
 
-  const TopoDS_Shape & GetSubShape();
-
-//  bool _vertexSet;                   // only for vertex subMesh, set to false for dim > 0
+  const TopoDS_Shape & GetSubShape() const;
 
   enum compute_state
   {
@@ -91,9 +98,81 @@ class SMESH_subMesh
   enum compute_event
   {
     MODIF_HYP, MODIF_ALGO_STATE, COMPUTE,
-    CLEAN, CLEANDEP, SUBMESH_COMPUTED, SUBMESH_RESTORED,
+    CLEAN, SUBMESH_COMPUTED, SUBMESH_RESTORED,
     MESH_ENTITY_REMOVED, CHECK_COMPUTE_STATE
     };
+  enum event_type
+  {
+    ALGO_EVENT, COMPUTE_EVENT
+  };
+
+  // ==================================================================
+  // Members to track non hierarchical dependencies between submeshes 
+  // ==================================================================
+
+  /*!
+   * \brief Sets 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
+    * \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
+   * them when HYP_OK algo_state is lost
+   * After being set, event listener is notified on each event of where submesh.
+   */
+  void SetEventListener(EventListener*     listener,
+                        EventListenerData* data,
+                        SMESH_subMesh*     where);
+
+  /*!
+   * \brief Return an event listener data
+    * \param listener - the listener whose data is
+    * \retval EventListenerData* - found data, maybe NULL
+   */
+  EventListenerData* GetEventListenerData(EventListener* listener) const;
+
+  /*!
+   * \brief Unregister the listener and delete it and it's data
+    * \param listener - the event listener to delete
+   */
+  void DeleteEventListener(EventListener* listener);
+
+protected:
+
+  //!< event listeners to notify
+  std::map< EventListener*, EventListenerData* >           myEventListeners;
+  //!< event listeners to delete when HYP_OK algo_state is lost
+  std::list< std::pair< SMESH_subMesh*, EventListener* > > myOwnListeners;
+
+  /*!
+   * \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
+   * \param event - algo_event or compute_event itself
+   * \param eventType - algo_event or compute_event
+   * \param hyp - hypothesis, if eventType is algo_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();
+
+  // ==================================================================
+
+public:
 
   SMESH_Hypothesis::Hypothesis_Status
     AlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
@@ -101,17 +180,13 @@ class SMESH_subMesh
   SMESH_Hypothesis::Hypothesis_Status
     SubMeshesAlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
 
-  int GetAlgoState() { return _algoState; }
+  int GetAlgoState() const { return _algoState; }
+  int GetComputeState() const { return _computeState; };
 
   void DumpAlgoState(bool isMain);
 
   bool ComputeStateEngine(int event);
 
-  int GetComputeState()
-  {
-    return _computeState;
-  };
-
   bool IsConform(const SMESH_Algo* theAlgo);
   // check if a conform mesh will be produced by the Algo
 
@@ -119,12 +194,22 @@ class SMESH_subMesh
   // return true if theHypothesis can be attached to me:
   // its dimention is checked
 
-  bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis) const;
+  static bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis,
+                                    const TopAbs_ShapeEnum  theShapeType);
+
+  bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis) const
+  { return IsApplicableHypotesis( theHypothesis, _subShape.ShapeType() ); }
   // return true if theHypothesis can be used to mesh me:
   // its shape type is checked
   
+  SMESH_Hypothesis::Hypothesis_Status CheckConcurentHypothesis (const int theHypType);
+  // check if there are several applicable hypothesis on fathers
+
+  bool IsMeshComputed() const;
+  // check if _subMeshDS contains mesh elements
 
- protected:
+protected:
+  // ==================================================================
   void InsertDependence(const TopoDS_Shape aSubShape);
 
   bool SubMeshesComputed();
@@ -139,9 +224,6 @@ class SMESH_subMesh
   void CleanDependsOn();
   void SetAlgoState(int state);
 
-  bool IsMeshComputed() const;
-  // check if _subMeshDS contains mesh elements
-
   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
@@ -150,9 +232,6 @@ class SMESH_subMesh
                           const TopoDS_Shape& theCollection);
   // Apply theAlgo to all subshapes in theCollection
 
-  SMESH_Hypothesis::Hypothesis_Status CheckConcurentHypothesis (const int theHypType);
-  // check if there are several applicable hypothesis on fathers
-
   const SMESH_Hypothesis* GetSimilarAttached(const TopoDS_Shape&      theShape,
                                              const SMESH_Hypothesis * theHyp,
                                              const int                theHypType = 0);