1 // SMESH SMESH : implementaion of SMESH idl descriptions
3 // Copyright (C) 2003 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
24 // File : SMESH_subMesh.hxx
25 // Author : Paul RASCLE, EDF
29 #ifndef _SMESH_SUBMESH_HXX_
30 #define _SMESH_SUBMESH_HXX_
32 #include "SMESHDS_Mesh.hxx"
33 #include "SMESHDS_SubMesh.hxx"
34 #include "SMESH_Hypothesis.hxx"
35 #include "Utils_SALOME_Exception.hxx"
36 #include <TopoDS_Shape.hxx>
37 #include <TColStd_IndexedMapOfTransient.hxx>
38 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
45 class SMESH_Hypothesis;
48 class SMESH_subMeshEventListener;
49 class SMESH_subMeshEventListenerData;
51 typedef SMESH_subMeshEventListener EventListener;
52 typedef SMESH_subMeshEventListenerData EventListenerData;
57 SMESH_subMesh(int Id, SMESH_Mesh * father, SMESHDS_Mesh * meshDS,
58 const TopoDS_Shape & aSubShape);
59 virtual ~ SMESH_subMesh();
63 // bool Contains(const TopoDS_Shape & aSubShape)
64 // throw (SALOME_Exception);
66 SMESH_Mesh* GetFather() { return _father; }
68 SMESHDS_SubMesh * GetSubMeshDS();
70 SMESHDS_SubMesh* CreateSubMeshDS();
71 // Explicit SMESHDS_SubMesh creation method, required for persistence mechanism
73 SMESH_subMesh *GetFirstToCompute();
75 const map < int, SMESH_subMesh * >&DependsOn();
76 //const map < int, SMESH_subMesh * >&Dependants();
78 const TopoDS_Shape & GetSubShape() const;
82 NOT_READY, READY_TO_COMPUTE,
83 COMPUTE_OK, FAILED_TO_COMPUTE
87 NO_ALGO, MISSING_HYP, HYP_OK
92 REMOVE_HYP , REMOVE_ALGO,
93 ADD_FATHER_HYP , ADD_FATHER_ALGO,
94 REMOVE_FATHER_HYP, REMOVE_FATHER_ALGO,
99 MODIF_ALGO_STATE, COMPUTE,
100 CLEAN, SUBMESH_COMPUTED, SUBMESH_RESTORED,
101 MESH_ENTITY_REMOVED, CHECK_COMPUTE_STATE
105 ALGO_EVENT, COMPUTE_EVENT
108 // ==================================================================
109 // Members to track non hierarchical dependencies between submeshes
110 // ==================================================================
113 * \brief Sets an event listener and its data to a submesh
114 * \param listener - the listener to store
115 * \param data - the listener data to store
116 * \param where - the submesh to store the listener and it's data
118 * The method remembers the submesh \awhere it puts the listener in order to delete
119 * them when HYP_OK algo_state is lost
120 * After being set, event listener is notified on each event of \awhere submesh.
122 void SetEventListener(EventListener* listener,
123 EventListenerData* data,
124 SMESH_subMesh* where);
127 * \brief Return an event listener data
128 * \param listener - the listener whose data is
129 * \retval EventListenerData* - found data, maybe NULL
131 EventListenerData* GetEventListenerData(EventListener* listener) const;
134 * \brief Unregister the listener and delete it and it's data
135 * \param listener - the event listener to delete
137 void DeleteEventListener(EventListener* listener);
141 //!< event listeners to notify
142 std::map< EventListener*, EventListenerData* > myEventListeners;
143 //!< event listeners to delete when HYP_OK algo_state is lost
144 std::list< std::pair< SMESH_subMesh*, EventListener* > > myOwnListeners;
147 * \brief Sets an event listener and its data to a submesh
148 * \param listener - the listener to store
149 * \param data - the listener data to store
151 * After being set, event listener is notified on each event of a submesh.
153 void SetEventListener(EventListener* listener, EventListenerData* data);
156 * \brief Notify stored event listeners on the occured event
157 * \param event - algo_event or compute_event itself
158 * \param eventType - algo_event or compute_event
159 * \param hyp - hypothesis, if eventType is algo_event
161 void NotifyListenersOnEvent( const int event,
162 const event_type eventType,
163 SMESH_Hypothesis* hyp = 0);
166 * \brief Delete event listeners depending on algo of this submesh
168 void DeleteOwnListeners();
170 // ==================================================================
174 SMESH_Hypothesis::Hypothesis_Status
175 AlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
177 SMESH_Hypothesis::Hypothesis_Status
178 SubMeshesAlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
180 int GetAlgoState() const { return _algoState; }
181 int GetComputeState() const { return _computeState; };
183 void DumpAlgoState(bool isMain);
185 bool ComputeStateEngine(int event);
187 bool IsConform(const SMESH_Algo* theAlgo);
188 // check if a conform mesh will be produced by the Algo
190 bool CanAddHypothesis(const SMESH_Hypothesis* theHypothesis) const;
191 // return true if theHypothesis can be attached to me:
192 // its dimention is checked
194 static bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis,
195 const TopAbs_ShapeEnum theShapeType);
197 bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis) const
198 { return IsApplicableHypotesis( theHypothesis, _subShape.ShapeType() ); }
199 // return true if theHypothesis can be used to mesh me:
200 // its shape type is checked
202 SMESH_Hypothesis::Hypothesis_Status CheckConcurentHypothesis (const int theHypType);
203 // check if there are several applicable hypothesis on fathers
205 bool IsMeshComputed() const;
206 // check if _subMeshDS contains mesh elements
209 * \brief Allow algo->Compute() if a subshape of lower dim is meshed but
210 * none mesh entity is bound to it
212 void SetIsAlwaysComputed(bool isAlCo);
215 // ==================================================================
216 void InsertDependence(const TopoDS_Shape aSubShape);
218 bool SubMeshesComputed();
220 bool SubMeshesReady();
222 void RemoveSubMeshElementsAndNodes();
223 void UpdateDependantsState(const compute_event theEvent);
224 void UpdateSubMeshState(const compute_state theState);
225 void ComputeSubMeshStateEngine(int event);
226 void CleanDependants();
227 void CleanDependsOn();
228 void SetAlgoState(int state);
230 TopoDS_Shape GetCollection(SMESH_Gen * theGen, SMESH_Algo* theAlgo);
231 // return a shape containing all sub-shapes of the MainShape that can be
232 // meshed at once along with _subShape
234 bool ApplyToCollection (SMESH_Algo* theAlgo,
235 const TopoDS_Shape& theCollection);
236 // Apply theAlgo to all subshapes in theCollection
238 const SMESH_Hypothesis* GetSimilarAttached(const TopoDS_Shape& theShape,
239 const SMESH_Hypothesis * theHyp,
240 const int theHypType = 0);
241 // return a hypothesis attached to theShape.
242 // If theHyp is provided, similar but not same hypotheses
243 // is returned; else an applicable ones having theHypType
247 TopoDS_Shape _subShape;
248 SMESHDS_Mesh * _meshDS;
249 SMESHDS_SubMesh * _subMeshDS;
252 map < int, SMESH_subMesh * >_mapDepend;
253 bool _dependenceAnalysed;
258 // allow algo->Compute() if a subshape of lower dim is meshed but
259 // none mesh entity is bound to it. Eg StdMeshers_CompositeSegment_1D can
260 // mesh several edges as a whole and leave some of them without mesh entities
261 bool _alwaysComputed;