idl/SMESH_Hypothesis.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_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 #include "SALOME_Notebook.idl"
  32
  33 module SMESH
  34 {
  35   enum Dimension
  36   {
  37     DIM_0D,
  38     DIM_1D,
  39     DIM_2D,
  40     DIM_3D
  41   };
  42
  43   interface SMESH_Hypothesis : SALOME::ParameterizedObject
  44   {
  45
  46     /*!
  47      * Get the Hypothesis typeName
  48      */
  49     string GetName();
  50
  51     /*!
  52      * Get the Hypothesis plugin library Name
  53      */
  54     string GetLibName();
  55
  56     /*!
  57      * Get the internal Id
  58      */
  59     long GetId();
  60
  61     /*!
  62      * Verify whether hypothesis supports given entity type
  63      */
  64     boolean IsDimSupported( in Dimension type );
  65   };
  66
  67   typedef sequence<string> ListOfHypothesisName;
  68
  69   interface SMESH_Algo : SMESH_Hypothesis
  70   {
  71     /*!
  72      * Get list of hypothesis that can be used with this algorithm
  73      */
  74     ListOfHypothesisName GetCompatibleHypothesis();
  75
  76   };
  77
  78   interface SMESH_0D_Algo : SMESH_Algo
  79   {
  80     /*!
  81      *
  82      */
  83   };
  84
  85   interface SMESH_1D_Algo : SMESH_Algo
  86   {
  87     /*!
  88      *
  89      */
  90   };
  91
  92   interface SMESH_2D_Algo : SMESH_Algo
  93   {
  94     /*!
  95      *
  96      */
  97   };
  98
  99   interface SMESH_3D_Algo : SMESH_Algo
 100   {
 101     /*!
 102      *
 103      */
 104   };
 105 };
 106
 107   // -----------------------------------------------------------------
 108   // Specific Algorithms in separate idl file
 109   // -----------------------------------------------------------------
 110
 111
 112 #endif