]> SALOME platform Git repositories - modules/smesh.git/blob - src/SMESH/SMESH_Hypothesis.hxx
Salome HOME
0020168: EDF SMESH 953: uncomplete selection with filter 'belong on geom'
[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 //
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 enum MeshDimension // dimension of mesh
40 {
41   MeshDim_0D = 0,
42   MeshDim_1D,
43   MeshDim_2D,
44   MeshDim_3D
45 };
46
47 class SMESH_EXPORT SMESH_Hypothesis: public SMESHDS_Hypothesis
48 {
49 public:
50   enum Hypothesis_Status // in the order of severity
51   {
52     HYP_OK = 0,
53     HYP_MISSING,      // algo misses a hypothesis
54     HYP_CONCURENT,    // several applicable hypotheses
55     HYP_BAD_PARAMETER,// hypothesis has a bad parameter value
56     HYP_HIDDEN_ALGO,  // an algo is hidden by an upper dim algo generating all-dim elements
57     HYP_HIDING_ALGO,  // an algo hides lower dim algos by generating all-dim elements
58     HYP_UNKNOWN_FATAL,//  --- all statuses below should be considered as fatal
59                       //      for Add/RemoveHypothesis operations
60     HYP_INCOMPATIBLE, // hypothesis does not fit algo
61     HYP_NOTCONFORM,   // not conform mesh is produced appling a hypothesis
62     HYP_ALREADY_EXIST,// such hypothesis already exist
63     HYP_BAD_DIM,      // bad dimension
64     HYP_BAD_SUBSHAPE, // shape is neither the main one, nor its subshape, nor a group
65     HYP_BAD_GEOMETRY, // shape geometry mismatches algorithm's expectation
66     HYP_NEED_SHAPE    // algorithm can work on shape only
67   };
68   static bool IsStatusFatal(Hypothesis_Status theStatus)
69   { return theStatus >= HYP_UNKNOWN_FATAL; }
70
71   SMESH_Hypothesis(int hypId, int studyId, SMESH_Gen* gen);
72   virtual ~SMESH_Hypothesis();
73   virtual int GetDim() const;
74   int GetStudyId() const;
75   virtual void NotifySubMeshesHypothesisModification();
76   virtual int GetShapeType() const;
77   virtual const char* GetLibName() const;
78   void  SetLibName(const char* theLibName);
79
80   void  SetParameters(const char *theParameters);
81   char* GetParameters() const;
82
83   void SetLastParameters(const char* theParameters);
84   char* GetLastParameters() const;
85   void ClearParameters();
86   
87   /*!
88    * \brief Initialize my parameter values by the mesh built on the geometry
89    *  \param theMesh - the built mesh
90    *  \param theShape - the geometry of interest
91    *  \retval bool - true if parameter values have been successfully defined
92    */
93   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape)=0;
94
95   struct TDefaults
96   {
97     double _elemLength;
98     int    _nbSegments;
99   };
100   /*!
101    * \brief Initialize my parameter values by default parameters.
102    *  \retval bool - true if parameter values have been successfully defined
103    */
104   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0)=0;
105
106   /*!
107    * \brief Return true if me is an auxiliary hypothesis
108     * \retval bool - auxiliary or not
109    * 
110    * An auxiliary hypothesis is optional, i.e. an algorithm
111    * can work without it and another hypothesis of the same
112    * dimention can be assigned to the shape
113    */
114   virtual bool IsAuxiliary() const
115   { return GetType() == PARAM_ALGO && _param_algo_dim < 0; }
116
117 protected:
118   SMESH_Gen* _gen;
119   int _studyId;
120   int _shapeType;
121   int _param_algo_dim;
122
123 private:
124   std::string _libName;
125   std::string _parameters;
126   std::string _lastParameters;
127 };
128
129 #endif