idl/SMESH_Gen.idl

Go to the documentation of this file.

//  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
// 
//  This library is free software; you can redistribute it and/or 
//  modify it under the terms of the GNU Lesser General Public 
//  License as published by the Free Software Foundation; either 
//  version 2.1 of the License. 
// 
//  This library is distributed in the hope that it will be useful, 
//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
//  Lesser General Public License for more details. 
// 
//  You should have received a copy of the GNU Lesser General Public 
//  License along with this library; if not, write to the Free Software 
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
// 
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
//
//
//  File   : SMESH_Gen.idl
//  Author : Paul RASCLE, EDF
//  $Header: /home/server/cvs/SMESH/SMESH_SRC/idl/SMESH_Gen.idl,v 1.12.2.6 2007/04/10 13:55:23 eap Exp $

#ifndef _SMESH_GEN_IDL_
#define _SMESH_GEN_IDL_

#include "SALOME_Exception.idl"
#include "SALOME_Component.idl"
#include "SALOMEDS.idl"

#include "GEOM_Gen.idl"

#include "SMESH_Mesh.idl"
#include "SMESH_Hypothesis.idl"

module SMESH
{
  typedef sequence<GEOM::GEOM_Object> object_array;
  typedef sequence<SMESH_Mesh>        mesh_array;

  interface FilterManager;
  interface SMESH_Pattern;

  struct AlgoStateError 
  {
    Hypothesis_Status  state;
    string             algoName;
    long               algoDim;
    boolean            isGlobalAlgo;
  };
  typedef sequence<AlgoStateError> algo_error_array;

  enum ComputeErrorName
  {
    COMPERR_OK            ,
    COMPERR_BAD_INPUT_MESH,  // wrong mesh on lower submesh
    COMPERR_STD_EXCEPTION ,  // some std exception raised
    COMPERR_OCC_EXCEPTION ,  // OCC exception raised
    COMPERR_SLM_EXCEPTION ,  // SALOME exception raised
    COMPERR_EXCEPTION     ,  // other exception raised
    COMPERR_MEMORY_PB     ,  // memory allocation problem
    COMPERR_ALGO_FAILED   ,  // computation failed
    COMPERR_BAD_SHAPE        // bad geometry
  };
  struct ComputeError
  {
    short  code;       // ComputeErrorName or, if negative, algo specific code
    string comment;    // textual problem description
    string algoName;
    short  subShapeID; // id of subshape of a shape to mesh
  };
  typedef sequence<ComputeError> compute_error_array;


  interface SMESH_Gen : Engines::Component, SALOMEDS::Driver
  {

    FilterManager CreateFilterManager();

    SMESH_Pattern GetPattern();

    void SetEmbeddedMode( in boolean theMode );

    boolean IsEmbeddedMode();

    void SetCurrentStudy( in SALOMEDS::Study theStudy );

    SALOMEDS::Study GetCurrentStudy();

    SMESH_Hypothesis CreateHypothesis( in string theHypName,
                           in string theLibName )
      raises ( SALOME::SALOME_Exception );

    SMESH_Hypothesis GetHypothesisParameterValues( in string            theHypName,
                                                   in string            theLibName,
                                                   in SMESH_Mesh        theMesh,
                                                   in GEOM::GEOM_Object theGeom)
      raises ( SALOME::SALOME_Exception );

    SMESH_Mesh CreateMesh( in GEOM::GEOM_Object theObject )
      raises ( SALOME::SALOME_Exception );
    
    SMESH_Mesh CreateEmptyMesh()
      raises ( SALOME::SALOME_Exception );
    
    SMESH_Mesh CreateMeshesFromUNV( in string theFileName )
      raises ( SALOME::SALOME_Exception );

     mesh_array CreateMeshesFromMED( in string theFileName,
                         out SMESH::DriverMED_ReadStatus theStatus )
       raises ( SALOME::SALOME_Exception );

    SMESH_Mesh CreateMeshesFromSTL( in string theFileName )
      raises ( SALOME::SALOME_Exception );

//      SMESH_Mesh NewEmpty()
//        raises ( SALOME::SALOME_Exception );

    boolean Compute( in SMESH_Mesh        theMesh, 
               in GEOM::GEOM_Object theSubObject )
      raises ( SALOME::SALOME_Exception );

    boolean IsReadyToCompute( in SMESH_Mesh        theMesh, 
                     in GEOM::GEOM_Object theSubObject )
      raises ( SALOME::SALOME_Exception );

    algo_error_array GetAlgoState( in SMESH_Mesh        theMesh, 
                                   in GEOM::GEOM_Object theSubObject )
      raises ( SALOME::SALOME_Exception );

    compute_error_array GetComputeErrors( in SMESH_Mesh        theMesh, 
                                          in GEOM::GEOM_Object theSubObject )
      raises ( SALOME::SALOME_Exception );

    long_array GetSubShapesId( in GEOM::GEOM_Object theMainObject,
                               in object_array      theListOfSubObjects )
       raises ( SALOME::SALOME_Exception );

    GEOM::GEOM_Object GetGeometryByMeshElement( in SMESH_Mesh  theMesh,
                                                in long        theElementID,
                                                in string      theGeomName)
      raises ( SALOME::SALOME_Exception );

    GEOM::GEOM_Object FindGeometryByMeshElement( in SMESH_Mesh  theMesh,
                               in long        theElementID)
      raises ( SALOME::SALOME_Exception );

    SMESH_Mesh Concatenate(in mesh_array theMeshesArray, 
                  in boolean    theUniteIdenticalGroups, 
                  in boolean    theMergeNodesAndElements, 
                  in double     theMergeTolerance)
      raises ( SALOME::SALOME_Exception );

  };

};

#endif

Generated on Thu Apr 26 18:28:55 2007 for SALOME - SMESH - v.3.2.6 by  1.4.6