1 // Copyright (C) 2003 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : SMESH_Gen.idl
23 // Author : Paul RASCLE, EDF
26 #ifndef _SMESH_GEN_IDL_
27 #define _SMESH_GEN_IDL_
29 #include "SALOME_Exception.idl"
30 #include "SALOME_Component.idl"
31 #include "SALOMEDS.idl"
33 #include "GEOM_Gen.idl"
35 #include "SMESH_Mesh.idl"
36 #include "SMESH_Hypothesis.idl"
40 typedef sequence<GEOM::GEOM_Object> object_array;
41 typedef sequence<SMESH_Mesh> mesh_array;
43 interface FilterManager;
44 interface SMESH_Pattern;
47 * Hypothesis definintion error
51 Hypothesis_Status state;
56 typedef sequence<AlgoStateError> algo_error_array;
59 * Mesh computation error
64 COMPERR_BAD_INPUT_MESH, // wrong mesh on lower submesh
65 COMPERR_STD_EXCEPTION , // some std exception raised
66 COMPERR_OCC_EXCEPTION , // OCC exception raised
67 COMPERR_SLM_EXCEPTION , // SALOME exception raised
68 COMPERR_EXCEPTION , // other exception raised
69 COMPERR_MEMORY_PB , // memory allocation problem
70 COMPERR_ALGO_FAILED , // computation failed
71 COMPERR_BAD_SHAPE // bad geometry
75 short code; // ComputeErrorName or, if negative, algo specific code
76 string comment; // textual problem description
78 short subShapeID; // id of subshape of a shape to mesh
80 typedef sequence<ComputeError> compute_error_array;
83 interface SMESH_Gen : Engines::Component, SALOMEDS::Driver
85 //GEOM::GEOM_Gen SetGeomEngine( in string containerLoc );
86 void SetGeomEngine( in GEOM::GEOM_Gen geomcompo );
88 FilterManager CreateFilterManager();
90 SMESH_Pattern GetPattern();
95 void SetEmbeddedMode( in boolean theMode );
100 boolean IsEmbeddedMode();
103 Set the current study
105 void SetCurrentStudy( in SALOMEDS::Study theStudy );
108 Get the current study
110 SALOMEDS::Study GetCurrentStudy();
113 * Create a hypothesis that can be shared by differents parts of the mesh.
114 * An hypothesis is either:
115 * - a method used to generate or modify a part of the mesh (algorithm).
116 * - a parameter or a law used by an algorithm.
117 * Algorithms are 1D, 2D or 3D.
119 SMESH_Hypothesis CreateHypothesis( in string theHypName,
120 in string theLibName )
121 raises ( SALOME::SALOME_Exception );
124 * Return a hypothesis holding parameter values corresponding to the mesh
125 * existing on the given geometry.
126 * The returned hypothesis may be the one existing in a study and used
127 * to compute the mesh, or a temporary one created just to pass parameter
130 SMESH_Hypothesis GetHypothesisParameterValues( in string theHypName,
131 in string theLibName,
132 in SMESH_Mesh theMesh,
133 in GEOM::GEOM_Object theGeom)
134 raises ( SALOME::SALOME_Exception );
137 * Create a Mesh object, given a geometry shape.
138 * Mesh is created empty (no points, no elements).
139 * Shape is explored via GEOM_Client to create local copies.
140 * of TopoDS_Shapes and bind CORBA references of shape & subshapes
143 SMESH_Mesh CreateMesh( in GEOM::GEOM_Object theObject )
144 raises ( SALOME::SALOME_Exception );
147 * Create a empty mesh object
149 SMESH_Mesh CreateEmptyMesh()
150 raises ( SALOME::SALOME_Exception );
153 * Create Mesh object importing data from given UNV file
154 * (UNV supported version is I-DEAS 10)
156 SMESH_Mesh CreateMeshesFromUNV( in string theFileName )
157 raises ( SALOME::SALOME_Exception );
160 * Create Mesh object(s) importing data from given MED file
162 mesh_array CreateMeshesFromMED( in string theFileName,
163 out SMESH::DriverMED_ReadStatus theStatus )
164 raises ( SALOME::SALOME_Exception );
167 * Create Mesh object importing data from given STL file
169 SMESH_Mesh CreateMeshesFromSTL( in string theFileName )
170 raises ( SALOME::SALOME_Exception );
173 * Create a Mesh object, without a geometry shape reference
175 // SMESH_Mesh NewEmpty()
176 // raises ( SALOME::SALOME_Exception );
180 * First, verify list of hypothesis associated with the subShape,
181 * return NOK if hypothesis are not sufficient
183 boolean Compute( in SMESH_Mesh theMesh,
184 in GEOM::GEOM_Object theSubObject )
185 raises ( SALOME::SALOME_Exception );
188 * Return true if hypotheses are defined well
190 boolean IsReadyToCompute( in SMESH_Mesh theMesh,
191 in GEOM::GEOM_Object theSubObject )
192 raises ( SALOME::SALOME_Exception );
195 * Return errors of hypotheses definintion
196 * algo_error_array is empty if everything is OK
198 algo_error_array GetAlgoState( in SMESH_Mesh theMesh,
199 in GEOM::GEOM_Object theSubObject )
200 raises ( SALOME::SALOME_Exception );
203 * Return errors of mesh computation
204 * compute_error_array is empty if everything is OK
206 compute_error_array GetComputeErrors( in SMESH_Mesh theMesh,
207 in GEOM::GEOM_Object theSubObject )
208 raises ( SALOME::SALOME_Exception );
211 * Return indeces of faces, edges and vertices of given subshapes
212 * within theMainObject
214 long_array GetSubShapesId( in GEOM::GEOM_Object theMainObject,
215 in object_array theListOfSubObjects )
216 raises ( SALOME::SALOME_Exception );
219 * Return geometrical object the given element is built on.
220 * The returned geometrical object, if not nil, is either found in the
221 * study or is published by this method with the given name
223 GEOM::GEOM_Object GetGeometryByMeshElement( in SMESH_Mesh theMesh,
224 in long theElementID,
225 in string theGeomName)
226 raises ( SALOME::SALOME_Exception );
229 * Return geometrical object the given element is built on.
230 * The returned geometrical object not published in study by this method.
232 GEOM::GEOM_Object FindGeometryByMeshElement( in SMESH_Mesh theMesh,
233 in long theElementID)
234 raises ( SALOME::SALOME_Exception );
237 * Concatenate the given meshes into one mesh.
238 * Union groups with the same name and type if
239 * theUniteIdenticalGroups flag is true.
240 * Merge coincident nodes and elements if
241 * theMergeNodesAndElements flag is true.
243 SMESH_Mesh Concatenate(in mesh_array theMeshesArray,
244 in boolean theUniteIdenticalGroups,
245 in boolean theMergeNodesAndElements,
246 in double theMergeTolerance)
247 raises ( SALOME::SALOME_Exception );