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   typedef boost::shared_ptr<SMESHGUI_GenericHypothesisCreator> HypothesisCreatorPtr;
  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   SMESHGUI_EXPORT
  72   QStringList GetHypothesesSets();
  73
  74   SMESHGUI_EXPORT
  75   HypothesesSet* GetHypothesesSet( const QString& );
  76
  77   SMESHGUI_EXPORT
  78   HypothesisData* GetHypothesisData( const QString& );
  79
  80   SMESHGUI_EXPORT
  81   bool IsAvailableHypothesis( const HypothesisData*,
  82                               const QString&,
  83                               bool& );
  84
  85   SMESHGUI_EXPORT
  86   bool IsCompatibleAlgorithm( const HypothesisData*,
  87                               const HypothesisData* );
  88
  89   SMESHGUI_EXPORT
  90   HypothesisCreatorPtr GetHypothesisCreator( const QString& );
  91
  92   SMESHGUI_EXPORT
  93   SMESH::SMESH_Hypothesis_ptr CreateHypothesis( const QString&,
  94                                                 const QString&,
  95                                                 const bool = false );
  96
  97   SMESHGUI_EXPORT
  98   bool AddHypothesisOnMesh( SMESH::SMESH_Mesh_ptr, SMESH::SMESH_Hypothesis_ptr );
  99
 100   SMESHGUI_EXPORT
 101   bool AddHypothesisOnSubMesh( SMESH::SMESH_subMesh_ptr, SMESH::SMESH_Hypothesis_ptr );
 102
 103   SMESHGUI_EXPORT
 104   bool RemoveHypothesisOrAlgorithmOnMesh( const Handle(SALOME_InteractiveObject)& );
 105
 106   SMESHGUI_EXPORT
 107   bool RemoveHypothesisOrAlgorithmOnMesh( _PTR(SObject),
 108                                           SMESH::SMESH_Hypothesis_ptr );
 109
 110   typedef std::vector<_PTR(SObject)> SObjectList;
 111   SObjectList GetMeshesUsingAlgoOrHypothesis( SMESH::SMESH_Hypothesis_ptr );
 112
 113   SMESHGUI_EXPORT
 114   QString GetMessageOnAlgoStateErrors( const algo_error_array& );
 115 }
 116
 117 #endif // SMESHGUI_HYPOTHESESUTILS_H