idl/SMESH_Hypothesis.idl

   1 // Copyright (C) 2007-2020  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, or (at your option) any later version.
  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
  23 //  File   : SMESH_Hypothesis.idl
  24 //  Author : Paul RASCLE, EDF
  25 //
  26 #ifndef _SMESH_HYPOTHESIS_IDL_
  27 #define _SMESH_HYPOTHESIS_IDL_
  28
  29 #include "SALOME_Exception.idl"
  30 #include "SALOME_GenericObj.idl"
  31 #include "SMESH_smIdType.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   typedef sequence<string> ListOfParameters;
  44
  45   interface SMESH_Hypothesis : SALOME::GenericObj
  46   {
  47
  48     /*!
  49      * Get the Hypothesis typeName
  50      */
  51     string GetName();
  52
  53     /*!
  54      * Get the Hypothesis plugin library Name
  55      */
  56     string GetLibName();
  57
  58     /*!
  59      * Get the internal Id
  60      */
  61     smIdType GetId();
  62
  63     /*!
  64      *  Set the variable parameter
  65      *  \param parameter is a string containing the notebook variable
  66      *         used for Hypothesis creation
  67      *  \param method is a name of Hypothesis method setting this parameter
  68      *
  69      *  This method must be called before calling method()
  70      */
  71     void SetVarParameter (in string parameter, in string method);
  72
  73     /*!
  74      *  Return the variable parameter used for Hypothesis creation by name of method
  75      *  setting this parameter
  76      */
  77     string GetVarParameter (in string methodName);
  78
  79     /*!
  80      * \brief Store a hypothesis wrapping this not published one.
  81      *
  82      * This hyp, which has no own parameters but is published, is used to store variables
  83      * defining parameters of this hypothesis.
  84      */
  85     void SetHolderHypothesis(in SMESH::SMESH_Hypothesis hyp);
  86
  87     /*!
  88      * Verify whether hypothesis supports given entity type
  89      */
  90     boolean IsDimSupported( in Dimension type );
  91
  92     /*!
  93      * Return true if a hypothesis has parameters.
  94      *
  95      * This method is intended for GUI to know if "Edit" menu item should be available
  96      */
  97     boolean HasParameters();
  98   };
  99
 100   typedef sequence<string> ListOfHypothesisName;
 101
 102   interface SMESH_Algo : SMESH_Hypothesis
 103   {
 104     /*!
 105      * Get list of hypothesis that can be used with this algorithm
 106      */
 107     ListOfHypothesisName GetCompatibleHypothesis();
 108
 109   };
 110
 111   interface SMESH_0D_Algo : SMESH_Algo
 112   {
 113     /*!
 114      *
 115      */
 116   };
 117
 118   interface SMESH_1D_Algo : SMESH_Algo
 119   {
 120     /*!
 121      *
 122      */
 123   };
 124
 125   interface SMESH_2D_Algo : SMESH_Algo
 126   {
 127     /*!
 128      *
 129      */
 130   };
 131
 132   interface SMESH_3D_Algo : SMESH_Algo
 133   {
 134     /*!
 135      *
 136      */
 137   };
 138 };
 139
 140   // -----------------------------------------------------------------
 141   // Specific Algorithms in separate idl file
 142   // -----------------------------------------------------------------
 143
 144
 145 #endif