1 // Copyright (C) 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // SMESH SMESH : implementaion of SMESH idl descriptions
23 // File : SMESH_Hypothesis.hxx
24 // Author : Paul RASCLE, EDF
28 #ifndef _SMESH_HYPOTHESIS_HXX_
29 #define _SMESH_HYPOTHESIS_HXX_
31 #include "SMESH_SMESH.hxx"
33 #include "SMESHDS_Hypothesis.hxx"
41 enum MeshDimension // dimension of mesh
49 class SMESH_EXPORT SMESH_Hypothesis: public SMESHDS_Hypothesis
52 enum Hypothesis_Status // in the order of severity
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
70 static bool IsStatusFatal(Hypothesis_Status theStatus)
71 { return theStatus >= HYP_UNKNOWN_FATAL; }
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);
82 void SetParameters(const std::list<std::string>& theParameters);
83 std::list<std::string> GetParameters() const;
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
91 virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape)=0;
99 * \brief Initialize my parameter values by default parameters.
100 * \retval bool - true if parameter values have been successfully defined
102 virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0)=0;
105 * \brief Return true if me is an auxiliary hypothesis
106 * \retval bool - auxiliary or not
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
112 virtual bool IsAuxiliary() const
113 { return GetType() == PARAM_ALGO && _param_algo_dim < 0; }
122 std::string _libName;
123 std::list<std::string> _parameters;