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_0D,
  37     DIM_1D,
  38     DIM_2D,
  39     DIM_3D
  40   };
  41
  42   interface SMESH_Hypothesis : SALOME::GenericObj
  43   {
  44     /*!
  45      * Get the Hypothesis typeName
  46      */
  47     string GetName();
  48
  49     /*!
  50      * Get the Hypothesis plugin library Name
  51      */
  52     string GetLibName();
  53
  54     /*!
  55      * Get the internal Id
  56      */
  57     long GetId();
  58
  59     /*!
  60      *  Set list of parameters
  61      *  \param theParameters is a string containing the notebook variables separated by ":" symbol,
  62      *         used for Hypothesis creation
  63      */
  64     void SetParameters (in string theParameters);
  65
  66     /*!
  67      *  Return list of notebook variables used for Hypothesis creation separated by ":" symbol
  68      */
  69     string GetParameters();
  70
  71     /*!
  72      * Verify whether hypothesis supports given entity type
  73      */
  74     boolean IsDimSupported( in Dimension type );
  75   };
  76
  77   typedef sequence<string> ListOfHypothesisName;
  78
  79   interface SMESH_Algo : SMESH_Hypothesis
  80   {
  81     /*!
  82      * Get list of hypothesis that can be used with this algorithm
  83      */
  84     ListOfHypothesisName GetCompatibleHypothesis();
  85
  86   };
  87
  88   interface SMESH_0D_Algo : SMESH_Algo
  89   {
  90     /*!
  91      *
  92      */
  93   };
  94
  95   interface SMESH_1D_Algo : SMESH_Algo
  96   {
  97     /*!
  98      *
  99      */
 100   };
 101
 102   interface SMESH_2D_Algo : SMESH_Algo
 103   {
 104     /*!
 105      *
 106      */
 107   };
 108
 109   interface SMESH_3D_Algo : SMESH_Algo
 110   {
 111     /*!
 112      *
 113      */
 114   };
 115 };
 116
 117   // -----------------------------------------------------------------
 118   // Specific Algorithms in separate idl file
 119   // -----------------------------------------------------------------
 120
 121
 122 #endif