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