1 // Copyright (C) 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 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
22 // SMESH SMESH : implementaion of SMESH idl descriptions
23 // File : SMESH_subMesh.hxx
24 // Author : Paul RASCLE, EDF
28 #ifndef _SMESH_SUBMESH_HXX_
29 #define _SMESH_SUBMESH_HXX_
31 #include "SMESH_SMESH.hxx"
33 #include "SMESHDS_Mesh.hxx"
34 #include "SMESHDS_SubMesh.hxx"
35 #include "SMESH_Hypothesis.hxx"
36 #include "SMESH_ComputeError.hxx"
37 #include "SMESH_Algo.hxx"
39 #include "Utils_SALOME_Exception.hxx"
41 #include <TopoDS_Shape.hxx>
47 class SMESH_Hypothesis;
50 class SMESH_subMeshEventListener;
51 class SMESH_subMeshEventListenerData;
54 typedef SMESH_subMeshEventListener EventListener;
55 typedef SMESH_subMeshEventListenerData EventListenerData;
57 typedef boost::shared_ptr< SMDS_Iterator<SMESH_subMesh*> > SMESH_subMeshIteratorPtr;
60 class SMESH_EXPORT SMESH_subMesh
63 SMESH_subMesh(int Id, SMESH_Mesh * father, SMESHDS_Mesh * meshDS,
64 const TopoDS_Shape & aSubShape);
65 virtual ~ SMESH_subMesh();
69 SMESH_Mesh* GetFather() { return _father; }
71 SMESHDS_SubMesh * GetSubMeshDS();
73 SMESHDS_SubMesh* CreateSubMeshDS();
74 // Explicit SMESHDS_SubMesh creation method, required for persistence mechanism
76 SMESH_subMesh *GetFirstToCompute();
78 const std::map < int, SMESH_subMesh * >& DependsOn();
79 //const map < int, SMESH_subMesh * >&Dependants();
81 * \brief Return iterator on the submeshes this one depends on
83 SMESH_subMeshIteratorPtr getDependsOnIterator(const bool includeSelf,
84 const bool complexShapeFirst);
86 const TopoDS_Shape & GetSubShape() const;
90 NOT_READY, READY_TO_COMPUTE,
91 COMPUTE_OK, FAILED_TO_COMPUTE
95 NO_ALGO, MISSING_HYP, HYP_OK
100 REMOVE_HYP , REMOVE_ALGO,
101 ADD_FATHER_HYP , ADD_FATHER_ALGO,
102 REMOVE_FATHER_HYP, REMOVE_FATHER_ALGO,
107 MODIF_ALGO_STATE, COMPUTE,
108 CLEAN, SUBMESH_COMPUTED, SUBMESH_RESTORED,
109 MESH_ENTITY_REMOVED, CHECK_COMPUTE_STATE
113 ALGO_EVENT, COMPUTE_EVENT
116 // ==================================================================
117 // Members to track non hierarchical dependencies between submeshes
118 // ==================================================================
121 * \brief Sets an event listener and its data to a submesh
122 * \param listener - the listener to store
123 * \param data - the listener data to store
124 * \param where - the submesh to store the listener and it's data
126 * The method remembers the submesh \awhere it puts the listener in order to delete
127 * them when HYP_OK algo_state is lost
128 * After being set, event listener is notified on each event of \awhere submesh.
130 void SetEventListener(EventListener* listener,
131 EventListenerData* data,
132 SMESH_subMesh* where);
135 * \brief Return an event listener data
136 * \param listener - the listener whose data is
137 * \retval EventListenerData* - found data, maybe NULL
139 EventListenerData* GetEventListenerData(EventListener* listener) const;
142 * \brief Unregister the listener and delete it and it's data
143 * \param listener - the event listener to delete
145 void DeleteEventListener(EventListener* listener);
149 //!< event listeners to notify
150 std::map< EventListener*, EventListenerData* > myEventListeners;
151 //!< event listeners to delete when HYP_OK algo_state is lost
152 std::list< std::pair< SMESH_subMesh*, EventListener* > > myOwnListeners;
155 * \brief Sets an event listener and its data to a submesh
156 * \param listener - the listener to store
157 * \param data - the listener data to store
159 * After being set, event listener is notified on each event of a submesh.
161 void SetEventListener(EventListener* listener, EventListenerData* data);
164 * \brief Notify stored event listeners on the occured event
165 * \param event - algo_event or compute_event itself
166 * \param eventType - algo_event or compute_event
167 * \param hyp - hypothesis, if eventType is algo_event
169 void NotifyListenersOnEvent( const int event,
170 const event_type eventType,
171 SMESH_Hypothesis* hyp = 0);
174 * \brief Delete event listeners depending on algo of this submesh
176 void DeleteOwnListeners();
178 // ==================================================================
182 SMESH_Hypothesis::Hypothesis_Status
183 AlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
185 SMESH_Hypothesis::Hypothesis_Status
186 SubMeshesAlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
188 int GetAlgoState() const { return _algoState; }
189 int GetComputeState() const { return _computeState; };
190 SMESH_ComputeErrorPtr& GetComputeError() { return _computeError; }
192 void DumpAlgoState(bool isMain);
194 bool ComputeStateEngine(int event);
196 bool Evaluate(MapShapeNbElems& aResMap);
198 bool IsConform(const SMESH_Algo* theAlgo);
199 // check if a conform mesh will be produced by the Algo
201 bool CanAddHypothesis(const SMESH_Hypothesis* theHypothesis) const;
202 // return true if theHypothesis can be attached to me:
203 // its dimention is checked
205 static bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis,
206 const TopAbs_ShapeEnum theShapeType);
208 bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis) const
209 { return IsApplicableHypotesis( theHypothesis, _subShape.ShapeType() ); }
210 // return true if theHypothesis can be used to mesh me:
211 // its shape type is checked
213 SMESH_Hypothesis::Hypothesis_Status CheckConcurentHypothesis (const int theHypType);
214 // check if there are several applicable hypothesis on fathers
217 * \brief Return true if no mesh entities is bound to the submesh
219 bool IsEmpty() const;
221 bool IsMeshComputed() const;
222 // check if _subMeshDS contains mesh elements
225 * \brief Allow algo->Compute() if a subshape of lower dim is meshed but
226 * none mesh entity is bound to it
228 void SetIsAlwaysComputed(bool isAlCo);
229 bool IsAlwaysComputed() { return _alwaysComputed; }
233 // ==================================================================
234 void InsertDependence(const TopoDS_Shape aSubShape);
236 bool SubMeshesComputed();
238 bool SubMeshesReady();
240 void RemoveSubMeshElementsAndNodes();
241 void UpdateDependantsState(const compute_event theEvent);
242 void UpdateSubMeshState(const compute_state theState);
243 void ComputeSubMeshStateEngine(int event);
244 void CleanDependants();
245 void CleanDependsOn();
246 void SetAlgoState(int state);
249 * \brief Return a shape containing all sub-shapes of the MainShape that can be
250 * meshed at once along with _subShape
252 TopoDS_Shape GetCollection(SMESH_Gen * theGen,
254 bool & theSubComputed);
257 * \brief Apply theAlgo to all subshapes in theCollection
259 bool ApplyToCollection (SMESH_Algo* theAlgo,
260 const TopoDS_Shape& theCollection);
263 * \brief Update compute_state by _computeError
264 * \retval bool - false if there are errors
266 bool CheckComputeError(SMESH_Algo* theAlgo, const TopoDS_Shape& theShape=TopoDS_Shape());
269 * \brief Return a hypothesis attached to theShape.
271 * If theHyp is provided, similar but not same hypotheses
272 * is returned; else an applicable ones having theHypType
275 const SMESH_Hypothesis* GetSimilarAttached(const TopoDS_Shape& theShape,
276 const SMESH_Hypothesis * theHyp,
277 const int theHypType = 0);
282 TopoDS_Shape _subShape;
283 SMESHDS_SubMesh * _subMeshDS;
284 SMESH_Mesh * _father;
287 std::map < int, SMESH_subMesh * >_mapDepend;
288 bool _dependenceAnalysed;
292 SMESH_ComputeErrorPtr _computeError;
294 // allow algo->Compute() if a subshape of lower dim is meshed but
295 // none mesh entity is bound to it. Eg StdMeshers_CompositeSegment_1D can
296 // mesh several edges as a whole and leave some of them without mesh entities
297 bool _alwaysComputed;