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