src/NETGENPlugin/NETGENPlugin_Hypothesis_i.hxx

   1 // Copyright (C) 2007-2016  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 //  NETGENPlugin : C++ implementation
  24 // File      : NETGENPlugin_Hypothesis_i.hxx
  25 // Author    : Michael Sazonov (OCN)
  26 // Date      : 03/04/2006
  27 // Project   : SALOME
  28 //=============================================================================
  29 //
  30 #ifndef _NETGENPlugin_Hypothesis_i_HXX_
  31 #define _NETGENPlugin_Hypothesis_i_HXX_
  32
  33 #include "NETGENPlugin_Defs.hxx"
  34
  35 #include <SALOMEconfig.h>
  36 #include CORBA_SERVER_HEADER(NETGENPlugin_Algorithm)
  37
  38 #include "SMESH_Hypothesis_i.hxx"
  39 #include "NETGENPlugin_Hypothesis.hxx"
  40
  41 class SMESH_Gen;
  42 //class GEOM_Object;
  43
  44 // NETGENPlugin parameters hypothesis
  45
  46 class NETGENPLUGIN_EXPORT NETGENPlugin_Hypothesis_i:
  47   public virtual POA_NETGENPlugin::NETGENPlugin_Hypothesis,
  48   public virtual SMESH_Hypothesis_i
  49 {
  50  public:
  51   // Constructor
  52   NETGENPlugin_Hypothesis_i (PortableServer::POA_ptr thePOA,
  53                              int                     theStudyId,
  54                              ::SMESH_Gen*            theGenImpl);
  55   // Destructor
  56   virtual ~NETGENPlugin_Hypothesis_i();
  57
  58   void SetMaxSize(CORBA::Double theSize);
  59   CORBA::Double GetMaxSize();
  60
  61   void SetMinSize(CORBA::Double theSize);
  62   CORBA::Double GetMinSize();
  63
  64   void SetSecondOrder(CORBA::Boolean theVal);
  65   CORBA::Boolean GetSecondOrder();
  66
  67   void SetOptimize(CORBA::Boolean theVal);
  68   CORBA::Boolean GetOptimize();
  69
  70   void SetFineness(CORBA::Long theFineness);
  71   CORBA::Long GetFineness();
  72
  73   void SetGrowthRate(CORBA::Double theRate);
  74   CORBA::Double GetGrowthRate();
  75
  76   void SetNbSegPerEdge(CORBA::Double theVal);
  77   CORBA::Double GetNbSegPerEdge();
  78
  79   void SetNbSegPerRadius(CORBA::Double theVal);
  80   CORBA::Double GetNbSegPerRadius();
  81
  82   void SetChordalErrorEnabled(CORBA::Boolean value);
  83   CORBA::Boolean GetChordalErrorEnabled();
  84   void SetChordalError(CORBA::Double value);
  85   CORBA::Double GetChordalError();
  86
  87   void SetLocalSizeOnShape(GEOM::GEOM_Object_ptr GeomObj, CORBA::Double localSize)
  88     throw (SALOME::SALOME_Exception);
  89   void SetLocalSizeOnEntry(const char* entry, CORBA::Double localSize);
  90   CORBA::Double GetLocalSizeOnEntry(const char* entry);
  91   NETGENPlugin::string_array* GetLocalSizeEntries();
  92   void UnsetLocalSizeOnEntry(const char* entry);
  93
  94   void SetMeshSizeFile(const char* fileName);
  95   char* GetMeshSizeFile();
  96
  97   void SetQuadAllowed(CORBA::Boolean theVal);
  98   CORBA::Boolean GetQuadAllowed();
  99
 100   void SetUseSurfaceCurvature(CORBA::Boolean theVal);
 101   CORBA::Boolean GetUseSurfaceCurvature();
 102
 103   void SetFuseEdges(CORBA::Boolean theVal);
 104   CORBA::Boolean GetFuseEdges();
 105
 106   // Get implementation
 107   ::NETGENPlugin_Hypothesis* GetImpl();
 108
 109   // Verify whether hypothesis supports given entity type
 110   CORBA::Boolean IsDimSupported( SMESH::Dimension type );
 111
 112  protected:
 113
 114   // to remember whether a parameter is already set (issue 0021364)
 115   enum SettingMethod
 116   {
 117     METH_SetMaxSize             = 1,
 118     METH_SetMinSize             = 2,
 119     METH_SetSecondOrder         = 4,
 120     METH_SetOptimize            = 8,
 121     METH_SetFineness            = 16,
 122     METH_SetGrowthRate          = 32,
 123     METH_SetNbSegPerEdge        = 64,
 124     METH_SetNbSegPerRadius      = 128,
 125     METH_SetLocalSizeOnEntry    = 256,
 126     METH_SetQuadAllowed         = METH_SetLocalSizeOnEntry * 2,
 127     METH_SetSurfaceCurvature    = METH_SetQuadAllowed * 2,
 128     METH_SetFuseEdges           = METH_SetSurfaceCurvature * 2,
 129     METH_SetChordalErrorEnabled = METH_SetFuseEdges * 2,
 130     METH_SetChordalError        = METH_SetChordalErrorEnabled * 2,
 131     METH_LAST                   = METH_SetFuseEdges
 132   };
 133   int mySetMethodFlags;
 134
 135   // Return true if a parameter is not yet set, else return true if a parameter changes.
 136   // PythonDumping depends on the result of this function.
 137   // Checking only change of a parameter is not enough because then the default values are
 138   // not dumped and if the defaults will change then the behaviour of scripts
 139   // created without dump of the default parameters will also change what is not good.
 140   template<typename T>
 141     bool isToSetParameter(T curValue, T newValue, /*SettingMethod*/int meth)
 142   {
 143     if ( mySetMethodFlags & meth ) // already set, check if a value is changing
 144       return ( curValue != newValue );
 145     else
 146       return ( mySetMethodFlags |= meth ); // == return true
 147   }
 148
 149  public:
 150   // method intended to remove explicit treatment of Netgen hypotheses from
 151   // SMESH_NoteBook to assure backward compatibility after implemeneting
 152   // issue 0021308: Remove hard-coded dependency of the external mesh plugins
 153   virtual int getParamIndex(const TCollection_AsciiString& method, int nbVars) const;
 154
 155   // method used to convert variable parameters stored in an old study
 156   // into myMethod2VarParams. It should return a method name for an index of
 157   // variable parameters. Index is countered from zero
 158   virtual std::string getMethodOfParameter(const int paramIndex, int nbVars) const;
 159 };
 160
 161 #endif