1 // Copyright (C) 2007-2013 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
23 // SMESH SMESH : implementaion of SMESH idl descriptions
24 // File : SMESH_Hypothesis.hxx
25 // Author : Paul RASCLE, EDF
28 #ifndef _SMESH_HYPOTHESIS_HXX_
29 #define _SMESH_HYPOTHESIS_HXX_
31 #include "SMESH_SMESH.hxx"
33 #include "SMESHDS_Hypothesis.hxx"
39 enum MeshDimension // dimension of mesh
47 class SMESH_EXPORT SMESH_Hypothesis: public SMESHDS_Hypothesis
50 enum Hypothesis_Status // in the order of severity
53 HYP_MISSING, // algo misses a hypothesis
54 HYP_CONCURENT, // several applicable hypotheses assigned to father shapes
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,// several applicable hypothesis of same priority assigned
63 HYP_BAD_DIM, // bad dimension
64 HYP_BAD_SUBSHAPE, // shape is neither the main one, nor its sub-shape, nor a group
65 HYP_BAD_GEOMETRY, // shape geometry mismatches algorithm's expectation
66 HYP_NEED_SHAPE // algorithm can work on shape only
68 static bool IsStatusFatal(Hypothesis_Status theStatus)
69 { return theStatus >= HYP_UNKNOWN_FATAL; }
71 SMESH_Hypothesis(int hypId, int studyId, SMESH_Gen* gen);
72 virtual ~SMESH_Hypothesis();
73 virtual int GetDim() const;
74 int GetStudyId() const;
75 SMESH_Gen* GetGen() const { return (SMESH_Gen*) _gen; }
76 virtual int GetShapeType() const;
77 virtual const char* GetLibName() const;
78 virtual void NotifySubMeshesHypothesisModification();
79 void SetLibName(const char* theLibName);
81 //void SetParameters(const char *theParameters);
82 //char* GetParameters() const;
84 // void SetLastParameters(const char* theParameters);
85 // char* GetLastParameters() const;
86 // void ClearParameters();
89 * \brief Initialize my parameter values by the mesh built on the geometry
90 * \param theMesh - the built mesh
91 * \param theShape - the geometry of interest
92 * \retval bool - true if parameter values have been successfully defined
94 virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape)=0;
100 TopoDS_Shape* _shape; // future shape of the mesh being created
103 * \brief Initialize my parameter values by default parameters.
104 * \retval bool - true if parameter values have been successfully defined
106 virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0)=0;
109 * \brief Return true if me is an auxiliary hypothesis
110 * \retval bool - auxiliary or not
112 * An auxiliary hypothesis is optional, i.e. an algorithm
113 * can work without it and another hypothesis of the same
114 * dimention can be assigned to the shape
116 virtual bool IsAuxiliary() const
117 { return GetType() == PARAM_ALGO && _param_algo_dim < 0; }
120 * \brief Find a mesh with given persistent ID
122 SMESH_Mesh* GetMeshByPersistentID(int id);
128 int _param_algo_dim; // to be set at descendant hypothesis constructor
131 std::string _libName; // name of library of plug-in Engine
132 //std::string _parameters;
133 //std::string _lastParameters;