Salome HOME
Update mail address
[modules/smesh.git] / src / SMESH / SMESH_Gen.hxx
1 //  SMESH SMESH : implementaion of SMESH idl descriptions
2 //
3 //  Copyright (C) 2003  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 //
24 //  File   : SMESH_Gen.hxx
25 //  Author : Paul RASCLE, EDF
26 //  Module : SMESH
27 //  $Header$
28
29 #ifndef _SMESH_GEN_HXX_
30 #define _SMESH_GEN_HXX_
31
32 #include "Utils_SALOME_Exception.hxx"
33
34 #include "SMESH_Hypothesis.hxx"
35 #include "SMESH_Algo.hxx"
36 #include "SMESH_1D_Algo.hxx"
37 #include "SMESH_2D_Algo.hxx"
38 #include "SMESH_3D_Algo.hxx"
39 #include "SMESH_Mesh.hxx"
40
41 #include "SMESHDS_Document.hxx"
42
43 #include <TopoDS_Shape.hxx>
44
45 #include <map>
46
47
48 typedef struct studyContextStruct
49 {
50         std::map < int, SMESH_Hypothesis * >mapHypothesis;
51           std::map < int, SMESH_Mesh * >mapMesh;
52           SMESHDS_Document * myDocument;
53 } StudyContextStruct;
54
55 class SMESH_Gen
56 {
57  public:
58   SMESH_Gen();
59   ~SMESH_Gen();
60
61 //  SMESH_Hypothesis *CreateHypothesis(const char *anHyp, int studyId)
62 //    throw(SALOME_Exception);
63   SMESH_Mesh* CreateMesh(int theStudyId, bool theIsEmbeddedMode)
64     throw(SALOME_Exception);
65   bool Compute(::SMESH_Mesh & aMesh, const TopoDS_Shape & aShape);
66
67   bool CheckAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
68   // notify on bad state of attached algos, return false
69   // if Compute() would fail because of some algo bad state
70
71   
72   enum TAlgoStateErrorName { NONE=0, MISSING_ALGO, MISSING_HYPO, NOT_CONFORM_MESH };
73   struct TAlgoStateError
74   {
75     TAlgoStateErrorName _name;
76     const SMESH_Algo*   _algo;
77     int                 _algoDim;
78     bool                _isGlobalAlgo;
79
80     TAlgoStateError(): _algoDim(0),_algo(0),_name(NONE) {}
81     void Set(TAlgoStateErrorName name, const SMESH_Algo* algo, bool isGlobal)
82     { _name = name; _algo = algo; _algoDim = algo->GetDim(); _isGlobalAlgo = isGlobal; }
83     void Set(TAlgoStateErrorName name, const int algoDim,      bool isGlobal)
84     { _name = name; _algo = 0;    _algoDim = algoDim;        _isGlobalAlgo = isGlobal; }
85   };
86
87   bool GetAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape,
88                     std::list< SMESH_Gen::TAlgoStateError > & theErrors);
89   // notify on bad state of attached algos, return false
90   // if Compute() would fail because of some algo bad state
91   // theErrors list contains problems description
92
93
94   StudyContextStruct *GetStudyContext(int studyId);
95
96   static int GetShapeDim(const TopAbs_ShapeEnum & aShapeType);
97   static int GetShapeDim(const TopoDS_Shape & aShape)
98   { return GetShapeDim( aShape.ShapeType() ); }
99   SMESH_Algo* GetAlgo(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape);
100   static bool IsGlobalHypothesis(const SMESH_Hypothesis* theHyp, SMESH_Mesh& aMesh);
101
102   // inherited methods from SALOMEDS::Driver
103
104   void Save(int studyId, const char *aUrlOfFile);
105   void Load(int studyId, const char *aUrlOfFile);
106   void Close(int studyId);
107   const char *ComponentDataType();
108
109   const char *IORToLocalPersistentID(const char *IORString, bool & IsAFile);
110   const char *LocalPersistentIDToIOR(const char *aLocalPersistentID);
111
112   int GetANewId();
113
114   std::map < int, SMESH_Algo * >_mapAlgo;
115   std::map < int, SMESH_1D_Algo * >_map1D_Algo;
116   std::map < int, SMESH_2D_Algo * >_map2D_Algo;
117   std::map < int, SMESH_3D_Algo * >_map3D_Algo;
118
119  private:
120
121   int _localId;                         // unique Id of created objects, within SMESH_Gen entity
122   std::map < int, StudyContextStruct * >_mapStudyContext;
123
124   // hypotheses managing
125   int _hypId;
126 };
127
128 #endif