src/SMESH/SMESH_Hypothesis.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.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22 //
  23 //
  24 //  File   : SMESH_Hypothesis.hxx
  25 //  Author : Paul RASCLE, EDF
  26 //  Module : SMESH
  27 //  $Header$
  28
  29 #ifndef _SMESH_HYPOTHESIS_HXX_
  30 #define _SMESH_HYPOTHESIS_HXX_
  31
  32 #include "SMESHDS_Hypothesis.hxx"
  33
  34 class SMESH_Gen;
  35 class TopoDS_Shape;
  36 class SMESH_Mesh;
  37
  38 class SMESH_Hypothesis: public SMESHDS_Hypothesis
  39 {
  40 public:
  41   enum Hypothesis_Status // in the order of severity
  42   {
  43     HYP_OK,
  44     HYP_MISSING,      // algo misses a hypothesis
  45     HYP_CONCURENT,    // several applicable hypotheses
  46     HYP_BAD_PARAMETER,// hypothesis has a bad parameter value
  47     HYP_UNKNOWN_FATAL,//  --- all statuses below should be considered as fatal
  48                       //      for Add/RemoveHypothesis operations
  49     HYP_INCOMPATIBLE, // hypothesis does not fit algo
  50     HYP_NOTCONFORM,   // not conform mesh is produced appling a hypothesis
  51     HYP_ALREADY_EXIST,// such hypothesis already exist
  52     HYP_BAD_DIM,      // bad dimension
  53     HYP_BAD_SUBSHAPE  // shape is neither the main one, nor its subshape, nor a group
  54   };
  55   static bool IsStatusFatal(Hypothesis_Status theStatus)
  56   { return theStatus >= HYP_UNKNOWN_FATAL; }
  57
  58   SMESH_Hypothesis(int hypId, int studyId, SMESH_Gen* gen);
  59   virtual ~SMESH_Hypothesis();
  60   virtual int GetDim() const;
  61   int GetStudyId() const;
  62   virtual void NotifySubMeshesHypothesisModification();
  63   virtual int GetShapeType() const;
  64   virtual const char* GetLibName() const;
  65   void  SetLibName(const char* theLibName);
  66
  67   /*!
  68    * \brief Initialize my parameter values by the mesh built on the geometry
  69     * \param theMesh - the built mesh
  70     * \param theShape - the geometry of interest
  71     * \retval bool - true if parameter values have been successfully defined
  72    */
  73   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape)=0;
  74
  75   /*!
  76    * \brief Return true if me is an auxiliary hypothesis
  77     * \retval bool - auxiliary or not
  78    *
  79    * An auxiliary hypothesis is optional, i.e. an algorithm
  80    * can work without it and another hypothesis of the same
  81    * dimention can be assigned to the shape
  82    */
  83   virtual bool IsAuxiliary() const
  84   { return GetType() == PARAM_ALGO && _param_algo_dim <= 0; }
  85
  86 protected:
  87   SMESH_Gen* _gen;
  88   int _studyId;
  89   int _shapeType;
  90   int _param_algo_dim;
  91
  92 private:
  93   std::string _libName;
  94 };
  95
  96 #endif