src/StdMeshers/StdMeshers_NumberOfLayers.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 : idl implementation based on 'SMESH' unit's calsses
  24 //  File   : StdMeshers_NumberOfLayers.hxx
  25 //  Author : Edward AGAPOV
  26 //  Module : SMESH
  27 //
  28 #ifndef _SMESH_NumberOfLayers_HXX_
  29 #define _SMESH_NumberOfLayers_HXX_
  30
  31 #include "SMESH_StdMeshers.hxx"
  32
  33 #include "SMESH_Hypothesis.hxx"
  34 #include "Utils_SALOME_Exception.hxx"
  35
  36 class SMESH_Gen;
  37
  38 // =========================================================
  39 // =========================================================
  40 /*!
  41  * This hypothesis is used by "Radial prism" algorithm.
  42  * It specifies number of segments between the internal
  43  * and the external surfaces.
  44  */
  45 // =========================================================
  46 // =========================================================
  47
  48 class STDMESHERS_EXPORT StdMeshers_NumberOfLayers:  public SMESH_Hypothesis
  49 {
  50 public:
  51   // Constructor
  52   StdMeshers_NumberOfLayers( int hypId, int studyId, SMESH_Gen * gen );
  53   // Destructor
  54   virtual ~StdMeshers_NumberOfLayers();
  55
  56   // Sets <number of segments> parameter value
  57   void SetNumberOfLayers(int numberOfLayers) throw ( SALOME_Exception );
  58
  59   // Returns <number of layers> parameter value
  60   int GetNumberOfLayers() const;
  61
  62   virtual std::ostream & SaveTo(std::ostream & save);
  63   virtual std::istream & LoadFrom(std::istream & load);
  64   friend std::ostream & operator <<(std::ostream & save, StdMeshers_NumberOfLayers & hyp);
  65   friend std::istream & operator >>(std::istream & load, StdMeshers_NumberOfLayers & hyp);
  66
  67   /*!
  68    * \brief Initialize parameters by the mesh built on the geometry
  69     * \param theMesh - the built mesh
  70     * \param theShape - the geometry of interest
  71     * \retval bool - true if parameter values have been successfully defined
  72     *
  73     * Implementation does noting
  74    */
  75   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
  76
  77   /*!
  78    * \brief Initialize my parameter values by default parameters.
  79    *  \retval bool - true if parameter values have been successfully defined
  80    */
  81   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
  82
  83 protected:
  84   int _nbLayers;
  85 };
  86
  87 #endif
  88