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