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"
38 #include "Utils_SALOME_Exception.hxx"
40 #include <TopoDS_Shape.hxx>
46 class SMESH_Hypothesis;
49 class SMESH_subMeshEventListener;
50 class SMESH_subMeshEventListenerData;
53 typedef SMESH_subMeshEventListener EventListener;
54 typedef SMESH_subMeshEventListenerData EventListenerData;
56 typedef boost::shared_ptr< SMDS_Iterator<SMESH_subMesh*> > SMESH_subMeshIteratorPtr;
59 class SMESH_EXPORT SMESH_subMesh
62 SMESH_subMesh(int Id, SMESH_Mesh * father, SMESHDS_Mesh * meshDS,
63 const TopoDS_Shape & aSubShape);
64 virtual ~ SMESH_subMesh();
68 SMESH_Mesh* GetFather() { return _father; }
70 SMESHDS_SubMesh * GetSubMeshDS();
72 SMESHDS_SubMesh* CreateSubMeshDS();
73 // Explicit SMESHDS_SubMesh creation method, required for persistence mechanism
75 SMESH_subMesh *GetFirstToCompute();
77 const std::map < int, SMESH_subMesh * >& DependsOn();
78 //const map < int, SMESH_subMesh * >&Dependants();
80 * \brief Return iterator on the submeshes this one depends on
82 SMESH_subMeshIteratorPtr getDependsOnIterator(const bool includeSelf,
83 const bool complexShapeFirst);
85 const TopoDS_Shape & GetSubShape() const;
89 NOT_READY, READY_TO_COMPUTE,
90 COMPUTE_OK, FAILED_TO_COMPUTE
94 NO_ALGO, MISSING_HYP, HYP_OK
99 REMOVE_HYP , REMOVE_ALGO,
100 ADD_FATHER_HYP , ADD_FATHER_ALGO,
101 REMOVE_FATHER_HYP, REMOVE_FATHER_ALGO,
106 MODIF_ALGO_STATE, COMPUTE,
107 CLEAN, SUBMESH_COMPUTED, SUBMESH_RESTORED,
108 MESH_ENTITY_REMOVED, CHECK_COMPUTE_STATE
112 ALGO_EVENT, COMPUTE_EVENT
115 // ==================================================================
116 // Members to track non hierarchical dependencies between submeshes
117 // ==================================================================
120 * \brief Sets an event listener and its data to a submesh
121 * \param listener - the listener to store
122 * \param data - the listener data to store
123 * \param where - the submesh to store the listener and it's data
125 * The method remembers the submesh \awhere it puts the listener in order to delete
126 * them when HYP_OK algo_state is lost
127 * After being set, event listener is notified on each event of \awhere submesh.
129 void SetEventListener(EventListener* listener,
130 EventListenerData* data,
131 SMESH_subMesh* where);
134 * \brief Return an event listener data
135 * \param listener - the listener whose data is
136 * \retval EventListenerData* - found data, maybe NULL
138 EventListenerData* GetEventListenerData(EventListener* listener) const;
141 * \brief Unregister the listener and delete it and it's data
142 * \param listener - the event listener to delete
144 void DeleteEventListener(EventListener* listener);
148 //!< event listeners to notify
149 std::map< EventListener*, EventListenerData* > myEventListeners;
150 //!< event listeners to delete when HYP_OK algo_state is lost
151 std::list< std::pair< SMESH_subMesh*, EventListener* > > myOwnListeners;
154 * \brief Sets an event listener and its data to a submesh
155 * \param listener - the listener to store
156 * \param data - the listener data to store
158 * After being set, event listener is notified on each event of a submesh.
160 void SetEventListener(EventListener* listener, EventListenerData* data);
163 * \brief Notify stored event listeners on the occured event
164 * \param event - algo_event or compute_event itself
165 * \param eventType - algo_event or compute_event
166 * \param hyp - hypothesis, if eventType is algo_event
168 void NotifyListenersOnEvent( const int event,
169 const event_type eventType,
170 SMESH_Hypothesis* hyp = 0);
173 * \brief Delete event listeners depending on algo of this submesh
175 void DeleteOwnListeners();
177 // ==================================================================
181 SMESH_Hypothesis::Hypothesis_Status
182 AlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
184 SMESH_Hypothesis::Hypothesis_Status
185 SubMeshesAlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
187 int GetAlgoState() const { return _algoState; }
188 int GetComputeState() const { return _computeState; };
189 SMESH_ComputeErrorPtr& GetComputeError() { return _computeError; }
191 void DumpAlgoState(bool isMain);
193 bool ComputeStateEngine(int event);
195 bool IsConform(const SMESH_Algo* theAlgo);
196 // check if a conform mesh will be produced by the Algo
198 bool CanAddHypothesis(const SMESH_Hypothesis* theHypothesis) const;
199 // return true if theHypothesis can be attached to me:
200 // its dimention is checked
202 static bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis,
203 const TopAbs_ShapeEnum theShapeType);
205 bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis) const
206 { return IsApplicableHypotesis( theHypothesis, _subShape.ShapeType() ); }
207 // return true if theHypothesis can be used to mesh me:
208 // its shape type is checked
210 SMESH_Hypothesis::Hypothesis_Status CheckConcurentHypothesis (const int theHypType);
211 // check if there are several applicable hypothesis on fathers
214 * \brief Return true if no mesh entities is bound to the submesh
216 bool IsEmpty() const;
218 bool IsMeshComputed() const;
219 // check if _subMeshDS contains mesh elements
222 * \brief Allow algo->Compute() if a subshape of lower dim is meshed but
223 * none mesh entity is bound to it
225 void SetIsAlwaysComputed(bool isAlCo);
226 bool IsAlwaysComputed() { return _alwaysComputed; }
230 // ==================================================================
231 void InsertDependence(const TopoDS_Shape aSubShape);
233 bool SubMeshesComputed();
235 bool SubMeshesReady();
237 void RemoveSubMeshElementsAndNodes();
238 void UpdateDependantsState(const compute_event theEvent);
239 void UpdateSubMeshState(const compute_state theState);
240 void ComputeSubMeshStateEngine(int event);
241 void CleanDependants();
242 void CleanDependsOn();
243 void SetAlgoState(int state);
246 * \brief Return a shape containing all sub-shapes of the MainShape that can be
247 * meshed at once along with _subShape
249 TopoDS_Shape GetCollection(SMESH_Gen * theGen,
251 bool & theSubComputed);
254 * \brief Apply theAlgo to all subshapes in theCollection
256 bool ApplyToCollection (SMESH_Algo* theAlgo,
257 const TopoDS_Shape& theCollection);
260 * \brief Update compute_state by _computeError
261 * \retval bool - false if there are errors
263 bool CheckComputeError(SMESH_Algo* theAlgo, const TopoDS_Shape& theShape=TopoDS_Shape());
266 * \brief Return a hypothesis attached to theShape.
268 * If theHyp is provided, similar but not same hypotheses
269 * is returned; else an applicable ones having theHypType
272 const SMESH_Hypothesis* GetSimilarAttached(const TopoDS_Shape& theShape,
273 const SMESH_Hypothesis * theHyp,
274 const int theHypType = 0);
279 TopoDS_Shape _subShape;
280 SMESHDS_SubMesh * _subMeshDS;
281 SMESH_Mesh * _father;
284 std::map < int, SMESH_subMesh * >_mapDepend;
285 bool _dependenceAnalysed;
289 SMESH_ComputeErrorPtr _computeError;
291 // allow algo->Compute() if a subshape of lower dim is meshed but
292 // none mesh entity is bound to it. Eg StdMeshers_CompositeSegment_1D can
293 // mesh several edges as a whole and leave some of them without mesh entities
294 bool _alwaysComputed;