smesh/src/SMESH/SMESH_Hypothesis.hxx

137 lines
4.7 KiB
C++
Raw Normal View History

2013-04-01 19:05:47 +06:00
// Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
2009-02-17 10:27:49 +05:00
//
2012-08-09 16:03:55 +06:00
// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
2003-07-10 16:13:42 +06:00
//
2012-08-09 16:03:55 +06:00
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License.
2003-07-10 16:13:42 +06:00
//
2012-08-09 16:03:55 +06:00
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
2003-07-10 16:13:42 +06:00
//
2012-08-09 16:03:55 +06:00
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
2003-07-10 16:13:42 +06:00
//
2012-08-09 16:03:55 +06:00
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
2009-02-17 10:27:49 +05:00
//
2012-08-09 16:03:55 +06:00
2009-02-17 10:27:49 +05:00
// SMESH SMESH : implementaion of SMESH idl descriptions
2003-07-10 16:13:42 +06:00
// File : SMESH_Hypothesis.hxx
// Author : Paul RASCLE, EDF
// Module : SMESH
2009-02-17 10:27:49 +05:00
//
2003-05-19 19:18:36 +06:00
#ifndef _SMESH_HYPOTHESIS_HXX_
#define _SMESH_HYPOTHESIS_HXX_
#include "SMESH_SMESH.hxx"
2003-05-19 19:18:36 +06:00
#include "SMESHDS_Hypothesis.hxx"
class SMESH_Gen;
class TopoDS_Shape;
class SMESH_Mesh;
2003-05-19 19:18:36 +06:00
2009-02-17 10:27:49 +05:00
enum MeshDimension // dimension of mesh
{
MeshDim_0D = 0,
MeshDim_1D,
MeshDim_2D,
MeshDim_3D
};
class SMESH_EXPORT SMESH_Hypothesis: public SMESHDS_Hypothesis
2003-05-19 19:18:36 +06:00
{
public:
2004-06-18 14:55:35 +06:00
enum Hypothesis_Status // in the order of severity
{
HYP_OK = 0,
2004-06-18 14:55:35 +06:00
HYP_MISSING, // algo misses a hypothesis
2012-10-08 17:56:59 +06:00
HYP_CONCURENT, // several applicable hypotheses assigned to father shapes
2004-06-18 14:55:35 +06:00
HYP_BAD_PARAMETER,// hypothesis has a bad parameter value
HYP_HIDDEN_ALGO, // an algo is hidden by an upper dim algo generating all-dim elements
HYP_HIDING_ALGO, // an algo hides lower dim algos by generating all-dim elements
2004-06-18 14:55:35 +06:00
HYP_UNKNOWN_FATAL,// --- all statuses below should be considered as fatal
// for Add/RemoveHypothesis operations
HYP_INCOMPATIBLE, // hypothesis does not fit algo
HYP_NOTCONFORM, // not conform mesh is produced appling a hypothesis
2012-10-08 17:56:59 +06:00
HYP_ALREADY_EXIST,// several applicable hypothesis of same priority assigned
HYP_BAD_DIM, // bad dimension
2012-08-09 16:03:55 +06:00
HYP_BAD_SUBSHAPE, // shape is neither the main one, nor its sub-shape, nor a group
2009-02-17 10:27:49 +05:00
HYP_BAD_GEOMETRY, // shape geometry mismatches algorithm's expectation
HYP_NEED_SHAPE // algorithm can work on shape only
2004-06-18 14:55:35 +06:00
};
static bool IsStatusFatal(Hypothesis_Status theStatus)
{ return theStatus >= HYP_UNKNOWN_FATAL; }
2003-05-19 19:18:36 +06:00
SMESH_Hypothesis(int hypId, int studyId, SMESH_Gen* gen);
virtual ~SMESH_Hypothesis();
virtual int GetDim() const;
2013-02-12 20:37:44 +06:00
int GetStudyId() const;
SMESH_Gen* GetGen() const { return (SMESH_Gen*) _gen; }
virtual int GetShapeType() const;
virtual const char* GetLibName() const;
2013-02-12 20:37:44 +06:00
virtual void NotifySubMeshesHypothesisModification();
2004-06-18 14:55:35 +06:00
void SetLibName(const char* theLibName);
2003-05-19 19:18:36 +06:00
2012-10-08 17:56:59 +06:00
//void SetParameters(const char *theParameters);
//char* GetParameters() const;
2009-02-17 10:27:49 +05:00
2012-10-08 17:56:59 +06:00
// void SetLastParameters(const char* theParameters);
// char* GetLastParameters() const;
// void ClearParameters();
2009-02-17 10:27:49 +05:00
/*!
* \brief Initialize my parameter values by the mesh built on the geometry
2009-02-17 10:27:49 +05:00
* \param theMesh - the built mesh
* \param theShape - the geometry of interest
* \retval bool - true if parameter values have been successfully defined
*/
virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape)=0;
2009-02-17 10:27:49 +05:00
struct TDefaults
{
2012-08-09 16:03:55 +06:00
double _elemLength;
int _nbSegments;
TopoDS_Shape* _shape; // future shape of the mesh being created
2009-02-17 10:27:49 +05:00
};
/*!
* \brief Initialize my parameter values by default parameters.
* \retval bool - true if parameter values have been successfully defined
*/
virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0)=0;
/*!
* \brief Return true if me is an auxiliary hypothesis
* \retval bool - auxiliary or not
*
* An auxiliary hypothesis is optional, i.e. an algorithm
* can work without it and another hypothesis of the same
* dimention can be assigned to the shape
*/
virtual bool IsAuxiliary() const
{ return GetType() == PARAM_ALGO && _param_algo_dim < 0; }
2012-08-09 16:03:55 +06:00
/*!
* \brief Find a mesh with given persistent ID
*/
SMESH_Mesh* GetMeshByPersistentID(int id);
2003-05-19 19:18:36 +06:00
protected:
SMESH_Gen* _gen;
2012-10-08 17:56:59 +06:00
int _studyId;
int _shapeType;
int _param_algo_dim; // to be set at descendant hypothesis constructor
2004-06-18 14:55:35 +06:00
private:
2012-10-08 17:56:59 +06:00
std::string _libName; // name of library of plug-in Engine
//std::string _parameters;
//std::string _lastParameters;
2003-05-19 19:18:36 +06:00
};
#endif