idl/SMESH_Hypothesis.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.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 //
  20 //
  21 //
  22 //  File   : SMESH_Hypothesis.idl
  23 //  Author : Paul RASCLE, EDF
  24 //  $Header$
  25
  26 #ifndef _SMESH_HYPOTHESIS_IDL_
  27 #define _SMESH_HYPOTHESIS_IDL_
  28
  29 #include "SALOME_Exception.idl"
  30 #include "SALOME_GenericObj.idl"
  31
  32 module SMESH
  33 {
  34   enum Dimension
  35   {
  36     DIM_1D,
  37     DIM_2D,
  38     DIM_3D
  39   };
  40
  41   interface SMESH_Hypothesis : SALOME::GenericObj
  42   {
  43     /*!
  44      * Get the Hypothesis typeName
  45      */
  46     string GetName();
  47
  48     /*!
  49      * Get the Hypothesis plugin library Name
  50      */
  51     string GetLibName();
  52
  53     /*!
  54      * Get the internal Id
  55      */
  56     long GetId();
  57
  58     /*!
  59      * Verify whether hypothesis supports given entity type
  60      */
  61     boolean IsDimSupported( in Dimension type );
  62   };
  63
  64   typedef sequence<string> ListOfHypothesisName;
  65
  66   interface SMESH_Algo : SMESH_Hypothesis
  67   {
  68     /*!
  69      * Get list of hypothesis that can be used with this algorithm
  70      */
  71     ListOfHypothesisName GetCompatibleHypothesis();
  72
  73   };
  74
  75   interface SMESH_1D_Algo : SMESH_Algo
  76   {
  77     /*!
  78      *
  79      */
  80   };
  81
  82   interface SMESH_2D_Algo : SMESH_Algo
  83   {
  84     /*!
  85      *
  86      */
  87   };
  88
  89   interface SMESH_3D_Algo : SMESH_Algo
  90   {
  91     /*!
  92      *
  93      */
  94   };
  95 };
  96
  97   // -----------------------------------------------------------------
  98   // Specific Algorithms in separate idl file
  99   // -----------------------------------------------------------------
 100
 101
 102 #endif