src/SMESHGUI/SMESHGUI_HypothesesUtils.h

   1 // Copyright (C) 2007-2021  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 // SMESH SMESHGUI : GUI for SMESH component
  24 // File   : SMESHGUI_HypothesesUtils.h
  25 // Author : Julia DOROVSKIKH, Open CASCADE S.A.S.
  26 //
  27 #ifndef SMESHGUI_HYPOTHESESUTILS_H
  28 #define SMESHGUI_HYPOTHESESUTILS_H
  29
  30 // SMESH includes
  31 #include "SMESH_SMESHGUI.hxx"
  32
  33 // Qt includes
  34 #include <QString>
  35 #include <QStringList>
  36
  37 // SALOME GUI includes
  38 #include <SALOME_InteractiveObject.hxx>
  39
  40 // SALOME KERNEL includes
  41 #include <SALOMEDSClient_definitions.hxx>
  42
  43 // IDL includes
  44 #include <SALOMEconfig.h>
  45 #include CORBA_SERVER_HEADER(SMESH_Mesh)
  46 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
  47
  48 // STL includes
  49 #include <vector>
  50
  51 // boost includes
  52 #include <boost/shared_ptr.hpp>
  53
  54 class HypothesisData;
  55 class HypothesesSet;
  56 class SMESHGUI_GenericHypothesisCreator;
  57 class SALOMEDSClient_SObject;
  58 class algo_error_array;
  59
  60
  61 namespace SMESH
  62 {
  63   SMESHGUI_EXPORT
  64   void InitAvailableHypotheses();
  65
  66   SMESHGUI_EXPORT
  67   QStringList GetAvailableHypotheses( const bool,
  68                                       const int = -1,
  69                                       const bool = false,
  70                                       const bool = true,
  71                                       const bool = false);
  72   SMESHGUI_EXPORT
  73   QStringList GetHypothesesSets( int );
  74
  75   SMESHGUI_EXPORT
  76   HypothesesSet* GetHypothesesSet( const QString& );
  77
  78   SMESHGUI_EXPORT
  79   HypothesisData* GetHypothesisData( const QString& );
  80
  81   SMESHGUI_EXPORT
  82   HypothesisData* GetGroupTitle( const HypothesisData* hyp, const bool isAlgo );
  83
  84   SMESHGUI_EXPORT
  85   bool IsAvailableHypothesis( const HypothesisData*,
  86                               const QString&,
  87                               bool& );
  88
  89   SMESHGUI_EXPORT
  90   bool IsCompatibleAlgorithm( const HypothesisData*,
  91                               const HypothesisData* );
  92
  93   SMESHGUI_EXPORT
  94   SMESHGUI_GenericHypothesisCreator* GetHypothesisCreator( const QString& );
  95
  96   SMESHGUI_EXPORT
  97   SMESH::SMESH_Hypothesis_ptr CreateHypothesis( const QString&,
  98                                                 const QString&,
  99                                                 const bool = false );
 100   SMESHGUI_EXPORT
 101   bool IsApplicable( const QString&,
 102                      GEOM::GEOM_Object_ptr,
 103                      const bool = false );
 104
 105   SMESHGUI_EXPORT
 106   bool AddHypothesisOnMesh( SMESH::SMESH_Mesh_ptr, SMESH::SMESH_Hypothesis_ptr );
 107
 108   SMESHGUI_EXPORT
 109   bool AddHypothesisOnSubMesh( SMESH::SMESH_subMesh_ptr, SMESH::SMESH_Hypothesis_ptr );
 110
 111   SMESHGUI_EXPORT
 112   bool RemoveHypothesisOrAlgorithmOnMesh( const Handle(SALOME_InteractiveObject)& );
 113
 114   SMESHGUI_EXPORT
 115   bool RemoveHypothesisOrAlgorithmOnMesh( _PTR(SObject),
 116                                           SMESH::SMESH_Hypothesis_ptr );
 117
 118   typedef std::vector<_PTR(SObject)> SObjectList;
 119   SMESHGUI_EXPORT
 120   SObjectList GetMeshesUsingAlgoOrHypothesis( SMESH::SMESH_Hypothesis_ptr );
 121
 122   SMESHGUI_EXPORT
 123   QString GetMessageOnAlgoStateErrors( const algo_error_array& );
 124
 125   SMESHGUI_EXPORT
 126   // name of proprty saving plug-in of a hypothesis
 127   inline const char* Plugin_Name() { return "PLUGIN_NAME"; }
 128 }
 129
 130 #endif // SMESHGUI_HYPOTHESESUTILS_H