]> SALOME platform Git repositories - modules/smesh.git/blob - idl/SMESH_Gen.idl
Salome HOME
Netgen parametrization
[modules/smesh.git] / idl / SMESH_Gen.idl
1 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
3 // 
4 //  This library is free software; you can redistribute it and/or 
5 //  modify it under the terms of the GNU Lesser General Public 
6 //  License as published by the Free Software Foundation; either 
7 //  version 2.1 of the License. 
8 // 
9 //  This library is distributed in the hope that it will be useful, 
10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of 
11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
12 //  Lesser General Public License for more details. 
13 // 
14 //  You should have received a copy of the GNU Lesser General Public 
15 //  License along with this library; if not, write to the Free Software 
16 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
17 // 
18 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 //
20 //
21 //
22 //  File   : SMESH_Gen.idl
23 //  Author : Paul RASCLE, EDF
24 //  $Header$
25
26 #ifndef _SMESH_GEN_IDL_
27 #define _SMESH_GEN_IDL_
28
29 #include "SALOME_Exception.idl"
30 #include "SALOME_Component.idl"
31 #include "SALOMEDS.idl"
32
33 #include "GEOM_Gen.idl"
34
35 #include "SMESH_Mesh.idl"
36 #include "SMESH_Hypothesis.idl"
37
38 module SMESH
39 {
40   typedef sequence<GEOM::GEOM_Object> object_array;
41   typedef sequence<SMESH_Mesh>        mesh_array;
42
43   interface FilterManager;
44   interface SMESH_Pattern;
45
46   /*!
47    * Tags definition
48    */
49   // Top level
50   const long Tag_HypothesisRoot = 1; // hypotheses root
51   const long Tag_AlgorithmsRoot = 2; // algorithms root
52   const long Tag_FirstMeshRoot  = 3; // first mesh root
53   // Mesh/Submesh
54   const long Tag_RefOnShape             = 1; // references to shape
55   const long Tag_RefOnAppliedHypothesis = 2; // applied hypotheses root
56   const long Tag_RefOnAppliedAlgorithms = 3; // applied algorithms root
57   // Mesh only: sub-meshes roots by type
58   const long Tag_FirstSubMesh           =  4;
59   const long Tag_SubMeshOnVertex        =  4;
60   const long Tag_SubMeshOnEdge          =  5;
61   const long Tag_SubMeshOnWire          =  6;
62   const long Tag_SubMeshOnFace          =  7;
63   const long Tag_SubMeshOnShell         =  8;
64   const long Tag_SubMeshOnSolid         =  9;
65   const long Tag_SubMeshOnCompound      = 10;
66   const long Tag_LastSubMesh            = 10;
67   // Mesh only: group roots by type
68   const long Tag_FirstGroup             = 11;
69   const long Tag_NodeGroups             = 11;
70   const long Tag_EdgeGroups             = 12;
71   const long Tag_FaceGroups             = 13;
72   const long Tag_VolumeGroups           = 14;
73   const long Tag_LastGroup              = 14;
74
75   /*!
76    * Hypothesis definintion error
77    */
78   struct AlgoStateError 
79   {
80     Hypothesis_Status  state;
81     string             algoName;
82     long               algoDim;
83     boolean            isGlobalAlgo;
84   };
85   typedef sequence<AlgoStateError> algo_error_array;
86
87   /*!
88    * Mesh computation error
89    */
90   enum ComputeErrorName
91   {
92     COMPERR_OK            ,
93     COMPERR_BAD_INPUT_MESH,  // wrong mesh on lower submesh
94     COMPERR_STD_EXCEPTION ,  // some std exception raised
95     COMPERR_OCC_EXCEPTION ,  // OCC exception raised
96     COMPERR_SLM_EXCEPTION ,  // SALOME exception raised
97     COMPERR_EXCEPTION     ,  // other exception raised
98     COMPERR_MEMORY_PB     ,  // memory allocation problem
99     COMPERR_ALGO_FAILED   ,  // computation failed
100     COMPERR_BAD_SHAPE        // bad geometry
101   };
102   struct ComputeError
103   {
104     short   code;       // ComputeErrorName or, if negative, algo specific code
105     string  comment;    // textual problem description
106     string  algoName;
107     short   subShapeID; // id of subshape of a shape to mesh
108     boolean hasBadMesh; // there are elements preventing computation available for visualization
109   };
110   typedef sequence<ComputeError> compute_error_array;
111
112
113   interface SMESH_Gen : Engines::Component, SALOMEDS::Driver
114   {
115     //GEOM::GEOM_Gen SetGeomEngine( in string containerLoc );
116     void SetGeomEngine( in GEOM::GEOM_Gen geomcompo );
117
118     FilterManager CreateFilterManager();
119
120     SMESH_Pattern GetPattern();
121
122     /*!
123       Set the current mode
124      */
125     void SetEmbeddedMode( in boolean theMode );
126
127     /*!
128       Get the current mode
129      */
130     boolean IsEmbeddedMode();
131
132     /*!
133       Set the current study
134      */
135     void SetCurrentStudy( in SALOMEDS::Study theStudy );
136
137     /*!
138       Get the current study
139      */
140     SALOMEDS::Study GetCurrentStudy();
141
142     /*!
143      * Create a hypothesis that can be shared by differents parts of the mesh.
144      * An hypothesis is either:
145      * - a method used to generate or modify a part of the mesh (algorithm).
146      * - a parameter or a law used by an algorithm.
147      * Algorithms are 1D, 2D or 3D.
148      */
149     SMESH_Hypothesis CreateHypothesis( in string theHypName,
150                                        in string theLibName )
151       raises ( SALOME::SALOME_Exception );
152
153     /*!
154      * Return a hypothesis holding parameter values corresponding to the mesh
155      * existing on the given geometry.
156      * The returned hypothesis may be the one existing in a study and used
157      * to compute the mesh, or a temporary one created just to pass parameter
158      * values
159      */
160     SMESH_Hypothesis GetHypothesisParameterValues( in string            theHypName,
161                                                    in string            theLibName,
162                                                    in SMESH_Mesh        theMesh,
163                                                    in GEOM::GEOM_Object theGeom)
164       raises ( SALOME::SALOME_Exception );
165
166     /*!
167      * Create a Mesh object, given a geometry shape.
168      * Mesh is created empty (no points, no elements).
169      * Shape is explored via GEOM_Client to create local copies.
170      * of TopoDS_Shapes and bind CORBA references of shape & subshapes
171      * with TopoDS_Shapes
172      */
173     SMESH_Mesh CreateMesh( in GEOM::GEOM_Object theObject )
174       raises ( SALOME::SALOME_Exception );
175     
176     /*!
177      * Create a empty mesh object
178      */
179     SMESH_Mesh CreateEmptyMesh()
180       raises ( SALOME::SALOME_Exception );
181     
182     /*!
183      * Create Mesh object importing data from given UNV file
184      * (UNV supported version is I-DEAS 10)
185      */
186     SMESH_Mesh CreateMeshesFromUNV( in string theFileName )
187       raises ( SALOME::SALOME_Exception );
188
189     /*!
190      * Create Mesh object(s) importing data from given MED file
191      */
192      mesh_array CreateMeshesFromMED( in string theFileName,
193                                      out SMESH::DriverMED_ReadStatus theStatus )
194        raises ( SALOME::SALOME_Exception );
195
196     /*!
197      * Create Mesh object importing data from given STL file
198      */
199     SMESH_Mesh CreateMeshesFromSTL( in string theFileName )
200       raises ( SALOME::SALOME_Exception );
201
202     /*!
203      * Create a Mesh object, without a geometry shape reference
204      */
205 //      SMESH_Mesh NewEmpty()
206 //        raises ( SALOME::SALOME_Exception );
207
208     /*!
209      * Mesh a subShape. 
210      * First, verify list of hypothesis associated with the subShape,
211      * return NOK if hypothesis are not sufficient
212      */
213     boolean Compute( in SMESH_Mesh        theMesh, 
214                      in GEOM::GEOM_Object theSubObject )
215       raises ( SALOME::SALOME_Exception );
216
217     /*!
218      * Return true if hypotheses are defined well
219      */
220     boolean IsReadyToCompute( in SMESH_Mesh        theMesh, 
221                               in GEOM::GEOM_Object theSubObject )
222       raises ( SALOME::SALOME_Exception );
223
224     /*!
225      * Return errors of hypotheses definintion
226      * algo_error_array is empty if everything is OK
227      */
228     algo_error_array GetAlgoState( in SMESH_Mesh        theMesh, 
229                                    in GEOM::GEOM_Object theSubObject )
230       raises ( SALOME::SALOME_Exception );
231
232     /*!
233      * Return errors of mesh computation
234      * compute_error_array is empty if everything is OK
235      */
236     compute_error_array GetComputeErrors( in SMESH_Mesh        theMesh, 
237                                           in GEOM::GEOM_Object theSubObject )
238       raises ( SALOME::SALOME_Exception );
239
240     /*!
241      * Return mesh elements preventing computation of a subshape
242      */
243     MeshPreviewStruct GetBadInputElements( in SMESH_Mesh theMesh,
244                                            in short      theSubShapeID )
245       raises ( SALOME::SALOME_Exception );
246
247     /*!
248      * Return indeces of faces, edges and vertices of given subshapes
249      * within theMainObject
250      */
251     long_array GetSubShapesId( in GEOM::GEOM_Object theMainObject,
252                                in object_array      theListOfSubObjects )
253        raises ( SALOME::SALOME_Exception );
254
255     /*!
256      * Return geometrical object the given element is built on.
257      * The returned geometrical object, if not nil, is either found in the 
258      * study or is published by this method with the given name
259      */
260     GEOM::GEOM_Object GetGeometryByMeshElement( in SMESH_Mesh  theMesh,
261                                                 in long        theElementID,
262                                                 in string      theGeomName)
263       raises ( SALOME::SALOME_Exception );
264
265     /*!
266      * Return geometrical object the given element is built on.
267      * The returned geometrical object not published in study by this method.
268      */
269     GEOM::GEOM_Object FindGeometryByMeshElement( in SMESH_Mesh  theMesh,
270                                                  in long        theElementID)
271       raises ( SALOME::SALOME_Exception );
272
273     /*!
274      * Concatenate the given meshes into one mesh.
275      * Union groups with the same name and type if
276      * theUniteIdenticalGroups flag is true.
277      * Merge coincident nodes and elements if 
278      * theMergeNodesAndElements flag is true.
279      */
280     SMESH_Mesh Concatenate(in mesh_array theMeshesArray, 
281                            in boolean    theUniteIdenticalGroups, 
282                            in boolean    theMergeNodesAndElements, 
283                            in double     theMergeTolerance)
284       raises ( SALOME::SALOME_Exception );
285
286     /*!
287      * Concatenate the given meshes into one mesh.
288      * Union groups with the same name and type if
289      * theUniteIdenticalGroups flag is true.
290      * Merge coincident nodes and elements if 
291      * theMergeNodesAndElements flag is true.
292      * Create the groups of all elements from initial meshes.
293      */
294     SMESH_Mesh ConcatenateWithGroups(in mesh_array theMeshesArray, 
295                                      in boolean    theUniteIdenticalGroups, 
296                                      in boolean    theMergeNodesAndElements, 
297                                      in double     theMergeTolerance)
298       raises ( SALOME::SALOME_Exception );
299
300     /*!
301      * \brief Return id of object, registered in current study context
302      *
303      * Can be used to check if the object was created in the same container, as this engine.
304      */
305     long GetObjectId(in Object theObject);
306   };
307
308 };
309
310 #endif