1 // Copyright (C) 2007-2023 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 // File : HexoticPlugin_Algorithm.idl
22 // Author : Lioka RAZAFINDRAZAKA (CEA)
25 #ifndef _SMESH_HexoticALGORITHM_IDL_
26 #define _SMESH_HexoticALGORITHM_IDL_
28 #include "SMESH_Hypothesis.idl"
29 #include "SMESH_Mesh.idl"
30 #include "GEOM_Gen.idl"
33 * HexoticPlugin: interfaces to Hexotic related hypotheses and algorithms
37 typedef sequence<string> string_array;
40 * Type definitions for the size maps
42 struct HexoticPluginSizeMap {
47 typedef sequence<HexoticPluginSizeMap> HexoticPluginSizeMapsList;
50 * HexoticPlugin_Hexotic: interface of Hexotic algorithm
52 interface HexoticPlugin_Hexotic : SMESH::SMESH_3D_Algo
57 * HexoticPlugin_Hypothesis: interface of "Hexotic parameters" hypothesis
59 interface HexoticPlugin_Hypothesis : SMESH::SMESH_Hypothesis
61 void SetHexesMinLevel(in long value);
62 long GetHexesMinLevel();
64 void SetHexesMaxLevel(in long value);
65 long GetHexesMaxLevel();
67 void SetMinSize(in double value);
70 void SetMaxSize(in double value);
73 void SetGeomApproxAngle(in double angle);
74 double GetGeomApproxAngle();
76 void SetHexoticIgnoreRidges(in boolean value);
77 boolean GetHexoticIgnoreRidges();
79 void SetHexoticInvalidElements(in boolean value);
80 boolean GetHexoticInvalidElements();
82 void SetHexoticSharpAngleThreshold(in double value);
83 double GetHexoticSharpAngleThreshold();
85 void SetHexoticNbProc(in long value);
86 long GetHexoticNbProc();
88 void SetHexoticWorkingDirectory(in string path) raises (SALOME::SALOME_Exception);
89 string GetHexoticWorkingDirectory();
91 void SetHexoticSdMode(in long value);
92 long GetHexoticSdMode();
94 void SetHexoticVerbosity(in long value);
95 long GetHexoticVerbosity();
97 void SetHexoticMaxMemory(in long value);
98 long GetHexoticMaxMemory();
100 void SetKeepFiles(in boolean toKeep);
101 boolean GetKeepFiles();
103 void SetStandardOutputLog(in boolean logInStandardOutput);
104 boolean GetStandardOutputLog();
106 void SetRemoveLogOnSuccess(in boolean removeLogOnSuccess);
107 boolean GetRemoveLogOnSuccess();
110 * Set advanced option value
112 void SetOptionValue(in string optionName,
113 in string optionValue) raises (SALOME::SALOME_Exception);
114 string GetOptionValue(in string optionName) raises (SALOME::SALOME_Exception);
115 void UnsetOption(in string optionName);
117 * Adds custom advanced option and its value
119 void SetAdvancedOption(in string optionsAndValues) // in a form "option_1 v1 option_2 v2'"
120 raises (SALOME::SALOME_Exception);
121 string GetAdvancedOption();
122 void AddOption(in string optionName, in string optionValue);
123 string GetOption(in string optionName);
124 void SetTextOptions(in string option);// obsolete
125 string GetTextOptions(); // obsolete
127 * Return array of strings each of which is option name concatenated
128 * with option value devided by semicolon - "option_name:option_value:option_type".
129 * Option value is empty if an option is not set.
130 * option_type: 1 if user-define, 0 if default
131 * Note: the method is mostly for interaction with GUI.
133 string_array GetOptionValues();
134 string_array GetAdvancedOptionValues();
136 * Set option values each in the form "option_name[:option_value][:option_type]".
137 * Note: the method is mostly for interaction with GUI.
139 void SetOptionValues(in string_array options) raises (SALOME::SALOME_Exception);
140 void SetAdvancedOptionValues(in string_array options);
143 void SetSizeMapEntry(in string entry, in double size);
144 void UnsetSizeMapEntry(in string entry);
146 void SetSizeMap(in GEOM::GEOM_Object GeomObj, in double size);
147 void UnsetSizeMap(in GEOM::GEOM_Object GeomObj);
149 HexoticPluginSizeMapsList GetSizeMaps();
151 void SetNbLayers(in long theVal);
154 void SetFirstLayerSize(in double theVal);
155 double GetFirstLayerSize();
157 void SetDirection(in boolean theVal);
158 boolean GetDirection();
160 void SetGrowth(in double theVal);
163 void SetFacesWithLayers(in SMESH::long_array theVal);
164 SMESH::long_array GetFacesWithLayers();
166 void SetImprintedFaces(in SMESH::long_array theVal);
167 SMESH::long_array GetImprintedFaces();