]> SALOME platform Git repositories - modules/smesh.git/blob - idl/SMESH_Hypothesis.idl
Salome HOME
0020749: EDF 1291 SMESH : Create 2D Mesh from 3D improvement
[modules/smesh.git] / idl / SMESH_Hypothesis.idl
1 //  Copyright (C) 2007-2010  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
23 //  File   : SMESH_Hypothesis.idl
24 //  Author : Paul RASCLE, EDF
25 //  $Header$
26 //
27 #ifndef _SMESH_HYPOTHESIS_IDL_
28 #define _SMESH_HYPOTHESIS_IDL_
29
30 #include "SALOME_Exception.idl"
31 #include "SALOME_GenericObj.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     long GetId();
62
63     /*!
64      *  Set list of parameters
65      *  \param theParameters is a string containing the notebook variables separated by ":" symbol,
66      *         used for Hypothesis creation
67      */
68     void SetParameters (in string theParameters);
69
70     /*!
71      *  Return list of notebook variables used for Hypothesis creation separated by ":" symbol
72      */
73     string GetParameters();
74
75     /*!
76      *  Return list of last notebook variables used for Hypothesis creation.
77      */
78     ListOfParameters GetLastParameters();
79
80     /*!
81      *  Set list of parameters
82      *  \param theParameters is a string containing the last notebook variables separated by ":" symbol,
83      *         used for Hypothesis creation
84      */
85     void SetLastParameters(in string theParameters);
86     
87     /*!
88      * Clear parameters list
89      */
90     void ClearParameters();
91
92     /*!
93      * Verify whether hypothesis supports given entity type 
94      */
95     boolean IsDimSupported( in Dimension type );
96   };
97
98   typedef sequence<string> ListOfHypothesisName;
99
100   interface SMESH_Algo : SMESH_Hypothesis
101   {
102     /*!
103      * Get list of hypothesis that can be used with this algorithm
104      */
105     ListOfHypothesisName GetCompatibleHypothesis();
106
107   };
108
109   interface SMESH_0D_Algo : SMESH_Algo
110   {
111     /*!
112      * 
113      */
114   };
115
116   interface SMESH_1D_Algo : SMESH_Algo
117   {
118     /*!
119      * 
120      */
121   };
122
123   interface SMESH_2D_Algo : SMESH_Algo
124   {
125     /*!
126      * 
127      */
128   };
129
130   interface SMESH_3D_Algo : SMESH_Algo
131   {
132     /*!
133      * 
134      */
135   };
136 };
137
138   // -----------------------------------------------------------------
139   // Specific Algorithms in separate idl file
140   // -----------------------------------------------------------------
141
142
143 #endif