Salome HOME
Update of the documentation of the plugin "blocfissure"
[modules/smesh.git] / 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
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 the variable parameter
64      *  \param parameter is a string containing the notebook variable
65      *         used for Hypothesis creation
66      *  \param method is a name of Hypothesis method setting this parameter
67      *
68      *  This method must be called before calling method()
69      */
70     void SetVarParameter (in string parameter, in string method);
71
72     /*!
73      *  Return the variable parameter used for Hypothesis creation by name of method
74      *  setting this parameter
75      */
76     string GetVarParameter (in string methodName);
77
78     /*!
79      * \brief Store a hypothesis wrapping this not published one.
80      *
81      * This hyp, which has no own parameters but is published, is used to store variables
82      * defining parameters of this hypothesis.
83      */
84     void SetHolderHypothesis(in SMESH::SMESH_Hypothesis hyp);
85
86     /*!
87      * Verify whether hypothesis supports given entity type 
88      */
89     boolean IsDimSupported( in Dimension type );
90
91     /*!
92      * Return true if a hypothesis has parameters.
93      *
94      * This method is intended for GUI to know if "Edit" menu item should be available
95      */
96     boolean HasParameters();
97   };
98
99   typedef sequence<string> ListOfHypothesisName;
100
101   interface SMESH_Algo : SMESH_Hypothesis
102   {
103     /*!
104      * Get list of hypothesis that can be used with this algorithm
105      */
106     ListOfHypothesisName GetCompatibleHypothesis();
107
108   };
109
110   interface SMESH_0D_Algo : SMESH_Algo
111   {
112     /*!
113      * 
114      */
115   };
116
117   interface SMESH_1D_Algo : SMESH_Algo
118   {
119     /*!
120      * 
121      */
122   };
123
124   interface SMESH_2D_Algo : SMESH_Algo
125   {
126     /*!
127      * 
128      */
129   };
130
131   interface SMESH_3D_Algo : SMESH_Algo
132   {
133     /*!
134      * 
135      */
136   };
137 };
138
139   // -----------------------------------------------------------------
140   // Specific Algorithms in separate idl file
141   // -----------------------------------------------------------------
142
143
144 #endif