src/StdMeshers/StdMeshers_Geometric1D.hxx

   1 // Copyright (C) 2007-2015  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_Geometric1D.hxx
  25 //  Module : SMESH
  26 //
  27 #ifndef _SMESH_Geometric1D_HXX_
  28 #define _SMESH_Geometric1D_HXX_
  29
  30 #include "SMESH_StdMeshers.hxx"
  31
  32 #include "StdMeshers_Reversible1D.hxx"
  33 #include "Utils_SALOME_Exception.hxx"
  34
  35 class STDMESHERS_EXPORT StdMeshers_Geometric1D: public StdMeshers_Reversible1D
  36 {
  37 public:
  38   StdMeshers_Geometric1D(int hypId, int studyId, SMESH_Gen* gen);
  39
  40   void SetStartLength(double length) throw(SALOME_Exception);
  41   void SetCommonRatio(double factor) throw(SALOME_Exception);
  42
  43   double GetStartLength() const;
  44   double GetCommonRatio() const;
  45
  46   virtual std::ostream & SaveTo(std::ostream & save);
  47   virtual std::istream & LoadFrom(std::istream & load);
  48
  49   /*!
  50    * \brief Initialize start and end length by the mesh built on the geometry
  51     * \param theMesh - the built mesh
  52     * \param theShape - the geometry of interest
  53     * \retval bool - true if parameter values have been successfully defined
  54    */
  55   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
  56
  57   /*!
  58    * \brief Initialize my parameter values by default parameters.
  59    *  \retval bool - true if parameter values have been successfully defined
  60    */
  61   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
  62
  63 protected:
  64   double _begLength, _ratio;
  65 };
  66
  67 #endif