src/SMESHGUI/SMESHGUI_HypothesesUtils.h

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