Salome HOME
3584b51db4a9a7c27978a7431431624da944908b
[modules/smesh.git] / src / StdMeshers / StdMeshers_SegmentLengthAroundVertex.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 //
23 //
24 //  File   : StdMeshers_SegmentLengthAroundVertex.hxx
25 //  Author : Paul RASCLE, EDF
26 //  Module : SMESH
27 //  $Header$
28
29 #ifndef _SMESH_SegmentLengthAroundVertex_HXX_
30 #define _SMESH_SegmentLengthAroundVertex_HXX_
31
32 #include "SMESH_StdMeshers.hxx"
33
34 #include "SMESH_Hypothesis.hxx"
35 #include "Utils_SALOME_Exception.hxx"
36
37 /*!
38  * \brief This hypothesis specifies length of segments adjacent to the vertex the
39  * hypothesis is assigned to
40  */
41 class STDMESHERS_EXPORT StdMeshers_SegmentLengthAroundVertex:public SMESH_Hypothesis
42 {
43  public:
44   StdMeshers_SegmentLengthAroundVertex(int hypId, int studyId, SMESH_Gen * gen);
45   virtual ~ StdMeshers_SegmentLengthAroundVertex();
46
47   void SetLength(double length) throw(SALOME_Exception);
48
49   double GetLength() const;
50
51   virtual std::ostream & SaveTo(std::ostream & save);
52   virtual std::istream & LoadFrom(std::istream & load);
53   friend std::ostream & operator <<(std::ostream & save, StdMeshers_SegmentLengthAroundVertex & hyp);
54   friend std::istream & operator >>(std::istream & load, StdMeshers_SegmentLengthAroundVertex & hyp);
55
56   /*!
57    * \brief Initialize segment length by the mesh built on the geometry
58    * \param theMesh - the built mesh
59    * \param theShape - the geometry of interest
60    * \retval bool - true if parameter values have been successfully defined
61    */
62   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
63
64  protected:
65   double _length;
66 };
67
68 #endif