Salome HOME
PAL13639 (EDF PAL 317 : SMESH : Create "0D Hypothesis")
[modules/smesh.git] / src / SMESH_I / SMESH_Mesh_i.hxx
1 //  SMESH SMESH_I : idl implementation based on 'SMESH' unit's calsses
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_Mesh_i.hxx
25 //  Author : Paul RASCLE, EDF
26 //  Module : SMESH
27 //  $Header$
28
29 #ifndef _SMESH_MESH_I_HXX_
30 #define _SMESH_MESH_I_HXX_
31
32 #include <SALOMEconfig.h>
33 #include CORBA_SERVER_HEADER(SMESH_Mesh)
34 #include CORBA_SERVER_HEADER(SMESH_Group)
35 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
36 #include CORBA_CLIENT_HEADER(GEOM_Gen)
37 #include CORBA_CLIENT_HEADER(MED)
38
39 #include "SMESH_Hypothesis.hxx"
40 #include "SMESH_Mesh.hxx"
41 #include "SMESH_subMesh_i.hxx"
42 #include "SMESH_subMesh.hxx"
43
44 #include "SALOME_GenericObj_i.hh"
45
46 class SMESH_Gen_i;
47 class SMESH_GroupBase_i;
48
49 #include <map>
50
51 class SMESH_Mesh_i:
52   public virtual POA_SMESH::SMESH_Mesh,
53   public virtual SALOME::GenericObj_i
54 {
55   SMESH_Mesh_i();
56   SMESH_Mesh_i(const SMESH_Mesh_i&);
57 public:
58   SMESH_Mesh_i( PortableServer::POA_ptr thePOA,
59                 SMESH_Gen_i*            myGen_i,
60                 CORBA::Long             studyId );
61
62   virtual ~SMESH_Mesh_i();
63
64   // --- CORBA
65   void SetShape( GEOM::GEOM_Object_ptr theShapeObject )
66     throw (SALOME::SALOME_Exception);
67
68   CORBA::Boolean HasShapeToMesh()
69     throw (SALOME::SALOME_Exception);
70
71   GEOM::GEOM_Object_ptr GetShapeToMesh()
72     throw (SALOME::SALOME_Exception);
73
74   SMESH::Hypothesis_Status AddHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
75                                          SMESH::SMESH_Hypothesis_ptr anHyp)
76     throw (SALOME::SALOME_Exception);
77
78   SMESH::Hypothesis_Status RemoveHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
79                                             SMESH::SMESH_Hypothesis_ptr anHyp)
80     throw (SALOME::SALOME_Exception);
81
82   SMESH::ListOfHypothesis* GetHypothesisList(GEOM::GEOM_Object_ptr aSubShapeObject)
83     throw (SALOME::SALOME_Exception);
84
85   SMESH::SMESH_subMesh_ptr GetSubMesh(GEOM::GEOM_Object_ptr aSubShapeObject, const char* theName)
86     throw (SALOME::SALOME_Exception);
87
88   void RemoveSubMesh( SMESH::SMESH_subMesh_ptr theSubMesh )
89     throw (SALOME::SALOME_Exception);
90
91   SMESH::SMESH_Group_ptr CreateGroup( SMESH::ElementType theElemType, const char* theName )
92     throw (SALOME::SALOME_Exception);
93   
94   SMESH::SMESH_GroupOnGeom_ptr CreateGroupFromGEOM(SMESH::ElementType    theElemType,
95                                                    const char*           theName,
96                                                    GEOM::GEOM_Object_ptr theGeomObj )
97     throw (SALOME::SALOME_Exception);
98
99   void RemoveGroup( SMESH::SMESH_GroupBase_ptr theGroup )
100     throw (SALOME::SALOME_Exception);
101   
102   void RemoveGroupWithContents( SMESH::SMESH_GroupBase_ptr theGroup )
103     throw (SALOME::SALOME_Exception);
104   
105   SMESH::ListOfGroups* GetGroups()
106     throw (SALOME::SALOME_Exception);
107
108   SMESH::SMESH_Group_ptr UnionGroups( SMESH::SMESH_GroupBase_ptr theGroup1, 
109                                       SMESH::SMESH_GroupBase_ptr theGroup2, 
110                                       const char* theName )
111     throw (SALOME::SALOME_Exception);
112   
113   SMESH::SMESH_Group_ptr IntersectGroups( SMESH::SMESH_GroupBase_ptr theGroup1, 
114                                           SMESH::SMESH_GroupBase_ptr theGroup2, 
115                                           const char* theName )
116     throw (SALOME::SALOME_Exception);
117   
118   SMESH::SMESH_Group_ptr CutGroups( SMESH::SMESH_GroupBase_ptr theGroup1, 
119                                     SMESH::SMESH_GroupBase_ptr theGroup2, 
120                                    const char* theName )
121     throw (SALOME::SALOME_Exception);
122
123 //    SMESH::string_array* GetLog(CORBA::Boolean clearAfterGet)
124 //      throw (SALOME::SALOME_Exception);
125
126   SMESH::log_array* GetLog(CORBA::Boolean clearAfterGet)
127     throw (SALOME::SALOME_Exception);
128
129   SMESH::SMESH_MeshEditor_ptr GetMeshEditor();
130
131   void ClearLog()
132     throw (SALOME::SALOME_Exception);
133
134   CORBA::Long GetId()
135     throw (SALOME::SALOME_Exception);
136
137   CORBA::Long GetStudyId()
138     throw (SALOME::SALOME_Exception);
139
140   // --- C++ interface
141   void SetImpl(::SMESH_Mesh* impl);
142   ::SMESH_Mesh& GetImpl();         // :: force no namespace here
143
144   SMESH_Gen_i* GetGen() { return _gen_i; }
145
146   int ImportUNVFile( const char* theFileName )
147     throw (SALOME::SALOME_Exception);
148
149   int ImportSTLFile( const char* theFileName )
150     throw (SALOME::SALOME_Exception);
151
152   /*!
153    * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
154    */
155   SMESH::DriverMED_ReadStatus ImportMEDFile( const char* theFileName, const char* theMeshName )
156     throw (SALOME::SALOME_Exception);
157
158   /*! Check group names for duplications.
159    *  Consider maximum group name length stored in MED file.
160    */
161   CORBA::Boolean HasDuplicatedGroupNamesMED();
162
163   void ExportToMED( const char* file, CORBA::Boolean auto_groups, SMESH::MED_VERSION theVersion )
164     throw (SALOME::SALOME_Exception);
165   void ExportMED( const char* file, CORBA::Boolean auto_groups )
166     throw (SALOME::SALOME_Exception);
167
168   void ExportDAT( const char* file )
169     throw (SALOME::SALOME_Exception);
170   void ExportUNV( const char* file )
171     throw (SALOME::SALOME_Exception);
172   void ExportSTL( const char* file, const bool isascii )
173     throw (SALOME::SALOME_Exception);
174
175   SALOME_MED::MESH_ptr GetMEDMesh()
176     throw (SALOME::SALOME_Exception);
177
178   CORBA::Long NbNodes()
179     throw (SALOME::SALOME_Exception);
180
181   CORBA::Long NbElements()
182     throw (SALOME::SALOME_Exception);
183
184   CORBA::Long NbEdges()
185     throw (SALOME::SALOME_Exception);
186
187   CORBA::Long NbEdgesOfOrder(SMESH::ElementOrder order)
188     throw (SALOME::SALOME_Exception);
189
190   CORBA::Long NbFaces()
191     throw (SALOME::SALOME_Exception);
192
193   CORBA::Long NbFacesOfOrder(SMESH::ElementOrder order)
194     throw (SALOME::SALOME_Exception);
195
196   CORBA::Long NbTriangles()
197     throw (SALOME::SALOME_Exception);
198
199   CORBA::Long NbTrianglesOfOrder(SMESH::ElementOrder order)
200     throw (SALOME::SALOME_Exception);
201
202   CORBA::Long NbQuadrangles()
203     throw (SALOME::SALOME_Exception);
204
205   CORBA::Long NbQuadranglesOfOrder(SMESH::ElementOrder order)
206     throw (SALOME::SALOME_Exception);
207
208   CORBA::Long NbPolygons()
209     throw (SALOME::SALOME_Exception);
210
211   CORBA::Long NbVolumes()
212     throw (SALOME::SALOME_Exception);
213
214   CORBA::Long NbVolumesOfOrder(SMESH::ElementOrder order)
215     throw (SALOME::SALOME_Exception);
216
217   CORBA::Long NbTetras()
218     throw (SALOME::SALOME_Exception);
219
220   CORBA::Long NbTetrasOfOrder(SMESH::ElementOrder order)
221     throw (SALOME::SALOME_Exception);
222
223   CORBA::Long NbHexas()
224     throw (SALOME::SALOME_Exception);
225
226   CORBA::Long NbHexasOfOrder(SMESH::ElementOrder order)
227     throw (SALOME::SALOME_Exception);
228
229   CORBA::Long NbPyramids()
230     throw (SALOME::SALOME_Exception);
231
232   CORBA::Long NbPyramidsOfOrder(SMESH::ElementOrder order)
233     throw (SALOME::SALOME_Exception);
234
235   CORBA::Long NbPrisms()
236     throw (SALOME::SALOME_Exception);
237
238   CORBA::Long NbPrismsOfOrder(SMESH::ElementOrder order)
239     throw (SALOME::SALOME_Exception);
240
241   CORBA::Long NbPolyhedrons()
242     throw (SALOME::SALOME_Exception);
243
244   CORBA::Long NbSubMesh()
245     throw (SALOME::SALOME_Exception);
246
247   SMESH::long_array* GetElementsId()
248     throw (SALOME::SALOME_Exception);
249
250   SMESH::long_array* GetElementsByType( SMESH::ElementType theElemType )
251     throw (SALOME::SALOME_Exception);
252   
253   SMESH::long_array* GetNodesId()
254     throw (SALOME::SALOME_Exception);
255   
256   SMESH::ElementType GetElementType( const CORBA::Long id, const bool iselem )
257     throw (SALOME::SALOME_Exception);
258   
259   /*!
260    * Returns ID of elements for given submesh
261    */
262   SMESH::long_array* GetSubMeshElementsId(const CORBA::Long ShapeID)
263     throw (SALOME::SALOME_Exception);
264
265   /*!
266    * Returns ID of nodes for given submesh
267    * If param all==true - returns all nodes, else -
268    * returns only nodes on shapes.
269    */
270   SMESH::long_array* GetSubMeshNodesId(const CORBA::Long ShapeID, CORBA::Boolean all)
271     throw (SALOME::SALOME_Exception);
272   
273   /*!
274    * Returns type of elements for given submesh
275    */
276   SMESH::ElementType GetSubMeshElementType(const CORBA::Long ShapeID)
277     throw (SALOME::SALOME_Exception);
278   
279   char* Dump();
280   
281   // Internal methods not available through CORBA
282   // They are called by corresponding interface methods
283   SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
284                                                     SMESH::SMESH_Hypothesis_ptr anHyp);
285
286   SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
287                                                        SMESH::SMESH_Hypothesis_ptr anHyp);
288   
289   int importMEDFile( const char* theFileName, const char* theMeshName );
290
291   SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
292
293   void removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
294                      GEOM::GEOM_Object_ptr theSubShapeObject );
295
296   SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType  theElemType,
297                                          const char*         theName,
298                                          const TopoDS_Shape& theShape = TopoDS_Shape());
299
300   void removeGroup( const int theId );
301
302   SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
303   // return an existing subMesh object for the shapeID. shapeID == submeshID.
304
305   const map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
306   // return an existing group object.
307
308   virtual SMESH::long_array* GetIDs();
309
310   CORBA::Long GetMeshPtr();
311
312
313   /*!
314    * Get XYZ coordinates of node as list of double
315    * If there is not node for given ID - returns empty list
316    */
317   SMESH::double_array* GetNodeXYZ(const CORBA::Long id);
318   
319   /*!
320    * For given node returns list of IDs of inverse elements
321    * If there is not node for given ID - returns empty list
322    */
323   SMESH::long_array* GetNodeInverseElements(const CORBA::Long id);
324
325   /*!
326    * If given element is node returns IDs of shape from position
327    * If there is not node for given ID - returns -1
328    */
329   CORBA::Long GetShapeID(const CORBA::Long id);
330
331   /*!
332    * For given element returns ID of result shape after 
333    * ::FindShape() from SMESH_MeshEditor
334    * If there is not element for given ID - returns -1
335    */
336   CORBA::Long GetShapeIDForElem(const CORBA::Long id);
337
338   /*!
339    * Returns number of nodes for given element
340    * If there is not element for given ID - returns -1
341    */
342   CORBA::Long GetElemNbNodes(const CORBA::Long id);
343
344   /*!
345    * Returns IDs of nodes of given element
346    */
347   SMESH::long_array* GetElemNodes(const CORBA::Long id);
348
349   /*!
350    * Returns ID of node by given index for given element
351    * If there is not element for given ID - returns -1
352    * If there is not node for given index - returns -2
353    */
354   CORBA::Long GetElemNode(const CORBA::Long id, const CORBA::Long index);
355   
356   /*!
357    * Returns true if given node is medium node
358    * in given quadratic element
359    */
360   CORBA::Boolean IsMediumNode(const CORBA::Long ide, const CORBA::Long idn);
361   
362   /*!
363    * Returns true if given node is medium node
364    * in one of quadratic elements
365    */
366   CORBA::Boolean IsMediumNodeOfAnyElem(const CORBA::Long idn,
367                                        SMESH::ElementType theElemType);
368   
369   /*!
370    * Returns number of edges for given element
371    */
372   CORBA::Long ElemNbEdges(const CORBA::Long id);
373   
374   /*!
375    * Returns number of faces for given element
376    */
377   CORBA::Long ElemNbFaces(const CORBA::Long id);
378   
379   /*!
380    * Returns true if given element is polygon
381    */
382   CORBA::Boolean IsPoly(const CORBA::Long id);
383   
384   /*!
385    * Returns true if given element is quadratic
386    */
387   CORBA::Boolean IsQuadratic(const CORBA::Long id);
388   
389   /*!
390    * Returns bary center for given element
391    */
392   SMESH::double_array* BaryCenter(const CORBA::Long id);
393
394
395   map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
396   map<int, ::SMESH_subMesh*> _mapSubMesh;   //NRI
397
398 private:
399   void CreateGroupServants();
400
401   static int myIdGenerator;
402   ::SMESH_Mesh* _impl;  // :: force no namespace here
403   SMESH_Gen_i* _gen_i;
404   int _id;          // id given by creator (unique within the creator instance)
405   int _studyId;
406   map<int, SMESH::SMESH_subMesh_ptr>    _mapSubMeshIor;
407   map<int, SMESH::SMESH_GroupBase_ptr>  _mapGroups;
408   map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
409 };
410
411 #endif
412