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