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
  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      *  Set list of parameters
  81      *  \param theParameters is a string containing the last notebook variables separated by ":" symbol,
  82      *         used for Hypothesis creation
  83      */
  84     void SetLastParameters(in string theParameters);
  85
  86     /*!
  87      * Clear parameters list
  88      */
  89     void ClearParameters();
  90
  91     /*!
  92      * Verify whether hypothesis supports given entity type
  93      */
  94     boolean IsDimSupported( in Dimension type );
  95   };
  96
  97   typedef sequence<string> ListOfHypothesisName;
  98
  99   interface SMESH_Algo : SMESH_Hypothesis
 100   {
 101     /*!
 102      * Get list of hypothesis that can be used with this algorithm
 103      */
 104     ListOfHypothesisName GetCompatibleHypothesis();
 105
 106   };
 107
 108   interface SMESH_0D_Algo : SMESH_Algo
 109   {
 110     /*!
 111      *
 112      */
 113   };
 114
 115   interface SMESH_1D_Algo : SMESH_Algo
 116   {
 117     /*!
 118      *
 119      */
 120   };
 121
 122   interface SMESH_2D_Algo : SMESH_Algo
 123   {
 124     /*!
 125      *
 126      */
 127   };
 128
 129   interface SMESH_3D_Algo : SMESH_Algo
 130   {
 131     /*!
 132      *
 133      */
 134   };
 135 };
 136
 137   // -----------------------------------------------------------------
 138   // Specific Algorithms in separate idl file
 139   // -----------------------------------------------------------------
 140
 141
 142 #endif