idl/SMESH_Gen.idl

   1 //  Copyright (C) 2007-2008  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
  45   /*!
  46    * Tags definition
  47    */
  48   // Top level
  49   const long Tag_HypothesisRoot = 1; // hypotheses root
  50   const long Tag_AlgorithmsRoot = 2; // algorithms root
  51   const long Tag_FirstMeshRoot  = 3; // first mesh root
  52   // Mesh/Submesh
  53   const long Tag_RefOnShape             = 1; // references to shape
  54   const long Tag_RefOnAppliedHypothesis = 2; // applied hypotheses root
  55   const long Tag_RefOnAppliedAlgorithms = 3; // applied algorithms root
  56   // Mesh only: sub-meshes roots by type
  57   const long Tag_FirstSubMesh           =  4;
  58   const long Tag_SubMeshOnVertex        =  4;
  59   const long Tag_SubMeshOnEdge          =  5;
  60   const long Tag_SubMeshOnWire          =  6;
  61   const long Tag_SubMeshOnFace          =  7;
  62   const long Tag_SubMeshOnShell         =  8;
  63   const long Tag_SubMeshOnSolid         =  9;
  64   const long Tag_SubMeshOnCompound      = 10;
  65   const long Tag_LastSubMesh            = 10;
  66   // Mesh only: group roots by type
  67   const long Tag_FirstGroup             = 11;
  68   const long Tag_NodeGroups             = 11;
  69   const long Tag_EdgeGroups             = 12;
  70   const long Tag_FaceGroups             = 13;
  71   const long Tag_VolumeGroups           = 14;
  72   const long Tag_LastGroup              = 14;
  73
  74   /*!
  75    * Hypothesis definintion error
  76    */
  77   struct AlgoStateError
  78   {
  79     Hypothesis_Status  state;
  80     string             algoName;
  81     long               algoDim;
  82     boolean            isGlobalAlgo;
  83   };
  84   typedef sequence<AlgoStateError> algo_error_array;
  85
  86   /*!
  87    * Mesh computation error
  88    */
  89   enum ComputeErrorName
  90   {
  91     COMPERR_OK            ,
  92     COMPERR_BAD_INPUT_MESH,  // wrong mesh on lower submesh
  93     COMPERR_STD_EXCEPTION ,  // some std exception raised
  94     COMPERR_OCC_EXCEPTION ,  // OCC exception raised
  95     COMPERR_SLM_EXCEPTION ,  // SALOME exception raised
  96     COMPERR_EXCEPTION     ,  // other exception raised
  97     COMPERR_MEMORY_PB     ,  // memory allocation problem
  98     COMPERR_ALGO_FAILED   ,  // computation failed
  99     COMPERR_BAD_SHAPE        // bad geometry
 100   };
 101   struct ComputeError
 102   {
 103     short   code;       // ComputeErrorName or, if negative, algo specific code
 104     string  comment;    // textual problem description
 105     string  algoName;
 106     short   subShapeID; // id of subshape of a shape to mesh
 107     boolean hasBadMesh; // there are elements preventing computation available for visualization
 108   };
 109   typedef sequence<ComputeError> compute_error_array;
 110
 111
 112   interface SMESH_Gen : Engines::Component, SALOMEDS::Driver
 113   {
 114     //GEOM::GEOM_Gen SetGeomEngine( in string containerLoc );
 115     void SetGeomEngine( in GEOM::GEOM_Gen geomcompo );
 116
 117     FilterManager CreateFilterManager();
 118
 119     SMESH_Pattern GetPattern();
 120
 121     /*!
 122       Set the current mode
 123      */
 124     void SetEmbeddedMode( in boolean theMode );
 125
 126     /*!
 127       Get the current mode
 128      */
 129     boolean IsEmbeddedMode();
 130
 131     /*!
 132       Set the current study
 133      */
 134     void SetCurrentStudy( in SALOMEDS::Study theStudy );
 135
 136     /*!
 137       Get the current study
 138      */
 139     SALOMEDS::Study GetCurrentStudy();
 140
 141     /*!
 142      * Create a hypothesis that can be shared by differents parts of the mesh.
 143      * An hypothesis is either:
 144      * - a method used to generate or modify a part of the mesh (algorithm).
 145      * - a parameter or a law used by an algorithm.
 146      * Algorithms are 1D, 2D or 3D.
 147      */
 148     SMESH_Hypothesis CreateHypothesis( in string theHypName,
 149                                        in string theLibName )
 150       raises ( SALOME::SALOME_Exception );
 151
 152     /*!
 153      * Return a hypothesis holding parameter values corresponding either to the mesh
 154      * existing on the given geometry or to size of the geometry.
 155      * The returned hypothesis may be the one existing in a study and used
 156      * to compute the mesh, or a temporary one created just to pass parameter
 157      * values.
 158      */
 159     SMESH_Hypothesis GetHypothesisParameterValues( in string            theHypName,
 160                                                    in string            theLibName,
 161                                                    in SMESH_Mesh        theMesh,
 162                                                    in GEOM::GEOM_Object theGeom,
 163                                                    in boolean           byMesh)
 164       raises ( SALOME::SALOME_Exception );
 165
 166     /*!
 167      * Sets number of segments per diagonal of boundary box of geometry by which
 168      * default segment length of appropriate 1D hypotheses is defined
 169      */
 170     void SetBoundaryBoxSegmentation( in long theNbSegments );
 171
 172     /*!
 173      * Set the object name
 174      */
 175     void SetName( in string theObjectIOR,
 176                   in string theObjectName )
 177       raises ( SALOME::SALOME_Exception );
 178
 179     /*!
 180      * Create a Mesh object, given a geometry shape.
 181      * Mesh is created empty (no points, no elements).
 182      * Shape is explored via GEOM_Client to create local copies.
 183      * of TopoDS_Shapes and bind CORBA references of shape & subshapes
 184      * with TopoDS_Shapes
 185      */
 186     SMESH_Mesh CreateMesh( in GEOM::GEOM_Object theObject )
 187       raises ( SALOME::SALOME_Exception );
 188
 189     /*!
 190      * Create an empty mesh object
 191      */
 192     SMESH_Mesh CreateEmptyMesh()
 193       raises ( SALOME::SALOME_Exception );
 194
 195     /*!
 196      * Create Mesh object importing data from given UNV file
 197      * (UNV supported version is I-DEAS 10)
 198      */
 199     SMESH_Mesh CreateMeshesFromUNV( in string theFileName )
 200       raises ( SALOME::SALOME_Exception );
 201
 202     /*!
 203      * Create Mesh object(s) importing data from given MED file
 204      */
 205      mesh_array CreateMeshesFromMED( in string theFileName,
 206                                      out SMESH::DriverMED_ReadStatus theStatus )
 207        raises ( SALOME::SALOME_Exception );
 208
 209     /*!
 210      * Create Mesh object importing data from given STL file
 211      */
 212     SMESH_Mesh CreateMeshesFromSTL( in string theFileName )
 213       raises ( SALOME::SALOME_Exception );
 214
 215     /*!
 216      * Create a Mesh object, without a geometry shape reference
 217      */
 218 //      SMESH_Mesh NewEmpty()
 219 //        raises ( SALOME::SALOME_Exception );
 220
 221     /*!
 222      * Mesh a subShape.
 223      * First, verify list of hypothesis associated with the subShape,
 224      * return NOK if hypothesis are not sufficient
 225      */
 226     boolean Compute( in SMESH_Mesh        theMesh,
 227                      in GEOM::GEOM_Object theSubObject )
 228       raises ( SALOME::SALOME_Exception );
 229
 230     /*!
 231      * Return true if hypotheses are defined well
 232      */
 233     boolean IsReadyToCompute( in SMESH_Mesh        theMesh,
 234                               in GEOM::GEOM_Object theSubObject )
 235       raises ( SALOME::SALOME_Exception );
 236
 237     /*!
 238      * Calculate Mesh as preview till indicated dimension
 239      * First, verify list of hypothesis associated with the subShape.
 240      * Return mesh preview structure
 241      */
 242     MeshPreviewStruct Precompute( in SMESH_Mesh        theMesh,
 243                                   in GEOM::GEOM_Object theSubObject,
 244                                   in Dimension         theDimension,
 245                                   inout long_array    theShapesId )
 246       raises ( SALOME::SALOME_Exception );
 247
 248     /*!
 249      * Return errors of hypotheses definintion
 250      * algo_error_array is empty if everything is OK
 251      */
 252     algo_error_array GetAlgoState( in SMESH_Mesh        theMesh,
 253                                    in GEOM::GEOM_Object theSubObject )
 254       raises ( SALOME::SALOME_Exception );
 255
 256     /*!
 257      * Return errors of mesh computation
 258      * compute_error_array is empty if everything is OK
 259      */
 260     compute_error_array GetComputeErrors( in SMESH_Mesh        theMesh,
 261                                           in GEOM::GEOM_Object theSubObject )
 262       raises ( SALOME::SALOME_Exception );
 263
 264     /*!
 265      * Return mesh elements preventing computation of a subshape
 266      */
 267     MeshPreviewStruct GetBadInputElements( in SMESH_Mesh theMesh,
 268                                            in short      theSubShapeID )
 269       raises ( SALOME::SALOME_Exception );
 270
 271     /*!
 272      * Return indeces of faces, edges and vertices of given subshapes
 273      * within theMainObject
 274      */
 275     long_array GetSubShapesId( in GEOM::GEOM_Object theMainObject,
 276                                in object_array      theListOfSubObjects )
 277        raises ( SALOME::SALOME_Exception );
 278
 279     /*!
 280      * Return geometrical object the given element is built on.
 281      * The returned geometrical object, if not nil, is either found in the
 282      * study or is published by this method with the given name
 283      */
 284     GEOM::GEOM_Object GetGeometryByMeshElement( in SMESH_Mesh  theMesh,
 285                                                 in long        theElementID,
 286                                                 in string      theGeomName)
 287       raises ( SALOME::SALOME_Exception );
 288
 289     /*!
 290      * Return geometrical object the given element is built on.
 291      * The returned geometrical object not published in study by this method.
 292      */
 293     GEOM::GEOM_Object FindGeometryByMeshElement( in SMESH_Mesh  theMesh,
 294                                                  in long        theElementID)
 295       raises ( SALOME::SALOME_Exception );
 296
 297     /*!
 298      * Concatenate the given meshes into one mesh.
 299      * Union groups with the same name and type if
 300      * theUniteIdenticalGroups flag is true.
 301      * Merge coincident nodes and elements if
 302      * theMergeNodesAndElements flag is true.
 303      */
 304     SMESH_Mesh Concatenate(in mesh_array theMeshesArray,
 305                            in boolean    theUniteIdenticalGroups,
 306                            in boolean    theMergeNodesAndElements,
 307                            in double     theMergeTolerance)
 308       raises ( SALOME::SALOME_Exception );
 309
 310     /*!
 311      * Concatenate the given meshes into one mesh.
 312      * Union groups with the same name and type if
 313      * theUniteIdenticalGroups flag is true.
 314      * Merge coincident nodes and elements if
 315      * theMergeNodesAndElements flag is true.
 316      * Create the groups of all elements from initial meshes.
 317      */
 318     SMESH_Mesh ConcatenateWithGroups(in mesh_array theMeshesArray,
 319                                      in boolean    theUniteIdenticalGroups,
 320                                      in boolean    theMergeNodesAndElements,
 321                                      in double     theMergeTolerance)
 322       raises ( SALOME::SALOME_Exception );
 323
 324     /*!
 325      * \brief Return id of object, registered in current study context
 326      *
 327      * Can be used to check if the object was created in the same container, as this engine.
 328      */
 329     long GetObjectId(in Object theObject);
 330   };
 331
 332 };
 333
 334 #endif