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 "SMESH_SMESH.hxx"
  33
  34 #include "SMESHDS_Hypothesis.hxx"
  35
  36 class SMESH_Gen;
  37 class TopoDS_Shape;
  38 class SMESH_Mesh;
  39
  40 enum MeshDimension // dimension of mesh
  41 {
  42   MeshDim_0D,
  43   MeshDim_1D,
  44   MeshDim_2D,
  45   MeshDim_3D
  46 };
  47
  48 class SMESH_EXPORT SMESH_Hypothesis: public SMESHDS_Hypothesis
  49 {
  50 public:
  51   enum Hypothesis_Status // in the order of severity
  52   {
  53     HYP_OK = 0,
  54     HYP_MISSING,      // algo misses a hypothesis
  55     HYP_CONCURENT,    // several applicable hypotheses
  56     HYP_BAD_PARAMETER,// hypothesis has a bad parameter value
  57     HYP_HIDDEN_ALGO,  // an algo is hidden by an upper dim algo generating all-dim elements
  58     HYP_HIDING_ALGO,  // an algo hides lower dim algos by generating all-dim elements
  59     HYP_UNKNOWN_FATAL,//  --- all statuses below should be considered as fatal
  60                       //      for Add/RemoveHypothesis operations
  61     HYP_INCOMPATIBLE, // hypothesis does not fit algo
  62     HYP_NOTCONFORM,   // not conform mesh is produced appling a hypothesis
  63     HYP_ALREADY_EXIST,// such hypothesis already exist
  64     HYP_BAD_DIM,      // bad dimension
  65     HYP_BAD_SUBSHAPE, // shape is neither the main one, nor its subshape, nor a group
  66     HYP_BAD_GEOMETRY, // shape geometry mismatches algorithm's expectation
  67     HYP_NEED_SHAPE    // algorithm can work on shape only
  68   };
  69   static bool IsStatusFatal(Hypothesis_Status theStatus)
  70   { return theStatus >= HYP_UNKNOWN_FATAL; }
  71
  72   SMESH_Hypothesis(int hypId, int studyId, SMESH_Gen* gen);
  73   virtual ~SMESH_Hypothesis();
  74   virtual int GetDim() const;
  75   int GetStudyId() const;
  76   virtual void NotifySubMeshesHypothesisModification();
  77   virtual int GetShapeType() const;
  78   virtual const char* GetLibName() const;
  79   void  SetLibName(const char* theLibName);
  80
  81   /*!
  82    * \brief Initialize my parameter values by the mesh built on the geometry
  83     * \param theMesh - the built mesh
  84     * \param theShape - the geometry of interest
  85     * \retval bool - true if parameter values have been successfully defined
  86    */
  87   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape)=0;
  88
  89   /*!
  90    * \brief Return true if me is an auxiliary hypothesis
  91     * \retval bool - auxiliary or not
  92    *
  93    * An auxiliary hypothesis is optional, i.e. an algorithm
  94    * can work without it and another hypothesis of the same
  95    * dimention can be assigned to the shape
  96    */
  97   virtual bool IsAuxiliary() const
  98   { return GetType() == PARAM_ALGO && _param_algo_dim < 0; }
  99
 100 protected:
 101   SMESH_Gen* _gen;
 102   int _studyId;
 103   int _shapeType;
 104   int _param_algo_dim;
 105
 106 private:
 107   std::string _libName;
 108 };
 109
 110 #endif