Salome HOME
Update copyrights 2014.
[modules/smesh.git] / src / StdMeshers / StdMeshers_SegmentLengthAroundVertex.hxx
1 // Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  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, or (at your option) any later version.
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 //  SMESH SMESH : implementaion of SMESH idl descriptions
24 //  File   : StdMeshers_SegmentLengthAroundVertex.hxx
25 //  Author : Paul RASCLE, EDF
26 //  Module : SMESH
27 //
28 #ifndef _SMESH_SegmentLengthAroundVertex_HXX_
29 #define _SMESH_SegmentLengthAroundVertex_HXX_
30
31 #include "SMESH_StdMeshers.hxx"
32
33 #include "SMESH_Hypothesis.hxx"
34 #include "Utils_SALOME_Exception.hxx"
35
36 /*!
37  * \brief This hypothesis specifies length of segments adjacent to the vertex the
38  * hypothesis is assigned to
39  */
40 class STDMESHERS_EXPORT StdMeshers_SegmentLengthAroundVertex:public SMESH_Hypothesis
41 {
42  public:
43   StdMeshers_SegmentLengthAroundVertex(int hypId, int studyId, SMESH_Gen * gen);
44   virtual ~ StdMeshers_SegmentLengthAroundVertex();
45
46   void SetLength(double length) throw(SALOME_Exception);
47
48   double GetLength() const;
49
50   virtual std::ostream & SaveTo(std::ostream & save);
51   virtual std::istream & LoadFrom(std::istream & load);
52   friend std::ostream & operator <<(std::ostream & save, StdMeshers_SegmentLengthAroundVertex & hyp);
53   friend std::istream & operator >>(std::istream & load, StdMeshers_SegmentLengthAroundVertex & hyp);
54
55   /*!
56    * \brief Initialize segment length by the mesh built on the geometry
57    * \param theMesh - the built mesh
58    * \param theShape - the geometry of interest
59    * \retval bool - true if parameter values have been successfully defined
60    */
61   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
62
63   /*!
64    * \brief Initialize my parameter values by default parameters.
65    *  \retval bool - true if parameter values have been successfully defined
66    */
67   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
68
69  protected:
70   double _length;
71 };
72
73 #endif