idl/BLSURFPlugin_Algorithm.idl

   1 //  Copyright (C) 2007-2008  CEA/DEN, EDF R&D
   2 //
   3 //  This library is free software; you can redistribute it and/or
   4 //  modify it under the terms of the GNU Lesser General Public
   5 //  License as published by the Free Software Foundation; either
   6 //  version 2.1 of the License.
   7 //
   8 //  This library is distributed in the hope that it will be useful,
   9 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 //  Lesser General Public License for more details.
  12 //
  13 //  You should have received a copy of the GNU Lesser General Public
  14 //  License along with this library; if not, write to the Free Software
  15 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19 // ---
  20 // File    : BLSURFPlugin_Algorithm.idl
  21 // Authors : Francis KLOSS (OCC) & Patrick LAUG (INRIA) & Lioka RAZAFINDRAZAKA (CEA)
  22 // ---
  23 //
  24 #ifndef _SMESH_BLSURFALGORITHM_IDL_
  25 #define _SMESH_BLSURFALGORITHM_IDL_
  26
  27 #include "SMESH_Hypothesis.idl"
  28 #include "SALOME_Exception.idl"
  29
  30 /*!
  31  * BLSURFPlugin: interfaces to BLSURF related hypotheses and algorithms
  32  */
  33 module BLSURFPlugin
  34 {
  35   typedef sequence<string> string_array;
  36
  37   /*!
  38    * BLSURFPlugin_BLSURF: interface of BLSURF algorithm
  39    */
  40   interface BLSURFPlugin_BLSURF : SMESH::SMESH_2D_Algo
  41   {
  42   };
  43
  44   /*!
  45    * BLSURFPlugin_Hypothesis: interface of "BLSURF parameters" hypothesis
  46    */
  47   interface BLSURFPlugin_Hypothesis : SMESH::SMESH_Hypothesis
  48   {
  49     /*!
  50      * Sets topology usage way defining how mesh conformity is assured
  51      * value=0 - mesh conformity is assured by conformity of a shape
  52      * value=1,2 - mesh conformity is assured by pre-processing a CAD model
  53      */
  54     void SetTopology(in long way);
  55     long GetTopology();
  56
  57     /*!
  58      * Sets a way to define size of mesh elements to generate
  59      * 0 - size is defined automatically
  60      * 1 - size is set by SetPhySize() method
  61      */
  62     void SetPhysicalMesh(in long isCustom);
  63     long GetPhysicalMesh();
  64
  65     /*!
  66      * Sets size of mesh elements to generate
  67      */
  68     void SetPhySize(in double size);
  69     double GetPhySize();
  70
  71     /*!
  72      * Sets lower boundary of mesh element size (PhySize)
  73      */
  74     void SetPhyMin(in double theMinSize);
  75     double GetPhyMin();
  76
  77     /*!
  78      * Sets upper boundary of mesh element size (PhySize)
  79      */
  80     void SetPhyMax(in double theMaxSize);
  81     double GetPhyMax();
  82
  83     /*!
  84      * Sets a way to define maximum angular deflection of mesh from CAD model
  85      * 0 - deflection is defined automatically
  86      * 1 - deflection is set by SetAngleMeshS() and SetAngleMeshC() methods
  87      */
  88     void SetGeometricMesh(in long isCustom);
  89     long GetGeometricMesh();
  90
  91     /*!
  92      * Sets angular deflection (in degrees) of a mesh face from CAD surface
  93      */
  94     void SetAngleMeshS(in double angle);
  95     double GetAngleMeshS();
  96
  97     /*!
  98      * Sets angular deflection (in degrees) of a mesh edge from CAD curve
  99      */
 100     void SetAngleMeshC(in double angle);
 101     double GetAngleMeshC();
 102
 103     /*!
 104      * Sets lower boundary of mesh element size computed to respect angular deflection
 105      */
 106     void SetGeoMin(in double theMinSize);
 107     double GetGeoMin();
 108
 109     /*!
 110      * Sets upper boundary of mesh element size computed to respect angular deflection
 111      */
 112     void SetGeoMax(in double theMaxSize);
 113     double GetGeoMax();
 114
 115     /*!
 116      * Sets maximal allowed ratio between the lengths of two adjacent edges
 117      */
 118     void SetGradation(in double ratio);
 119     double GetGradation();
 120
 121     /*!
 122      * Sets to create quadrilateral elements or not
 123      */
 124     void SetQuadAllowed(in boolean allowed);
 125     boolean GetQuadAllowed();
 126
 127     /*!
 128      * To respect geometrical edges or not
 129      */
 130     void SetDecimesh(in boolean toIgnoreEdges);
 131     boolean GetDecimesh();
 132
 133     /*!
 134      * Sets verbosity level in the range 0 to 100.
 135      */
 136     void SetVerbosity(in short theVal) raises (SALOME::SALOME_Exception);
 137     short GetVerbosity();
 138
 139     /*!
 140      * Sets advanced option value
 141      */
 142     void SetOptionValue(in string optionName,
 143                         in string optionValue) raises (SALOME::SALOME_Exception);
 144     string GetOptionValue(in string optionName) raises (SALOME::SALOME_Exception);
 145     /*!
 146      * Unsets advanced option
 147      */
 148     void UnsetOption(in string optionName);
 149
 150     /*!
 151      * Return array of strings each of which is option name concatenated
 152      * with option value devided by semicolon - "option_name:option_value".
 153      * Option value is empty if an option is not set.
 154      * Note: the method is mostly for interaction with GUI.
 155      */
 156     string_array GetOptionValues();
 157
 158     /*!
 159      * Set option values each in the form "option_name[:option_value]".
 160      * Note: the method is mostly for interaction with GUI.
 161      */
 162     void SetOptionValues(in string_array options);
 163   };
 164
 165 };
 166
 167 #endif