idl/SMESH_Gen.idl

   1 // Copyright (C) 2007-2011  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.
  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 //  File   : SMESH_Gen.idl
  23 //  Author : Paul RASCLE, EDF
  24
  25 #ifndef _SMESH_GEN_IDL_
  26 #define _SMESH_GEN_IDL_
  27
  28 #include "SALOME_Exception.idl"
  29 #include "SALOME_Component.idl"
  30 #include "SALOMEDS.idl"
  31
  32 #include "GEOM_Gen.idl"
  33
  34 #include "SMESH_Mesh.idl"
  35 #include "SMESH_Hypothesis.idl"
  36
  37 module SMESH
  38 {
  39   typedef sequence<GEOM::GEOM_Object> object_array;
  40   typedef sequence<SMESH_Mesh>        mesh_array;
  41
  42   interface FilterManager;
  43   interface SMESH_Pattern;
  44   interface Measurements;
  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::EngineComponent, 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     Measurements  CreateMeasurements();
 123
 124     /*!
 125       Set the current mode
 126      */
 127     void SetEmbeddedMode( in boolean theMode );
 128
 129     /*!
 130       Get the current mode
 131      */
 132     boolean IsEmbeddedMode();
 133
 134     /*!
 135       Set the current study
 136      */
 137     void SetCurrentStudy( in SALOMEDS::Study theStudy );
 138
 139     /*!
 140       Get the current study
 141      */
 142     SALOMEDS::Study GetCurrentStudy();
 143
 144     /*!
 145      * Create a hypothesis that can be shared by differents parts of the mesh.
 146      * An hypothesis is either:
 147      * - a method used to generate or modify a part of the mesh (algorithm).
 148      * - a parameter or a law used by an algorithm.
 149      * Algorithms are 1D, 2D or 3D.
 150      */
 151     SMESH_Hypothesis CreateHypothesis( in string theHypName,
 152                                        in string theLibName )
 153       raises ( SALOME::SALOME_Exception );
 154
 155     /*!
 156      * Return a hypothesis holding parameter values corresponding either to the mesh
 157      * existing on the given geometry or to size of the geometry.
 158      * The returned hypothesis may be the one existing in a study and used
 159      * to compute the mesh, or a temporary one created just to pass parameter
 160      * values.
 161      */
 162     SMESH_Hypothesis GetHypothesisParameterValues( in string            theHypName,
 163                                                    in string            theLibName,
 164                                                    in SMESH_Mesh        theMesh,
 165                                                    in GEOM::GEOM_Object theGeom,
 166                                                    in boolean           byMesh)
 167       raises ( SALOME::SALOME_Exception );
 168
 169     /*!
 170      * Sets number of segments per diagonal of boundary box of geometry by which
 171      * default segment length of appropriate 1D hypotheses is defined
 172      */
 173     void SetBoundaryBoxSegmentation( in long theNbSegments ) raises ( SALOME::SALOME_Exception );
 174     /*!
 175      * \brief Sets default number of segments per edge
 176      */
 177     void SetDefaultNbSegments( in long theNbSegments) raises ( SALOME::SALOME_Exception );
 178
 179     /*!
 180      * Set the object name
 181      */
 182     void SetName( in string theObjectIOR,
 183                   in string theObjectName )
 184       raises ( SALOME::SALOME_Exception );
 185
 186     /*!
 187      * Create a Mesh object, given a geometry shape.
 188      * Mesh is created empty (no points, no elements).
 189      * Shape is explored via GEOM_Client to create local copies.
 190      * of TopoDS_Shapes and bind CORBA references of shape & subshapes
 191      * with TopoDS_Shapes
 192      */
 193     SMESH_Mesh CreateMesh( in GEOM::GEOM_Object theObject )
 194       raises ( SALOME::SALOME_Exception );
 195
 196     /*!
 197      * Create an empty mesh object
 198      */
 199     SMESH_Mesh CreateEmptyMesh()
 200       raises ( SALOME::SALOME_Exception );
 201
 202     /*!
 203      * Create Mesh object importing data from given UNV file
 204      * (UNV supported version is I-DEAS 10)
 205      */
 206     SMESH_Mesh CreateMeshesFromUNV( in string theFileName )
 207       raises ( SALOME::SALOME_Exception );
 208
 209     /*!
 210      * Create Mesh object(s) importing data from given MED file
 211      */
 212      mesh_array CreateMeshesFromMED( in string theFileName,
 213                                      out SMESH::DriverMED_ReadStatus theStatus )
 214        raises ( SALOME::SALOME_Exception );
 215
 216     /*!
 217      * Create Mesh object importing data from given STL file
 218      */
 219     SMESH_Mesh CreateMeshesFromSTL( in string theFileName )
 220       raises ( SALOME::SALOME_Exception );
 221
 222     /*!
 223      * Create a mesh by copying a part of another mesh
 224      *  \param meshPart - a part of mesh to copy
 225      *  \param meshName - a name of the new mesh
 226      *  \param toCopyGroups - to create in the new mesh groups
 227      *                        the copied elements belongs to
 228      *  \param toKeepIDs - to preserve IDs of the copied elements or not
 229      */
 230     SMESH_Mesh CopyMesh(in SMESH_IDSource meshPart,
 231                         in string         meshName,
 232                         in boolean        toCopyGroups,
 233                         in boolean        toKeepIDs)
 234       raises ( SALOME::SALOME_Exception );
 235
 236     /*!
 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.
 242      */
 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 );
 248
 249     /*!
 250      * Concatenate the given meshes into one mesh.
 251      * Union groups with the same name and type if
 252      * theUniteIdenticalGroups flag is true.
 253      * Merge coincident nodes and elements if
 254      * theMergeNodesAndElements flag is true.
 255      * Create the groups of all elements from initial meshes.
 256      */
 257     SMESH_Mesh ConcatenateWithGroups(in mesh_array theMeshesArray,
 258                                      in boolean    theUniteIdenticalGroups,
 259                                      in boolean    theMergeNodesAndElements,
 260                                      in double     theMergeTolerance)
 261       raises ( SALOME::SALOME_Exception );
 262
 263     /*!
 264      * Mesh a subShape.
 265      * First, verify list of hypothesis associated with the subShape,
 266      * return NOK if hypothesis are not sufficient
 267      */
 268     boolean Compute( in SMESH_Mesh        theMesh,
 269                      in GEOM::GEOM_Object theSubObject )
 270       raises ( SALOME::SALOME_Exception );
 271
 272     /*!
 273      * Cancel a computation.
 274      */
 275     void CancelCompute( in SMESH_Mesh        theMesh,
 276                         in GEOM::GEOM_Object theSubObject );
 277
 278     /*!
 279      * Return true if hypotheses are defined well
 280      */
 281     boolean IsReadyToCompute( in SMESH_Mesh        theMesh,
 282                               in GEOM::GEOM_Object theSubObject )
 283       raises ( SALOME::SALOME_Exception );
 284
 285     /*!
 286      * Evaluates size of prospective mesh on a shape
 287      */
 288     long_array  Evaluate(in SMESH_Mesh        theMesh,
 289                          in GEOM::GEOM_Object theSubObject)
 290       raises ( SALOME::SALOME_Exception );
 291
 292     /*!
 293      * Calculate Mesh as preview till indicated dimension
 294      * First, verify list of hypothesis associated with the subShape.
 295      * Return mesh preview structure
 296      */
 297     MeshPreviewStruct Precompute( in SMESH_Mesh        theMesh,
 298                                   in GEOM::GEOM_Object theSubObject,
 299                                   in Dimension         theDimension,
 300                                   inout long_array    theShapesId )
 301       raises ( SALOME::SALOME_Exception );
 302
 303     /*!
 304      * Return errors of hypotheses definintion
 305      * algo_error_array is empty if everything is OK
 306      */
 307     algo_error_array GetAlgoState( in SMESH_Mesh        theMesh,
 308                                    in GEOM::GEOM_Object theSubObject )
 309       raises ( SALOME::SALOME_Exception );
 310
 311     /*!
 312      * Return errors of mesh computation
 313      * compute_error_array is empty if everything is OK
 314      */
 315     compute_error_array GetComputeErrors( in SMESH_Mesh        theMesh,
 316                                           in GEOM::GEOM_Object theSubObject )
 317       raises ( SALOME::SALOME_Exception );
 318
 319     /*!
 320      * Return mesh elements preventing computation of a subshape
 321      */
 322     MeshPreviewStruct GetBadInputElements( in SMESH_Mesh theMesh,
 323                                            in short      theSubShapeID )
 324       raises ( SALOME::SALOME_Exception );
 325
 326     /*!
 327      * Return indeces of faces, edges and vertices of given subshapes
 328      * within theMainObject
 329      */
 330     long_array GetSubShapesId( in GEOM::GEOM_Object theMainObject,
 331                                in object_array      theListOfSubObjects )
 332        raises ( SALOME::SALOME_Exception );
 333
 334     /*!
 335      * Return geometrical object the given element is built on.
 336      * The returned geometrical object, if not nil, is either found in the
 337      * study or is published by this method with the given name
 338      */
 339     GEOM::GEOM_Object GetGeometryByMeshElement( in SMESH_Mesh  theMesh,
 340                                                 in long        theElementID,
 341                                                 in string      theGeomName)
 342       raises ( SALOME::SALOME_Exception );
 343
 344     /*!
 345      * Return geometrical object the given element is built on.
 346      * The returned geometrical object not published in study by this method.
 347      */
 348     GEOM::GEOM_Object FindGeometryByMeshElement( in SMESH_Mesh  theMesh,
 349                                                  in long        theElementID)
 350       raises ( SALOME::SALOME_Exception );
 351
 352     /*!
 353      * \brief Return id of object, registered in current study context
 354      *
 355      * Can be used to check if the object was created in the same container, as this engine.
 356      */
 357     long GetObjectId(in Object theObject);
 358
 359     /*!
 360      * \brief Get MED version of the file by its name.
 361      */
 362     boolean GetMEDVersion(in string theFileName, out MED_VERSION theVersion);
 363
 364     /*!
 365      * \brief Get names of meshes defined in file with the specified name.
 366      */
 367     string_array GetMeshNames(in string theFileName);
 368   };
 369
 370 };
 371
 372 #endif