Salome HOME
Merge from OCC_development_generic_2006
[modules/smesh.git] / src / SMESH / SMESH_Algo.hxx
index 53a0fbdde814bbf241e65fd8cd22e7d767a7d65e..c92b5893fe83a7761436aff3e27df6e941da4715 100644 (file)
 #include <string>
 #include <vector>
 #include <list>
-using namespace std;
 
-class SMESH_gen;
+class SMESH_Gen;
 class SMESH_Mesh;
+class TopoDS_Face;
+class TopoDS_Shape;
+class SMESHDS_Mesh;
 
 class SMESH_Algo:public SMESH_Hypothesis
 {
@@ -48,13 +50,14 @@ class SMESH_Algo:public SMESH_Hypothesis
        SMESH_Algo(int hypId, int studyId, SMESH_Gen * gen);
          virtual ~ SMESH_Algo();
 
-       const vector < string > &GetCompatibleHypothesis();
-       virtual bool CheckHypothesis(SMESH_Mesh & aMesh,
-               const TopoDS_Shape & aShape);
+       const std::vector < std::string > &GetCompatibleHypothesis();
+       virtual bool CheckHypothesis(SMESH_Mesh& aMesh,
+                                     const TopoDS_Shape& aShape,
+                                     SMESH_Hypothesis::Hypothesis_Status& aStatus) = 0;
 
-       virtual bool Compute(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape);
+       virtual bool Compute(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape) = 0;
 
-       virtual const list <const SMESHDS_Hypothesis *> &
+       virtual const std::list <const SMESHDS_Hypothesis *> &
                GetUsedHypothesis(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape);
 
        const list <const SMESHDS_Hypothesis *> &
@@ -62,15 +65,62 @@ class SMESH_Algo:public SMESH_Hypothesis
 
        static double EdgeLength(const TopoDS_Edge & E);
 
-       virtual ostream & SaveTo(ostream & save);
-       virtual istream & LoadFrom(istream & load);
-       friend ostream & operator <<(ostream & save, SMESH_Algo & hyp);
-       friend istream & operator >>(istream & load, SMESH_Algo & hyp);
+  /*!
+   * \brief Fill vector of node parameters on geometrical edge, including vertex nodes
+    * \param theMesh - The mesh containing nodes
+    * \param theEdge - The geometrical edge of interest
+    * \param theParams - The resulting vector of sorted node parameters
+    * \retval bool - false if not all parameters are OK
+   */
+  static bool GetNodeParamOnEdge(const SMESHDS_Mesh*     theMesh,
+                                 const TopoDS_Edge&      theEdge,
+                                 std::vector< double > & theParams);
 
-  protected:
-         vector<string> _compatibleHypothesis;
-         list<const SMESHDS_Hypothesis *> _appliedHypList;
-         list<const SMESHDS_Hypothesis *> _usedHypList;
+  //static bool GetSegmentLengths();
+
+  /*!
+   * \brief Find out elements orientation on a geometrical face
+   * \param theFace - The face correctly oriented in the shape being meshed
+   * \param theMeshDS - The mesh data structure
+   * \retval bool - true if the face normal and the normal of first element
+   *                in the correspoding submesh point in different directions
+   */
+  static bool IsReversedSubMesh (const TopoDS_Face&  theFace,
+                                 SMESHDS_Mesh*       theMeshDS);
+
+  /*!
+   * \brief Initialize my parameter values by the mesh built on the geometry
+    * \param theMesh - the built mesh
+    * \param theShape - the geometry of interest
+    * \retval bool - true if parameter values have been successfully defined
+    *
+    * Just return false as the algorithm does not hold parameters values
+   */
+  virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
+
+ public:
+        // algo features
+
+        // SMESH_Hypothesis::GetDim();
+        // 1 - dimention of target mesh
+
+        bool OnlyUnaryInput() const { return _onlyUnaryInput; }
+        // 2 - is collection of tesselatable shapes inacceptable as input;
+        // "collection" means a shape containing shapes of dim equal
+        // to GetDim().
+        // Algo which can process a collection shape should expect
+        // an input temporary shape that is neither MainShape nor
+        // its child.
+        
+        bool NeedDescretBoundary() const { return _requireDescretBoundary; }
+        // 3 - is a Dim-1 mesh prerequisite
+
+ protected:
+        bool _onlyUnaryInput;
+        bool _requireDescretBoundary;
+        std::vector<std::string> _compatibleHypothesis;
+        std::list<const SMESHDS_Hypothesis *> _appliedHypList;
+        std::list<const SMESHDS_Hypothesis *> _usedHypList;
 };
 
 #endif