-//=============================================================================
-// File : SMESH_subMesh.hxx
-// Created : jeu mai 30 13:28:36 CEST 2002
-// Author : Paul RASCLE, EDF
-// Project : SALOME
-// Copyright : EDF 2002
-// $Header$
-//=============================================================================
+// Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
+//
+// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// 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.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+// File : SMESH_subMesh.hxx
+// Author : Paul RASCLE, EDF
+// Module : SMESH
+//
#ifndef _SMESH_SUBMESH_HXX_
#define _SMESH_SUBMESH_HXX_
-#include "SMESHDS_Mesh.hxx"
-#include "SMESHDS_SubMesh.hxx"
+#include "SMESH_SMESH.hxx"
+
+#include "SMDS_Iterator.hxx"
+#include "SMESH_ComputeError.hxx"
+#include "SMESH_Algo.hxx"
+
#include "Utils_SALOME_Exception.hxx"
+
#include <TopoDS_Shape.hxx>
-#include <TColStd_IndexedMapOfTransient.hxx>
-#include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
-#include <set>
#include <list>
#include <map>
-class SMESH_Mesh;
+class SMESHDS_Mesh;
+class SMESHDS_SubMesh;
+class SMESH_Algo;
+class SMESH_Gen;
class SMESH_Hypothesis;
+class SMESH_Mesh;
+class SMESH_subMesh;
+class SMESH_subMeshEventListener;
+class SMESH_subMeshEventListenerData;
+
+typedef SMESH_subMeshEventListener EventListener;
+typedef SMESH_subMeshEventListenerData EventListenerData;
-class SMESH_subMesh
+typedef boost::shared_ptr< SMDS_Iterator<SMESH_subMesh*> > SMESH_subMeshIteratorPtr;
+
+
+class SMESH_EXPORT SMESH_subMesh
{
-public:
- SMESH_subMesh(int Id,
- SMESH_Mesh* father,
- const Handle(SMESHDS_Mesh)& meshDS,
- const TopoDS_Shape & aSubShape);
- virtual ~SMESH_subMesh();
+ public:
+ SMESH_subMesh(int Id,
+ SMESH_Mesh * father,
+ SMESHDS_Mesh * meshDS,
+ const TopoDS_Shape & aSubShape);
+ virtual ~ SMESH_subMesh();
+
+ int GetId() const; // == meshDS->ShapeToIndex( aSubShape )
+
+ SMESH_Mesh* GetFather() { return _father; }
+
+ SMESHDS_SubMesh * GetSubMeshDS();
+ const SMESHDS_SubMesh * GetSubMeshDS() const;
+
+ SMESHDS_SubMesh* CreateSubMeshDS();
+ // Explicit SMESHDS_SubMesh creation method, required for persistence mechanism
- int GetId();
+ SMESH_subMesh *GetFirstToCompute();
-// bool Contains(const TopoDS_Shape & aSubShape)
-// throw (SALOME_Exception);
+ SMESH_Algo* GetAlgo() const;
- const Handle(SMESHDS_SubMesh)& GetSubMeshDS()
- throw (SALOME_Exception);
+ const std::map < int, SMESH_subMesh * >& DependsOn();
+ bool DependsOn( const SMESH_subMesh* other ) const;
+ bool DependsOn( const int shapeID ) const;
+ /*!
+ * \brief Return iterator on the sub-meshes this one depends on. By default
+ * most simple sub-meshes go first.
+ */
+ SMESH_subMeshIteratorPtr getDependsOnIterator(const bool includeSelf,
+ const bool complexShapeFirst=false) const;
- SMESH_subMesh* GetFirstToCompute()
- throw (SALOME_Exception);
+ const std::vector< SMESH_subMesh * > & GetAncestors() const;
+ void ClearAncestors();
- const map<int, SMESH_subMesh*>& DependsOn();
- const map<int, SMESH_subMesh*>& Dependants();
+ const TopoDS_Shape & GetSubShape() const;
- const TopoDS_Shape& GetSubShape();
+ enum compute_state
+ {
+ NOT_READY, READY_TO_COMPUTE, COMPUTE_OK, FAILED_TO_COMPUTE
+ };
+ enum algo_state
+ {
+ NO_ALGO, MISSING_HYP, HYP_OK
+ };
+ enum algo_event
+ {
+ 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_ALGO_STATE, COMPUTE, COMPUTE_SUBMESH, COMPUTE_NOGEOM, COMPUTE_CANCELED,
+ CLEAN, SUBMESH_COMPUTED, SUBMESH_RESTORED, SUBMESH_LOADED,
+ MESH_ENTITY_REMOVED, CHECK_COMPUTE_STATE
+ };
+ enum event_type
+ {
+ ALGO_EVENT, COMPUTE_EVENT
+ };
- bool _vertexSet; // only for vertex subMesh, set to false for dim > 0
+ // ==================================================================
+ // Members to track non hierarchical dependencies between sub-meshes
+ // ==================================================================
- enum compute_state { NOT_READY, READY_TO_COMPUTE,
- COMPUTE_OK, FAILED_TO_COMPUTE };
- enum algo_state { NO_ALGO, MISSING_HYP, HYP_OK };
- enum algo_event {ADD_HYP, ADD_ALGO,
- REMOVE_HYP, REMOVE_ALGO,
- ADD_FATHER_HYP, ADD_FATHER_ALGO,
- REMOVE_FATHER_HYP, REMOVE_FATHER_ALGO};
- enum compute_event {MODIF_HYP, MODIF_ALGO_STATE, COMPUTE,
- CLEAN, CLEANDEP, SUBMESH_COMPUTED};
+ /*!
+ * \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
+ *
+ * The method remembers the submesh \awhere it puts the listener in order to delete
+ * it when HYP_OK algo_state is lost
+ * After being set, event listener is notified on each event of \awhere submesh.
+ */
+ void SetEventListener(EventListener* listener,
+ EventListenerData* data,
+ SMESH_subMesh* where);
- bool AlgoStateEngine(int event, SMESH_Hypothesis* anHyp)
- throw (SALOME_Exception);
+ /*!
+ * \brief Return an event listener data
+ * \param listener - the listener whose data is
+ * \param myOwn - if \c true, returns a listener set by this sub-mesh,
+ * else returns a listener listening to events of this sub-mesh
+ * \retval EventListenerData* - found data, maybe NULL
+ */
+ EventListenerData* GetEventListenerData(EventListener* listener,
+ const bool myOwn=false) const;
- void SubMeshesAlgoStateEngine(int event, SMESH_Hypothesis* anHyp)
- throw (SALOME_Exception);
+ /*!
+ * \brief Return an event listener data
+ * \param listenerName - the listener name
+ * \param myOwn - if \c true, returns a listener set by this sub-mesh,
+ * else returns a listener listening to events of this sub-mesh
+ * \retval EventListenerData* - found data, maybe NULL
+ */
+ EventListenerData* GetEventListenerData(const std::string& listenerName,
+ const bool myOwn=false) 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* > _eventListeners;
+
+ //!< event listeners to delete when HYP_OK algo_state is lost
+ struct OwnListenerData {
+ SMESH_subMesh* mySubMesh;
+ int myMeshID; // id of mySubMesh->GetFather()
+ int mySubMeshID;
+ EventListener* myListener;
+ OwnListenerData( SMESH_subMesh* sm=0, EventListener* el=0);
+ };
+ std::list< OwnListenerData > _ownListeners;
+
+ /*!
+ * \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();
+
+ /*!
+ * \brief loads dependent meshes on SUBMESH_LOADED event
+ */
+ void loadDependentMeshes();
+
+ // END: Members to track non hierarchical dependencies between submeshes
+ // =====================================================================
+
+public:
+
+ SMESH_Hypothesis::Hypothesis_Status
+ AlgoStateEngine(algo_event event, SMESH_Hypothesis * anHyp);
+
+ SMESH_Hypothesis::Hypothesis_Status
+ SubMeshesAlgoStateEngine(algo_event event, SMESH_Hypothesis * anHyp, bool exitOnFatal=false);
+
+ algo_state GetAlgoState() const { return _algoState; }
+ compute_state GetComputeState() const { return _computeState; }
+ SMESH_ComputeErrorPtr& GetComputeError() { return _computeError; }
void DumpAlgoState(bool isMain);
- bool ComputeStateEngine(int event)
- throw (SALOME_Exception);
+ bool ComputeStateEngine(compute_event event);
+ void ComputeSubMeshStateEngine(compute_event event, const bool includeSelf=false);
+
+ bool Evaluate(MapShapeNbElems& aResMap);
+
+ bool IsConform(const SMESH_Algo* theAlgo);
+ // check if a conform mesh will be produced by the Algo
+
+ bool CanAddHypothesis(const SMESH_Hypothesis* theHypothesis) const;
+ // return true if theHypothesis can be attached to me:
+ // its dimention is checked
+
+ static bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis,
+ const TopAbs_ShapeEnum theShapeType);
+
+ bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis) const;
+ // 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
+
+ /*!
+ * \brief Return true if no mesh entities is bound to the submesh
+ */
+ bool IsEmpty() const;
+
+ bool IsMeshComputed() const;
+ // check if _subMeshDS contains mesh elements unless _alwaysComputed==true
- int GetComputeState() {return _computeState;};
+ /*!
+ * \brief Allow algo->Compute() if a subshape of lower dim is meshed but
+ * none mesh entity is bound to it
+ */
+ void SetIsAlwaysComputed(bool isAlCo);
+ bool IsAlwaysComputed() { return _alwaysComputed; }
+
+ bool SubMeshesComputed(bool * isFailedToCompute=0) const;
+
+ int GetComputeCost() const;
+ // how costly is to compute this sub-mesh
+
+ /*!
+ * \brief Find common submeshes (based on shared subshapes with other
+ * \param theOther submesh to check
+ * \param theCommonIds set of common submesh IDs
+ * NOTE: this method does not cleat set before collect common IDs
+ */
+ bool FindIntersection( const SMESH_subMesh * theOther,
+ std::set<const SMESH_subMesh*>& theSetOfCommon ) const;
protected:
- void InsertDependence(const TopoDS_Shape aSubShape);
-// void FinalizeDependence(list<TopoDS_Shape>& shapeList);
-
- bool SubMeshesComputed()
- throw (SALOME_Exception);
-
- bool SubMeshesReady();
-
- void RemoveSubMeshElementsAndNodes();
- void UpdateDependantsState();
- void CleanDependants();
- void ExtractDependants(const TopTools_IndexedDataMapOfShapeListOfShape& M,
- const TopAbs_ShapeEnum etype);
- void SetAlgoState(int state);
-
- TopoDS_Shape _subShape;
- Handle (SMESHDS_Mesh) _meshDS;
- Handle (SMESHDS_SubMesh) _subMeshDS;
- int _Id;
- SMESH_Mesh* _father;
- map<int, SMESH_subMesh*> _mapDepend;
- map<int, SMESH_subMesh*> _mapDependants;
- bool _dependenceAnalysed;
- bool _dependantsFound;
-
- int _algoState;
- int _oldAlgoState;
- int _computeState;
+ // ==================================================================
+ void insertDependence(const TopoDS_Shape aShape,
+ TopAbs_ShapeEnum aSubType,
+ TopAbs_ShapeEnum avoidType=TopAbs_SHAPE);
+
+ void removeSubMeshElementsAndNodes();
+ void updateDependantsState(const compute_event theEvent);
+ void updateSubMeshState(const compute_state theState);
+ void cleanDependants();
+ void cleanDependsOn( SMESH_Algo* algoRequiringCleaning=0 );
+ void setAlgoState(algo_state state);
+
+ /*!
+ * \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,
+ bool & theSubFailed,
+ std::vector<SMESH_subMesh*>& theSubs);
+ /*!
+ * \brief Update compute_state by _computeError
+ * \retval bool - false if there are errors
+ */
+ bool checkComputeError(SMESH_Algo* theAlgo,
+ const bool theComputeOK,
+ 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);
+ //
+ int computeCost() const;
+
+protected:
+
+ TopoDS_Shape _subShape;
+ SMESHDS_SubMesh * _subMeshDS;
+ SMESH_Mesh * _father;
+ int _Id;
+
+ std::map < int, SMESH_subMesh * >_mapDepend;
+ bool _dependenceAnalysed;
+ std::vector< SMESH_subMesh * > _ancestors;
+
+ SMESH_Algo * _algo; // the algorithm found by last *StateEngine() call
+ algo_state _algoState;
+ compute_state _computeState;
+ SMESH_ComputeErrorPtr _computeError;
+ int _computeCost; // how costly is to compute this sub-mesh
+ int _realComputeCost; // _computeCost depending on presence of needed hypotheses
+
+ // allow algo->Compute() if a sub-shape 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;
};
