Salome HOME
Merge from BR_V5_IMP_P8
[modules/smesh.git] / src / SMESH_I / SMESH_Gen_i.hxx
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 SMESH_I : idl implementation based on 'SMESH' unit's calsses
23 //  File   : SMESH_Gen_i.hxx
24 //  Author : Paul RASCLE, EDF
25 //  Module : SMESH
26 //
27 #ifndef _SMESH_GEN_I_HXX_
28 #define _SMESH_GEN_I_HXX_
29
30 #include "SMESH.hxx"
31
32 #include <SALOMEconfig.h>
33 #include CORBA_SERVER_HEADER(SMESH_Gen)
34 #include CORBA_SERVER_HEADER(SMESH_Mesh)
35 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
36 #include CORBA_CLIENT_HEADER(GEOM_Gen)
37 #include CORBA_CLIENT_HEADER(SALOMEDS)
38 #include CORBA_CLIENT_HEADER(SALOMEDS_Attributes)
39
40 #include "SMESH_Mesh_i.hxx"
41 #include "SMESH_Hypothesis_i.hxx"
42 #include "SALOME_Component_i.hxx"
43 #include "SALOME_NamingService.hxx"
44
45 #include "SMESH_Gen.hxx"
46 #include "GEOM_Client.hxx"
47
48 #include <TCollection_AsciiString.hxx>
49 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
50 #include <TColStd_HSequenceOfAsciiString.hxx>
51
52 #include <map>
53 #include <sstream>
54
55 class SMESH_Mesh_i;
56 class SALOME_LifeCycleCORBA;
57
58 // ===========================================================
59 // Study context - stores study-connected objects references
60 // ==========================================================
61 class SMESH_I_EXPORT StudyContext
62 {
63 public:
64   // constructor
65   StudyContext() {}
66   // destructor
67   ~StudyContext() 
68   { 
69     mapIdToIOR.clear();
70     mapIdToId.clear();
71   }
72   // register object in the internal map and return its id
73   int addObject( string theIOR )
74   {
75     int nextId = getNextId();
76     mapIdToIOR[ nextId ]  = theIOR;
77     return nextId;
78   }
79   // find the object id in the internal map by the IOR
80   int findId( string theIOR )
81   {
82     map<int, string>::iterator imap;
83     for ( imap = mapIdToIOR.begin(); imap != mapIdToIOR.end(); ++imap ) {
84       if ( imap->second == theIOR )
85         return imap->first;
86     }
87     return 0;
88   }
89   // get object's IOR by id
90   string getIORbyId( const int theId )
91   {
92     if ( mapIdToIOR.find( theId ) != mapIdToIOR.end() )
93       return mapIdToIOR[ theId ];
94     return string( "" );
95   }
96   // get object's IOR by old id
97   string getIORbyOldId( const int theOldId )
98   {
99     if ( mapIdToId.find( theOldId ) != mapIdToId.end() )
100       return getIORbyId( mapIdToId[ theOldId ] );
101     return string( "" );
102   }
103   // maps old object id to the new one (used when restoring data)
104   void mapOldToNew( const int oldId, const int newId ) {
105     mapIdToId[ oldId ] = newId;
106   }
107   // get old id by a new one
108   int getOldId( const int newId ) {
109     map<int, int>::iterator imap;
110     for ( imap = mapIdToId.begin(); imap != mapIdToId.end(); ++imap ) {
111       if ( imap->second == newId )
112         return imap->first;
113     }
114     return 0;
115   }
116     
117 private:
118   // get next free object identifier
119   int getNextId()
120   {
121     int id = 1;
122     while( mapIdToIOR.find( id ) != mapIdToIOR.end() )
123       id++;
124     return id;
125   }
126
127   map<int, string> mapIdToIOR;      // persistent-to-transient map
128   map<int, int>    mapIdToId;       // used to translate object from persistent to transient form
129 };
130
131 // ===========================================================
132 // SMESH module's engine
133 // ==========================================================
134 class SMESH_I_EXPORT SMESH_Gen_i:
135   public virtual POA_SMESH::SMESH_Gen,
136   public virtual Engines_Component_i 
137 {
138 public:
139   // Get last created instance of the class
140   static SMESH_Gen_i* GetSMESHGen() { return mySMESHGen;}
141   // Get ORB object
142   static CORBA::ORB_var GetORB() { return myOrb;}
143   // Get SMESH module's POA object
144   static PortableServer::POA_var GetPOA() { return myPoa;}
145   // Get Naming Service object
146   static SALOME_NamingService* GetNS();
147   // Get SALOME_LifeCycleCORBA object
148   static SALOME_LifeCycleCORBA* GetLCC();
149   // Retrieve and get GEOM engine reference
150   static GEOM::GEOM_Gen_ptr GetGeomEngine();
151   // Get object of the CORBA reference
152   static PortableServer::ServantBase_var GetServant( CORBA::Object_ptr theObject );
153   // Get CORBA object corresponding to the SALOMEDS::SObject
154   static CORBA::Object_var SObjectToObject( SALOMEDS::SObject_ptr theSObject );
155   // Get the SALOMEDS::SObject corresponding to a CORBA object
156   static SALOMEDS::SObject_ptr ObjectToSObject(SALOMEDS::Study_ptr theStudy,
157                                                CORBA::Object_ptr   theObject);
158   // Get GEOM Object correspoding to TopoDS_Shape
159   GEOM::GEOM_Object_ptr ShapeToGeomObject (const TopoDS_Shape& theShape );
160   // Get TopoDS_Shape correspoding to GEOM_Object
161   TopoDS_Shape GeomObjectToShape(GEOM::GEOM_Object_ptr theGeomObject);
162   
163   // Default constructor
164   SMESH_Gen_i();
165   // Standard constructor
166   SMESH_Gen_i( CORBA::ORB_ptr            orb,
167                PortableServer::POA_ptr   poa,
168                PortableServer::ObjectId* contId, 
169                const char*               instanceName, 
170                const char*               interfaceName );
171   // Destructor
172   virtual ~SMESH_Gen_i();
173
174   // *****************************************
175   // Interface methods
176   // *****************************************
177   // Set a new Mesh object name
178   void SetName(const char* theIOR,
179                const char* theName);
180
181   //GEOM::GEOM_Gen_ptr SetGeomEngine( const char* containerLoc );
182   void SetGeomEngine( GEOM::GEOM_Gen_ptr geomcompo );
183
184   // Set current study
185   void SetEmbeddedMode( CORBA::Boolean theMode );
186   // Get current study
187   CORBA::Boolean IsEmbeddedMode();
188
189   // Set current study
190   void SetCurrentStudy( SALOMEDS::Study_ptr theStudy );
191   // Get current study
192   SALOMEDS::Study_ptr GetCurrentStudy();
193
194   // Create hypothesis/algorothm of given type
195   SMESH::SMESH_Hypothesis_ptr CreateHypothesis (const char* theHypType,
196                                                 const char* theLibName)
197     throw ( SALOME::SALOME_Exception );
198   
199   // Return hypothesis of given type holding parameter values of the existing mesh
200   SMESH::SMESH_Hypothesis_ptr GetHypothesisParameterValues (const char*           theHypType,
201                                                             const char*           theLibName,
202                                                             SMESH::SMESH_Mesh_ptr theMesh,
203                                                             GEOM::GEOM_Object_ptr theGeom,
204                                                             CORBA::Boolean        byMesh)
205     throw ( SALOME::SALOME_Exception );
206   
207   /*!
208    * Sets number of segments per diagonal of boundary box of geometry by which
209    * default segment length of appropriate 1D hypotheses is defined
210    */
211   void SetBoundaryBoxSegmentation( CORBA::Long theNbSegments );
212
213   // Create empty mesh on a shape
214   SMESH::SMESH_Mesh_ptr CreateMesh( GEOM::GEOM_Object_ptr theShapeObject )
215     throw ( SALOME::SALOME_Exception );
216
217   // Create empty mesh
218   SMESH::SMESH_Mesh_ptr CreateEmptyMesh()
219     throw ( SALOME::SALOME_Exception );
220
221   //  Create mesh(es) and import data from UNV file
222   SMESH::SMESH_Mesh_ptr CreateMeshesFromUNV( const char* theFileName )
223     throw ( SALOME::SALOME_Exception );
224
225   //  Create mesh(es) and import data from MED file
226   SMESH::mesh_array* CreateMeshesFromMED( const char* theFileName,
227                                           SMESH::DriverMED_ReadStatus& theStatus )
228     throw ( SALOME::SALOME_Exception );
229
230   //  Create mesh(es) and import data from STL file
231   SMESH::SMESH_Mesh_ptr CreateMeshesFromSTL( const char* theFileName )
232     throw ( SALOME::SALOME_Exception );
233
234   // Compute mesh on a shape
235   CORBA::Boolean Compute( SMESH::SMESH_Mesh_ptr theMesh,
236                           GEOM::GEOM_Object_ptr theShapeObject )
237     throw ( SALOME::SALOME_Exception );
238   /*!
239    * \brief Return errors of mesh computation
240    */
241   SMESH::compute_error_array* GetComputeErrors(SMESH::SMESH_Mesh_ptr theMesh,
242                                                GEOM::GEOM_Object_ptr  theShapeObject )
243     throw ( SALOME::SALOME_Exception );
244
245   // Returns true if mesh contains enough data to be computed
246   CORBA::Boolean IsReadyToCompute( SMESH::SMESH_Mesh_ptr theMesh,
247                                    GEOM::GEOM_Object_ptr theShapeObject )
248     throw ( SALOME::SALOME_Exception );
249   
250   /*!
251    * Calculate Mesh as preview till indicated dimension on shape
252    * First, verify list of hypothesis associated with the subShape.
253    * Return mesh preview structure
254    */
255   SMESH::MeshPreviewStruct* Precompute( SMESH::SMESH_Mesh_ptr theMesh,
256                                         GEOM::GEOM_Object_ptr theSubObject,
257                                         SMESH::Dimension      theDimension,
258                                         SMESH::long_array&    theShapesId )
259     throw ( SALOME::SALOME_Exception );
260
261   // Returns errors of hypotheses definintion
262   SMESH::algo_error_array* GetAlgoState( SMESH::SMESH_Mesh_ptr theMesh, 
263                                          GEOM::GEOM_Object_ptr theSubObject )
264       throw ( SALOME::SALOME_Exception );
265
266   // Return mesh elements preventing computation of a subshape
267   SMESH::MeshPreviewStruct* GetBadInputElements( SMESH::SMESH_Mesh_ptr theMesh,
268                                                  CORBA::Short          theSubShapeID )
269     throw ( SALOME::SALOME_Exception );
270
271   // Get sub-shapes unique ID's list
272   SMESH::long_array* GetSubShapesId( GEOM::GEOM_Object_ptr      theMainShapeObject,
273                                      const SMESH::object_array& theListOfSubShape )
274     throw ( SALOME::SALOME_Exception );
275
276   // Return geometrical object the given element is built on. Publish it in study.
277   GEOM::GEOM_Object_ptr GetGeometryByMeshElement( SMESH::SMESH_Mesh_ptr  theMesh,
278                                                   CORBA::Long            theElementID,
279                                                   const char*            theGeomName)
280     throw ( SALOME::SALOME_Exception );
281
282   // Return geometrical object the given element is built on. Don't publish it in study.
283   GEOM::GEOM_Object_ptr FindGeometryByMeshElement( SMESH::SMESH_Mesh_ptr  theMesh,
284                                                    CORBA::Long            theElementID)
285     throw ( SALOME::SALOME_Exception );
286
287   // Concatenate the given meshes into one mesh
288   SMESH::SMESH_Mesh_ptr ConcatenateCommon(const SMESH::mesh_array& theMeshesArray, 
289                                           CORBA::Boolean           theUniteIdenticalGroups, 
290                                           CORBA::Boolean           theMergeNodesAndElements, 
291                                           CORBA::Double            theMergeTolerance,
292                                           CORBA::Boolean           theCommonGroups)
293     throw ( SALOME::SALOME_Exception );
294
295   // Concatenate the given meshes into one mesh
296   SMESH::SMESH_Mesh_ptr Concatenate(const SMESH::mesh_array& theMeshesArray, 
297                                     CORBA::Boolean           theUniteIdenticalGroups, 
298                                     CORBA::Boolean           theMergeNodesAndElements, 
299                                     CORBA::Double            theMergeTolerance)
300     throw ( SALOME::SALOME_Exception );
301
302   // Concatenate the given meshes into one mesh
303   // Create the groups of all elements from initial meshes
304   SMESH::SMESH_Mesh_ptr ConcatenateWithGroups(const SMESH::mesh_array& theMeshesArray, 
305                                               CORBA::Boolean           theUniteIdenticalGroups, 
306                                               CORBA::Boolean           theMergeNodesAndElements, 
307                                               CORBA::Double            theMergeTolerance)
308     throw ( SALOME::SALOME_Exception );
309
310   // ****************************************************
311   // Interface inherited methods (from SALOMEDS::Driver)
312   // ****************************************************
313
314   // Save SMESH data
315   SALOMEDS::TMPFile* Save( SALOMEDS::SComponent_ptr theComponent,
316                          const char*              theURL,
317                          bool                     isMultiFile );
318   // Load SMESH data
319   bool Load( SALOMEDS::SComponent_ptr theComponent,
320              const SALOMEDS::TMPFile& theStream,
321              const char*              theURL,
322              bool                     isMultiFile );
323   // Save SMESH data in ASCII format
324   SALOMEDS::TMPFile* SaveASCII( SALOMEDS::SComponent_ptr theComponent,
325                                 const char*              theURL,
326                                 bool                     isMultiFile );
327   // Load SMESH data in ASCII format
328   bool LoadASCII( SALOMEDS::SComponent_ptr theComponent,
329                   const SALOMEDS::TMPFile& theStream,
330                   const char*              theURL,
331                   bool                     isMultiFile );
332
333   // Create filter manager
334   SMESH::FilterManager_ptr CreateFilterManager();
335
336   // Return a pattern mesher
337   SMESH::SMESH_Pattern_ptr GetPattern();
338
339   // Clears study-connected data when it is closed
340   void Close( SALOMEDS::SComponent_ptr theComponent );
341   
342   // Get component data type
343   char* ComponentDataType();
344     
345   // Transform data from transient form to persistent
346   char* IORToLocalPersistentID( SALOMEDS::SObject_ptr theSObject,
347                                 const char*           IORString,
348                                 CORBA::Boolean        isMultiFile,
349                                 CORBA::Boolean        isASCII );
350   // Transform data from persistent form to transient
351   char* LocalPersistentIDToIOR( SALOMEDS::SObject_ptr theSObject,
352                                 const char*           aLocalPersistentID,
353                                 CORBA::Boolean        isMultiFile,
354                                 CORBA::Boolean        isASCII );
355
356   // Returns true if object can be published in the study
357   bool CanPublishInStudy( CORBA::Object_ptr theIOR );
358   // Publish object in the study
359   SALOMEDS::SObject_ptr PublishInStudy( SALOMEDS::Study_ptr   theStudy,
360                                         SALOMEDS::SObject_ptr theSObject,
361                                         CORBA::Object_ptr     theObject,
362                                         const char*           theName ) 
363     throw ( SALOME::SALOME_Exception );
364
365   // Copy-paste methods - returns true if object can be copied to the clipboard
366   CORBA::Boolean CanCopy( SALOMEDS::SObject_ptr theObject ) { return false; }
367   // Copy-paste methods - copy object to the clipboard
368   SALOMEDS::TMPFile* CopyFrom( SALOMEDS::SObject_ptr theObject, CORBA::Long& theObjectID ) { return false; }
369   // Copy-paste methods - returns true if object can be pasted from the clipboard
370   CORBA::Boolean CanPaste( const char* theComponentName, CORBA::Long theObjectID ) { return false; }
371   // Copy-paste methods - paste object from the clipboard
372   SALOMEDS::SObject_ptr PasteInto( const SALOMEDS::TMPFile& theStream,
373                                    CORBA::Long              theObjectID,
374                                    SALOMEDS::SObject_ptr    theObject ) {
375     SALOMEDS::SObject_var aResultSO;
376     return aResultSO._retn();
377   }
378
379   // ============
380   // Dump python
381   // ============
382
383   virtual Engines::TMPFile* DumpPython(CORBA::Object_ptr theStudy, 
384                                        CORBA::Boolean isPublished, 
385                                        CORBA::Boolean& isValidScript);
386
387   void AddToPythonScript (int theStudyID, const TCollection_AsciiString& theString);
388
389   void RemoveLastFromPythonScript (int theStudyID);
390
391   void SavePython (SALOMEDS::Study_ptr theStudy);
392
393   TCollection_AsciiString DumpPython_impl (SALOMEDS::Study_ptr theStudy, 
394                                            Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
395                                            Resource_DataMapOfAsciiStringAsciiString& theNames,
396                                            bool isPublished, 
397                                            bool& aValidScript,
398                                            const TCollection_AsciiString& theSavedTrace);
399
400   TCollection_AsciiString GetNewPythonLines (int theStudyID);
401
402   void CleanPythonTrace (int theStudyID);
403
404
405   // *****************************************
406   // Internal methods
407   // *****************************************
408 public:
409   // Get shape reader
410   GEOM_Client* GetShapeReader();
411
412   // Tags definition 
413   static long GetHypothesisRootTag();
414   static long GetAlgorithmsRootTag();
415   static long GetRefOnShapeTag();
416   static long GetRefOnAppliedHypothesisTag();
417   static long GetRefOnAppliedAlgorithmsTag();
418   static long GetSubMeshOnVertexTag();
419   static long GetSubMeshOnEdgeTag();
420   static long GetSubMeshOnFaceTag();
421   static long GetSubMeshOnSolidTag();
422   static long GetSubMeshOnCompoundTag();
423   static long GetSubMeshOnWireTag();
424   static long GetSubMeshOnShellTag();
425   static long GetNodeGroupsTag();
426   static long GetEdgeGroupsTag();
427   static long GetFaceGroupsTag();
428   static long GetVolumeGroupsTag();
429
430   // publishing methods
431   SALOMEDS::SComponent_ptr PublishComponent(SALOMEDS::Study_ptr theStudy);
432   SALOMEDS::SObject_ptr PublishMesh (SALOMEDS::Study_ptr   theStudy,
433                                      SMESH::SMESH_Mesh_ptr theMesh,
434                                      const char*           theName = 0);
435   SALOMEDS::SObject_ptr PublishHypothesis (SALOMEDS::Study_ptr         theStudy,
436                                            SMESH::SMESH_Hypothesis_ptr theHyp,
437                                            const char*                 theName = 0);
438   SALOMEDS::SObject_ptr PublishSubMesh (SALOMEDS::Study_ptr      theStudy,
439                                         SMESH::SMESH_Mesh_ptr    theMesh,
440                                         SMESH::SMESH_subMesh_ptr theSubMesh,
441                                         GEOM::GEOM_Object_ptr    theShapeObject,
442                                         const char*              theName = 0);
443   SALOMEDS::SObject_ptr PublishGroup (SALOMEDS::Study_ptr    theStudy,
444                                       SMESH::SMESH_Mesh_ptr  theMesh,
445                                       SMESH::SMESH_GroupBase_ptr theGroup,
446                                       GEOM::GEOM_Object_ptr  theShapeObject,
447                                       const char*            theName = 0);
448   bool AddHypothesisToShape(SALOMEDS::Study_ptr         theStudy,
449                             SMESH::SMESH_Mesh_ptr       theMesh,
450                             GEOM::GEOM_Object_ptr       theShapeObject,
451                             SMESH::SMESH_Hypothesis_ptr theHyp);
452   bool RemoveHypothesisFromShape(SALOMEDS::Study_ptr         theStudy,
453                                  SMESH::SMESH_Mesh_ptr       theMesh,
454                                  GEOM::GEOM_Object_ptr       theShapeObject,
455                                  SMESH::SMESH_Hypothesis_ptr theHyp);
456   SALOMEDS::SObject_ptr GetMeshOrSubmeshByShape (SALOMEDS::Study_ptr   theStudy,
457                                                  SMESH::SMESH_Mesh_ptr theMesh,
458                                                  GEOM::GEOM_Object_ptr theShape);
459   static void SetName(SALOMEDS::SObject_ptr theSObject,
460                       const char*           theName,
461                       const char*           theDefaultName = 0);
462
463   //  Get study context
464   StudyContext* GetCurrentStudyContext();
465
466   // Register an object in a StudyContext; return object id
467   int RegisterObject(CORBA::Object_ptr theObject);
468
469   // Return id of registered object
470   CORBA::Long GetObjectId(CORBA::Object_ptr theObject);
471
472   // Return an object that previously had an oldID
473   template<class TInterface> 
474   typename TInterface::_var_type GetObjectByOldId( const int oldID )
475   {
476     if ( StudyContext* myStudyContext = GetCurrentStudyContext() ) {
477       string ior = myStudyContext->getIORbyOldId( oldID );
478       if ( !ior.empty() )
479         return TInterface::_narrow(GetORB()->string_to_object( ior.c_str() ));
480     }
481     return TInterface::_nil();
482   }
483
484   // Get current study ID
485   int GetCurrentStudyID()
486   { return myCurrentStudy->_is_nil() ? -1 : myCurrentStudy->StudyId(); }
487
488   /*!
489    * \brief Find SObject for an algo
490    */
491   SALOMEDS::SObject_ptr GetAlgoSO(const ::SMESH_Algo* algo);
492  
493 private:
494   // Create hypothesis of given type
495   SMESH::SMESH_Hypothesis_ptr createHypothesis( const char* theHypName,
496                                                 const char* theLibName)
497     throw ( SALOME::SALOME_Exception );
498   
499   // Create empty mesh on shape
500   SMESH::SMESH_Mesh_ptr createMesh()
501     throw ( SALOME::SALOME_Exception );
502
503   static void loadGeomData( SALOMEDS::SComponent_ptr theCompRoot );
504   
505 private:
506   static GEOM::GEOM_Gen_var      myGeomGen;
507   static CORBA::ORB_var          myOrb;         // ORB reference
508   static PortableServer::POA_var myPoa;         // POA reference
509   static SALOME_NamingService*   myNS;          // Naming Service
510   static SALOME_LifeCycleCORBA*  myLCC;         // Life Cycle CORBA
511   static SMESH_Gen_i*            mySMESHGen;    // Point to last created instance of the class
512   ::SMESH_Gen               myGen;              // SMESH_Gen local implementation
513
514   // hypotheses managing
515   map<string, GenericHypothesisCreator_i*> myHypCreatorMap;
516
517   map<int, StudyContext*>   myStudyContextMap;  // Map of study context objects
518
519   GEOM_Client*              myShapeReader;      // Shape reader
520   SALOMEDS::Study_var       myCurrentStudy;     // Current study
521   CORBA::Boolean            myIsEmbeddedMode;   // Current mode
522
523   // Dump Python: trace of API methods calls
524   std::map < int, Handle(TColStd_HSequenceOfAsciiString) > myPythonScripts;
525 };
526
527
528 namespace SMESH
529 {
530   template<class T>
531   T
532   DownCast(CORBA::Object_ptr theArg)
533   {
534     return dynamic_cast<T>(SMESH_Gen_i::GetServant(theArg).in());
535   }
536 }
537
538
539 #endif