smesh/idl/SMESH_Hypothesis.idl

145 lines
3.4 KiB
Plaintext
Raw Normal View History

2024-01-20 19:16:41 +05:00
// Copyright (C) 2007-2024 CEA, EDF, OPEN CASCADE
2003-07-10 21:09:38 +06:00
//
2012-08-09 16:03:55 +06:00
// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
2003-07-10 21:09:38 +06:00
//
2012-08-09 16:03:55 +06:00
// 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
2014-02-20 18:25:37 +06:00
// version 2.1 of the License, or (at your option) any later version.
2009-02-17 10:27:49 +05:00
//
2012-08-09 16:03:55 +06:00
// 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.
2009-02-17 10:27:49 +05:00
//
2012-08-09 16:03:55 +06:00
// 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
2009-02-17 10:27:49 +05:00
//
2012-08-09 16:03:55 +06:00
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
2003-07-10 21:09:38 +06:00
//
2012-08-09 16:03:55 +06:00
2003-07-10 21:09:38 +06:00
// File : SMESH_Hypothesis.idl
// Author : Paul RASCLE, EDF
2009-02-17 10:27:49 +05:00
//
2003-05-19 19:18:36 +06:00
#ifndef _SMESH_HYPOTHESIS_IDL_
#define _SMESH_HYPOTHESIS_IDL_
#include "SALOME_Exception.idl"
2004-06-18 14:34:31 +06:00
#include "SALOME_GenericObj.idl"
2003-05-19 19:18:36 +06:00
module SMESH
{
enum Dimension
{
DIM_0D,
DIM_1D,
DIM_2D,
DIM_3D
};
2009-02-17 10:27:49 +05:00
typedef sequence<string> ListOfParameters;
2004-06-18 14:34:31 +06:00
interface SMESH_Hypothesis : SALOME::GenericObj
2003-05-19 19:18:36 +06:00
{
2009-02-17 10:27:49 +05:00
2003-05-19 19:18:36 +06:00
/*!
* Get the Hypothesis typeName
*/
string GetName();
2004-06-18 14:34:31 +06:00
/*!
* Get the Hypothesis plugin library Name
*/
string GetLibName();
2003-05-19 19:18:36 +06:00
/*!
* Get the internal Id
*/
short GetId();
2009-02-17 10:27:49 +05:00
2012-08-09 16:03:55 +06:00
/*!
* Set the variable parameter
* \param parameter is a string containing the notebook variable
* used for Hypothesis creation
* \param method is a name of Hypothesis method setting this parameter
*
* This method must be called before calling method()
*/
void SetVarParameter (in string parameter, in string method);
/*!
* Return the variable parameter used for Hypothesis creation by name of method
* setting this parameter
*/
string GetVarParameter (in string methodName);
2009-02-17 10:27:49 +05:00
/*!
2013-04-01 19:05:47 +06:00
* \brief Store a hypothesis wrapping this not published one.
*
* This hyp, which has no own parameters but is published, is used to store variables
* defining parameters of this hypothesis.
2009-02-17 10:27:49 +05:00
*/
2013-04-01 19:05:47 +06:00
void SetHolderHypothesis(in SMESH::SMESH_Hypothesis hyp);
2009-02-17 10:27:49 +05:00
/*!
* Verify whether hypothesis supports given entity type
*/
boolean IsDimSupported( in Dimension type );
/*!
* Return true if a hypothesis has parameters.
*
* This method is intended for GUI to know if "Edit" menu item should be available
*/
boolean HasParameters();
2004-06-18 14:34:31 +06:00
};
typedef sequence<string> ListOfHypothesisName;
2003-05-19 19:18:36 +06:00
interface SMESH_Algo : SMESH_Hypothesis
{
/*!
* Get list of hypothesis that can be used with this algorithm
*/
ListOfHypothesisName GetCompatibleHypothesis();
};
interface SMESH_0D_Algo : SMESH_Algo
{
/*!
*
*/
};
2003-05-19 19:18:36 +06:00
interface SMESH_1D_Algo : SMESH_Algo
{
/*!
*
*/
};
interface SMESH_2D_Algo : SMESH_Algo
{
/*!
*
*/
};
interface SMESH_3D_Algo : SMESH_Algo
{
/*!
*
*/
};
};
// -----------------------------------------------------------------
// Specific Algorithms in separate idl file
// -----------------------------------------------------------------
#endif