src/StdMeshers/StdMeshers_NumberOfLayers.hxx

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