Salome HOME
Merge from BR_V5_DEV 16Feb09
[modules/smesh.git] / idl / SMESH_Hypothesis.idl
index ec61223eb92a8a0a88156426200e521d13ce3135..56ae48b0cfed28db8767c589560f11ab2949c2ba 100644 (file)
-//=============================================================================
-// File      : SMESH_Hypothesis.idl
-// Created   : jeu avr 11 19:26:16 CEST 2002
-// Author    : Paul RASCLE, EDF
-// Project   : SALOME
-// Copyright : EDF 2002
-// $Header$
-//=============================================================================
-
+//  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
+//
+//  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+//  This library is free software; you can redistribute it and/or
+//  modify it under the terms of the GNU Lesser General Public
+//  License as published by the Free Software Foundation; either
+//  version 2.1 of the License.
+//
+//  This library is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+//  Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public
+//  License along with this library; if not, write to the Free Software
+//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+//  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+//  File   : SMESH_Hypothesis.idl
+//  Author : Paul RASCLE, EDF
+//  $Header$
+//
 #ifndef _SMESH_HYPOTHESIS_IDL_
 #define _SMESH_HYPOTHESIS_IDL_
 
 #include "SALOME_Exception.idl"
+#include "SALOME_GenericObj.idl"
 
 module SMESH
 {
-  interface SMESH_Hypothesis;
-
-  typedef sequence<SMESH_Hypothesis> ListOfHypothesis;
-  typedef sequence<string> ListOfHypothesisName;
+  enum Dimension
+  {
+    DIM_0D,
+    DIM_1D,
+    DIM_2D,
+    DIM_3D
+  };
+  
+  typedef sequence<string> ListOfParameters;
 
-  interface SMESH_Hypothesis
+  interface SMESH_Hypothesis : SALOME::GenericObj
   {
+    
     /*!
      * Get the Hypothesis typeName 
      */
     string GetName();
 
+    /*!
+     * Get the Hypothesis plugin library Name 
+     */
+    string GetLibName();
+
     /*!
      * Get the internal Id 
      */
     long GetId();
- };
+
+    /*!
+     *  Set list of parameters
+     *  \param theParameters is a string containing the notebook variables separated by ":" symbol,
+     *         used for Hypothesis creation
+     */
+    void SetParameters (in string theParameters);
+
+    /*!
+     *  Return list of notebook variables used for Hypothesis creation separated by ":" symbol
+     */
+    string GetParameters();
+
+    /*!
+     *  Return list of last notebook variables used for Hypothesis creation.
+     */
+    ListOfParameters GetLastParameters();
+
+    /*!
+     *  Set list of parameters
+     *  \param theParameters is a string containing the last notebook variables separated by ":" symbol,
+     *         used for Hypothesis creation
+     */
+    void SetLastParameters(in string theParameters);
+    
+    /*!
+     * Clear parameters list
+     */
+    void ClearParameters();
+
+    /*!
+     * Verify whether hypothesis supports given entity type 
+     */
+    boolean IsDimSupported( in Dimension type );
+  };
+
+  typedef sequence<string> ListOfHypothesisName;
 
   interface SMESH_Algo : SMESH_Hypothesis
   {
@@ -41,6 +105,13 @@ module SMESH
 
   };
 
+  interface SMESH_0D_Algo : SMESH_Algo
+  {
+    /*!
+     * 
+     */
+  };
+
   interface SMESH_1D_Algo : SMESH_Algo
   {
     /*!