src/StdMeshers/StdMeshers_LayerDistribution.hxx

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