Salome HOME
Merge Python 3 porting.
[plugins/netgenplugin.git] / 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                              ::SMESH_Gen*            theGenImpl);
54   // Destructor
55   virtual ~NETGENPlugin_Hypothesis_i();
56
57   void SetMaxSize(CORBA::Double theSize);
58   CORBA::Double GetMaxSize();
59
60   void SetMinSize(CORBA::Double theSize);
61   CORBA::Double GetMinSize();
62
63   void SetSecondOrder(CORBA::Boolean theVal);
64   CORBA::Boolean GetSecondOrder();
65
66   void SetOptimize(CORBA::Boolean theVal);
67   CORBA::Boolean GetOptimize();
68
69   void SetFineness(CORBA::Long theFineness);
70   CORBA::Long GetFineness();
71
72   void SetGrowthRate(CORBA::Double theRate);
73   CORBA::Double GetGrowthRate();
74
75   void SetNbSegPerEdge(CORBA::Double theVal);
76   CORBA::Double GetNbSegPerEdge();
77
78   void SetNbSegPerRadius(CORBA::Double theVal);
79   CORBA::Double GetNbSegPerRadius();
80
81   void SetLocalSizeOnShape(GEOM::GEOM_Object_ptr GeomObj, CORBA::Double localSize)
82     throw (SALOME::SALOME_Exception);
83   void SetLocalSizeOnEntry(const char* entry, CORBA::Double localSize);
84   CORBA::Double GetLocalSizeOnEntry(const char* entry);
85   NETGENPlugin::string_array* GetLocalSizeEntries();
86   void UnsetLocalSizeOnEntry(const char* entry);
87
88   void SetMeshSizeFile(const char* fileName);
89   char* GetMeshSizeFile();
90
91   void SetQuadAllowed(CORBA::Boolean theVal);
92   CORBA::Boolean GetQuadAllowed();
93
94   void SetUseSurfaceCurvature(CORBA::Boolean theVal);
95   CORBA::Boolean GetUseSurfaceCurvature();
96
97   void SetFuseEdges(CORBA::Boolean theVal);
98   CORBA::Boolean GetFuseEdges();
99
100   // Get implementation
101   ::NETGENPlugin_Hypothesis* GetImpl();
102   
103   // Verify whether hypothesis supports given entity type 
104   CORBA::Boolean IsDimSupported( SMESH::Dimension type );
105
106  protected:
107
108   // to remember whether a parameter is already set (issue 0021364)
109   enum SettingMethod
110   {
111     METH_SetMaxSize          = 1,
112     METH_SetMinSize          = 2,
113     METH_SetSecondOrder      = 4,
114     METH_SetOptimize         = 8,
115     METH_SetFineness         = 16,
116     METH_SetGrowthRate       = 32,
117     METH_SetNbSegPerEdge     = 64,
118     METH_SetNbSegPerRadius   = 128,
119     METH_SetLocalSizeOnEntry = 256,
120     METH_SetQuadAllowed      = METH_SetLocalSizeOnEntry * 2,
121     METH_SetSurfaceCurvature = METH_SetQuadAllowed * 2,
122     METH_SetFuseEdges        = METH_SetSurfaceCurvature * 2,
123     METH_LAST                = METH_SetFuseEdges
124   };
125   int mySetMethodFlags;
126
127   // Return true if a parameter is not yet set, else return true if a parameter changes.
128   // PythonDumping depends on the result of this function.
129   // Checking only change of a parameter is not enough because then the default values are
130   // not dumped and if the defaults will change then the behaviour of scripts
131   // created without dump of the default parameters will also change what is not good.
132   template<typename T>
133     bool isToSetParameter(T curValue, T newValue, /*SettingMethod*/int meth)
134   {
135     if ( mySetMethodFlags & meth ) // already set, check if a value is changing
136       return ( curValue != newValue );
137     else
138       return ( mySetMethodFlags |= meth ); // == return true
139   }
140
141  public:
142   // method intended to remove explicit treatment of Netgen hypotheses from
143   // SMESH_NoteBook to assure backward compatibility after implemeneting
144   // issue 0021308: Remove hard-coded dependency of the external mesh plugins
145   virtual int getParamIndex(const TCollection_AsciiString& method, int nbVars) const;
146
147   // method used to convert variable parameters stored in an old study
148   // into myMethod2VarParams. It should return a method name for an index of
149   // variable parameters. Index is countered from zero
150   virtual std::string getMethodOfParameter(const int paramIndex, int nbVars) const;
151 };
152
153 #endif