Salome HOME
correct previous integration (Porting to Python 2.6)
[modules/smesh.git] / src / StdMeshers / StdMeshers_MaxLength.hxx
1 //  SMESH SMESH : implementaion of SMESH idl descriptions
2 //
3 //  Copyright (C) 2003  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 //  File   : StdMeshers_MaxLength.hxx
23 //  Module : SMESH
24
25 #ifndef _SMESH_MaxLength_HXX_
26 #define _SMESH_MaxLength_HXX_
27
28 #include "SMESH_StdMeshers.hxx"
29
30 #include "SMESH_Hypothesis.hxx"
31 #include "Utils_SALOME_Exception.hxx"
32
33 class STDMESHERS_EXPORT StdMeshers_MaxLength: public SMESH_Hypothesis
34 {
35  public:
36   StdMeshers_MaxLength(int hypId, int studyId, SMESH_Gen * gen);
37   virtual ~ StdMeshers_MaxLength();
38
39   void SetLength(double length) throw(SALOME_Exception);
40   double GetLength() const;
41
42   bool HavePreestimatedLength() const  { return _preestimated > 0.; }
43   double GetPreestimatedLength() const { return _preestimated; }
44   void SetPreestimatedLength(double length);
45
46   void SetUsePreestimatedLength(bool toUse);
47   bool GetUsePreestimatedLength() const;
48
49   virtual std::ostream & SaveTo(std::ostream & save);
50   virtual std::istream & LoadFrom(std::istream & load);
51
52   /*!
53    * \brief Initialize segment length by the mesh built on the geometry
54    * \param theMesh - the built mesh
55    * \param theShape - the geometry of interest
56    * \retval bool - true if parameter values have been successfully defined
57    */
58   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
59
60   /*!
61    * \brief Initialize my parameter values by default parameters.
62    *  \retval bool - true if parameter values have been successfully defined
63    */
64   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
65
66  protected:
67   double _length, _preestimated;
68   bool   _preestimation;
69 };
70
71 #endif