src/SMESH/SMESH_Algo.hxx

   1 //  SMESH SMESH : implementaion of SMESH idl descriptions
   2 //
   3 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   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.
  10 //
  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.
  15 //
  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
  19 //
  20 //  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  21 //
  22 //
  23 //
  24 //  File   : SMESH_Algo.hxx
  25 //  Author : Paul RASCLE, EDF
  26 //  Module : SMESH
  27 //  $Header$
  28
  29 #ifndef _SMESH_ALGO_HXX_
  30 #define _SMESH_ALGO_HXX_
  31
  32 #include "SMESH_Hypothesis.hxx"
  33
  34 #include <TopoDS_Shape.hxx>
  35 #include <TopoDS_Edge.hxx>
  36
  37 #include <string>
  38 #include <vector>
  39 #include <list>
  40
  41 class SMESH_Gen;
  42 class SMESH_Mesh;
  43
  44 class SMESH_Algo:public SMESH_Hypothesis
  45 {
  46   public:
  47         SMESH_Algo(int hypId, int studyId, SMESH_Gen * gen);
  48           virtual ~ SMESH_Algo();
  49
  50         const std::vector < std::string > &GetCompatibleHypothesis();
  51         virtual bool CheckHypothesis(SMESH_Mesh& aMesh,
  52                                      const TopoDS_Shape& aShape,
  53                                      SMESH_Hypothesis::Hypothesis_Status& aStatus) = 0;
  54
  55         virtual bool Compute(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape) = 0;
  56
  57         virtual const std::list <const SMESHDS_Hypothesis *> &
  58                 GetUsedHypothesis(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape);
  59
  60         const list <const SMESHDS_Hypothesis *> &
  61                 GetAppliedHypothesis(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape);
  62
  63         static double EdgeLength(const TopoDS_Edge & E);
  64
  65  public:
  66         // algo features
  67
  68         // SMESH_Hypothesis::GetDim();
  69         // 1 - dimention of target mesh
  70
  71         bool OnlyUnaryInput() const { return _onlyUnaryInput; }
  72         // 2 - is collection of tesselatable shapes inacceptable as input;
  73         // "collection" means a shape containing shapes of dim equal
  74         // to GetDim().
  75         // Algo which can process a collection shape should expect
  76         // an input temporary shape that is neither MainShape nor
  77         // its child.
  78
  79         bool NeedDescretBoundary() const { return _requireDescretBoundary; }
  80         // 3 - is a Dim-1 mesh prerequisite
  81
  82  protected:
  83         bool _onlyUnaryInput;
  84         bool _requireDescretBoundary;
  85         std::vector<std::string> _compatibleHypothesis;
  86         std::list<const SMESHDS_Hypothesis *> _appliedHypList;
  87         std::list<const SMESHDS_Hypothesis *> _usedHypList;
  88 };
  89
  90 #endif