Salome HOME
Merge from V5_1_main 14/05/2010
[modules/smesh.git] / src / SMESHGUI / SMESHGUI_HypothesesUtils.h
1 //  Copyright (C) 2007-2010  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
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 namespace SMESH
61 {
62   SMESHGUI_EXPORT
63   void InitAvailableHypotheses();
64
65   SMESHGUI_EXPORT
66   QStringList GetAvailableHypotheses( const bool, 
67                                       const int = -1, 
68                                       const bool = false,
69                                       const bool = true);
70   SMESHGUI_EXPORT
71   QStringList GetHypothesesSets();
72
73   SMESHGUI_EXPORT
74   HypothesesSet* GetHypothesesSet( const QString& );
75
76   SMESHGUI_EXPORT
77   HypothesisData* GetHypothesisData( const QString& );
78
79   SMESHGUI_EXPORT
80   bool IsAvailableHypothesis( const HypothesisData*,
81                               const QString&,
82                               bool& );
83
84   SMESHGUI_EXPORT
85   bool IsCompatibleAlgorithm( const HypothesisData*,
86                               const HypothesisData* );
87
88   SMESHGUI_EXPORT
89   SMESHGUI_GenericHypothesisCreator* GetHypothesisCreator( const QString& );
90
91   SMESHGUI_EXPORT
92   SMESH::SMESH_Hypothesis_ptr CreateHypothesis( const QString&,
93                                                 const QString&,
94                                                 const bool = false );
95
96   SMESHGUI_EXPORT
97   bool AddHypothesisOnMesh( SMESH::SMESH_Mesh_ptr, SMESH::SMESH_Hypothesis_ptr );
98
99   SMESHGUI_EXPORT
100   bool AddHypothesisOnSubMesh( SMESH::SMESH_subMesh_ptr, SMESH::SMESH_Hypothesis_ptr );
101
102   SMESHGUI_EXPORT
103   bool RemoveHypothesisOrAlgorithmOnMesh( const Handle(SALOME_InteractiveObject)& );
104
105   SMESHGUI_EXPORT
106   bool RemoveHypothesisOrAlgorithmOnMesh( _PTR(SObject),
107                                           SMESH::SMESH_Hypothesis_ptr );
108
109   typedef std::vector<_PTR(SObject)> SObjectList;
110   SObjectList GetMeshesUsingAlgoOrHypothesis( SMESH::SMESH_Hypothesis_ptr );
111
112   SMESHGUI_EXPORT
113   QString GetMessageOnAlgoStateErrors( const algo_error_array& );
114 }
115
116 #endif // SMESHGUI_HYPOTHESESUTILS_H