src/GHS3DPRLPlugin/GHS3DPRLPlugin_Hypothesis.hxx

   1 // Copyright (C) 2007-2014  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 // ---
  21 // File   : GHS3DPRLPlugin_Hypothesis.hxx
  22 // Author : Christian VAN WAMBEKE (CEA) (from Hexotic plugin Lioka RAZAFINDRAZAKA)
  23 // ---
  24 //
  25 #ifndef _GHS3DPRLPlugin_Hypothesis_HXX_
  26 #define _GHS3DPRLPlugin_Hypothesis_HXX_
  27
  28 #include "GHS3DPRLPlugin_Defs.hxx"
  29
  30 #include "SMESH_Hypothesis.hxx"
  31 #include "Utils_SALOME_Exception.hxx"
  32
  33 //  Parameters for work of GHS3DPRL
  34 //
  35
  36 class GHS3DPRLPLUGIN_EXPORT GHS3DPRLPlugin_Hypothesis: public SMESH_Hypothesis
  37 {
  38 public:
  39
  40   GHS3DPRLPlugin_Hypothesis(int hypId, int studyId, SMESH_Gen* gen);
  41
  42   void                  SetMEDName(std::string theVal);
  43   std::string           GetMEDName() const { return _MEDName; }
  44
  45   void                  SetNbPart(int theVal);
  46   int                   GetNbPart() const { return _NbPart; }
  47
  48   void                  SetKeepFiles(bool theVal);
  49   bool                  GetKeepFiles() const { return _KeepFiles; }
  50
  51   void                  SetBackground(bool theVal);
  52   bool                  GetBackground() const { return _Background; }
  53
  54   void                  SetToMeshHoles(bool theVal);
  55   bool                  GetToMeshHoles() const { return _ToMeshHoles; }
  56
  57   // the parameters default values
  58
  59   static std::string    GetDefaultMEDName();
  60   static int            GetDefaultNbPart();
  61   static bool           GetDefaultKeepFiles();
  62   static bool           GetDefaultBackground();
  63   static bool           GetDefaultToMeshHoles();
  64
  65   // Persistence
  66   virtual std::ostream& SaveTo(std::ostream& save);
  67   virtual std::istream& LoadFrom(std::istream& load);
  68   friend std::ostream&  operator <<(std::ostream& save, GHS3DPRLPlugin_Hypothesis& hyp);
  69   friend std::istream&  operator >>(std::istream& load, GHS3DPRLPlugin_Hypothesis& hyp);
  70
  71   /*!
  72    * \brief Does nothing
  73    * \param theMesh - the built mesh
  74    * \param theShape - the geometry of interest
  75    * \retval bool - always false
  76    */
  77   virtual bool          SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
  78   /*!
  79    * \brief Initialize my parameter values by default parameters.
  80    *  \retval bool - true if parameter values have been successfully defined
  81    */
  82   virtual bool          SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
  83
  84 private:
  85   int          _countSubMesh;
  86   int          _countTotal;
  87   int          _nodeRefNumber;
  88
  89   std::string  _MEDName;     // generic path/name of med files
  90   int          _NbPart;      // number of partitions
  91   bool         _KeepFiles;   // keep intermediates tepal files or not
  92   bool         _Background;  // tepal in background
  93   bool         _ToMeshHoles;
  94 };
  95
  96 #endif