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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  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 #include "GEOM_Shape.idl"
  35
  36 #include "SMESH_Mesh.idl"
  37 #include "SMESH_Hypothesis.idl"
  38
  39 module SMESH
  40 {
  41   typedef sequence<GEOM::GEOM_Shape> shape_array;
  42   typedef sequence<SMESH_Mesh> mesh_array;
  43
  44   interface FilterManager;
  45
  46   interface SMESH_Gen : Engines::Component, SALOMEDS::Driver
  47   {
  48
  49     FilterManager CreateFilterManager();
  50
  51     /*!
  52       Set the current study
  53      */
  54     void SetCurrentStudy( in SALOMEDS::Study theStudy );
  55
  56     /*!
  57       Get the current study
  58      */
  59     SALOMEDS::Study GetCurrentStudy();
  60
  61     /*!
  62      * Create a hypothesis that can be shared by differents parts of the mesh.
  63      * An hypothesis is either:
  64      * - a method used to generate or modify a part of the mesh (algorithm).
  65      * - a parameter or a law used by an algorithm.
  66      * Algorithms are 1D, 2D or 3D.
  67      */
  68     SMESH_Hypothesis CreateHypothesis( in string theHypName,
  69                                        in string theLibName )
  70       raises ( SALOME::SALOME_Exception );
  71
  72     /*!
  73      * Create a Mesh object, given a geometry shape.
  74      * Mesh is created empty (no points, no elements).
  75      * Shape is explored via GEOM_Client to create local copies.
  76      * of TopoDS_Shapes and bind CORBA references of shape & subshapes
  77      * with TopoDS_Shapes
  78      */
  79     SMESH_Mesh CreateMesh( in GEOM::GEOM_Shape theShape )
  80       raises ( SALOME::SALOME_Exception );
  81
  82     /*!
  83      * Create Mesh object(s) importing data from given MED file
  84      */
  85      mesh_array CreateMeshesFromMED( in string theFileName,
  86                                      out SMESH::DriverMED_ReadStatus theStatus )
  87        raises ( SALOME::SALOME_Exception );
  88
  89     /*!
  90      * Create a Mesh object, without a geometry shape reference
  91      */
  92 //      SMESH_Mesh NewEmpty()
  93 //        raises ( SALOME::SALOME_Exception );
  94
  95     /*!
  96      * Mesh a subShape.
  97      * First, verify list of hypothesis associated with the subShape,
  98      * return NOK if hypothesis are not sufficient
  99      */
 100     boolean Compute( in SMESH_Mesh       theMesh,
 101                      in GEOM::GEOM_Shape theSubShape )
 102       raises ( SALOME::SALOME_Exception );
 103
 104     /*!
 105      *
 106      */
 107
 108     boolean IsReadyToCompute( in SMESH_Mesh       theMesh,
 109                               in GEOM::GEOM_Shape theSubShape )
 110       raises ( SALOME::SALOME_Exception );
 111
 112     /*!
 113      *
 114      */
 115     long_array GetSubShapesId( in GEOM::GEOM_Shape theMainShape,
 116                                in shape_array      theListOfSubShape )
 117        raises ( SALOME::SALOME_Exception );
 118
 119     /*!
 120      *
 121      */
 122     //    long_array GetSubMeshesState( in shape_array theListOfSubShape )
 123     //  raises ( SALOME::SALOME_Exception );
 124
 125
 126   };
 127
 128 };
 129
 130 #endif