1 // Copyright (C) 2007-2011 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : SMESH_Gen_i.hxx
23 // Author : Paul RASCLE, EDF
26 #ifndef _SMESH_GEN_I_HXX_
27 #define _SMESH_GEN_I_HXX_
31 #include <SALOMEconfig.h>
32 #include CORBA_SERVER_HEADER(SMESH_Gen)
33 #include CORBA_SERVER_HEADER(SMESH_Mesh)
34 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
35 #include CORBA_CLIENT_HEADER(GEOM_Gen)
36 #include CORBA_CLIENT_HEADER(SALOMEDS)
37 #include CORBA_CLIENT_HEADER(SALOMEDS_Attributes)
39 #include "SMESH_Mesh_i.hxx"
40 #include "SMESH_Hypothesis_i.hxx"
41 #include "SALOME_Component_i.hxx"
42 #include "SALOME_NamingService.hxx"
44 #include "SMESH_Gen.hxx"
45 #include "GEOM_Client.hxx"
47 #include <TCollection_AsciiString.hxx>
48 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
49 #include <TColStd_HSequenceOfAsciiString.hxx>
55 class SALOME_LifeCycleCORBA;
57 // ===========================================================
58 // Study context - stores study-connected objects references
59 // ==========================================================
60 class SMESH_I_EXPORT StudyContext
71 // register object in the internal map and return its id
72 int addObject( string theIOR )
74 int nextId = getNextId();
75 mapIdToIOR[ nextId ] = theIOR;
78 // find the object id in the internal map by the IOR
79 int findId( string theIOR )
81 map<int, string>::iterator imap;
82 for ( imap = mapIdToIOR.begin(); imap != mapIdToIOR.end(); ++imap ) {
83 if ( imap->second == theIOR )
88 // get object's IOR by id
89 string getIORbyId( const int theId )
91 if ( mapIdToIOR.find( theId ) != mapIdToIOR.end() )
92 return mapIdToIOR[ theId ];
95 // get object's IOR by old id
96 string getIORbyOldId( const int theOldId )
98 if ( mapIdToId.find( theOldId ) != mapIdToId.end() )
99 return getIORbyId( mapIdToId[ theOldId ] );
102 // maps old object id to the new one (used when restoring data)
103 void mapOldToNew( const int oldId, const int newId ) {
104 mapIdToId[ oldId ] = newId;
106 // get old id by a new one
107 int getOldId( const int newId ) {
108 map<int, int>::iterator imap;
109 for ( imap = mapIdToId.begin(); imap != mapIdToId.end(); ++imap ) {
110 if ( imap->second == newId )
117 // get next free object identifier
121 while( mapIdToIOR.find( id ) != mapIdToIOR.end() )
126 map<int, string> mapIdToIOR; // persistent-to-transient map
127 map<int, int> mapIdToId; // used to translate object from persistent to transient form
130 // ===========================================================
131 // SMESH module's engine
132 // ==========================================================
133 class SMESH_I_EXPORT SMESH_Gen_i:
134 public virtual POA_SMESH::SMESH_Gen,
135 public virtual Engines_Component_i
138 // Get last created instance of the class
139 static SMESH_Gen_i* GetSMESHGen() { return mySMESHGen;}
141 static CORBA::ORB_var GetORB() { return myOrb;}
142 // Get SMESH module's POA object
143 static PortableServer::POA_var GetPOA() { return myPoa;}
144 // Get Naming Service object
145 static SALOME_NamingService* GetNS();
146 // Get SALOME_LifeCycleCORBA object
147 static SALOME_LifeCycleCORBA* GetLCC();
148 // Retrieve and get GEOM engine reference
149 static GEOM::GEOM_Gen_ptr GetGeomEngine();
150 // Get object of the CORBA reference
151 static PortableServer::ServantBase_var GetServant( CORBA::Object_ptr theObject );
152 // Get CORBA object corresponding to the SALOMEDS::SObject
153 static CORBA::Object_var SObjectToObject( SALOMEDS::SObject_ptr theSObject );
154 // Get the SALOMEDS::SObject corresponding to a CORBA object
155 static SALOMEDS::SObject_ptr ObjectToSObject(SALOMEDS::Study_ptr theStudy,
156 CORBA::Object_ptr theObject);
157 // Get GEOM Object correspoding to TopoDS_Shape
158 GEOM::GEOM_Object_ptr ShapeToGeomObject (const TopoDS_Shape& theShape );
159 // Get TopoDS_Shape correspoding to GEOM_Object
160 TopoDS_Shape GeomObjectToShape(GEOM::GEOM_Object_ptr theGeomObject);
162 // Default constructor
164 // Standard constructor
165 SMESH_Gen_i( CORBA::ORB_ptr orb,
166 PortableServer::POA_ptr poa,
167 PortableServer::ObjectId* contId,
168 const char* instanceName,
169 const char* interfaceName );
171 virtual ~SMESH_Gen_i();
173 // *****************************************
175 // *****************************************
176 // Set a new Mesh object name
177 void SetName(const char* theIOR,
178 const char* theName);
180 //GEOM::GEOM_Gen_ptr SetGeomEngine( const char* containerLoc );
181 void SetGeomEngine( GEOM::GEOM_Gen_ptr geomcompo );
184 void SetEmbeddedMode( CORBA::Boolean theMode );
186 CORBA::Boolean IsEmbeddedMode();
189 void SetCurrentStudy( SALOMEDS::Study_ptr theStudy );
191 SALOMEDS::Study_ptr GetCurrentStudy();
193 // Create hypothesis/algorothm of given type
194 SMESH::SMESH_Hypothesis_ptr CreateHypothesis (const char* theHypType,
195 const char* theLibName)
196 throw ( SALOME::SALOME_Exception );
198 // Return hypothesis of given type holding parameter values of the existing mesh
199 SMESH::SMESH_Hypothesis_ptr GetHypothesisParameterValues (const char* theHypType,
200 const char* theLibName,
201 SMESH::SMESH_Mesh_ptr theMesh,
202 GEOM::GEOM_Object_ptr theGeom,
203 CORBA::Boolean byMesh)
204 throw ( SALOME::SALOME_Exception );
209 * Sets number of segments per diagonal of boundary box of geometry by which
210 * default segment length of appropriate 1D hypotheses is defined
212 void SetBoundaryBoxSegmentation( CORBA::Long theNbSegments ) throw ( SALOME::SALOME_Exception );
214 * \brief Sets default number of segments per edge
216 void SetDefaultNbSegments(CORBA::Long theNbSegments) throw ( SALOME::SALOME_Exception );
221 virtual void SetOption(const char*, const char*);
223 Return an option value
225 virtual char* GetOption(const char*);
228 * To load full mesh data from study at hyp modification or not
230 bool ToForgetMeshDataOnHypModif() const { return myToForgetMeshDataOnHypModif; }
233 // Create empty mesh on a shape
234 SMESH::SMESH_Mesh_ptr CreateMesh( GEOM::GEOM_Object_ptr theShapeObject )
235 throw ( SALOME::SALOME_Exception );
238 SMESH::SMESH_Mesh_ptr CreateEmptyMesh()
239 throw ( SALOME::SALOME_Exception );
241 // Create mesh(es) and import data from UNV fileter
242 SMESH::SMESH_Mesh_ptr CreateMeshesFromUNV( const char* theFileName )
243 throw ( SALOME::SALOME_Exception );
245 // Create mesh(es) and import data from MED file
246 SMESH::mesh_array* CreateMeshesFromMED( const char* theFileName,
247 SMESH::DriverMED_ReadStatus& theStatus )
248 throw ( SALOME::SALOME_Exception );
250 // Create mesh(es) and import data from MED file
251 SMESH::mesh_array* CreateMeshesFromSAUV( const char* theFileName,
252 SMESH::DriverMED_ReadStatus& theStatus )
253 throw ( SALOME::SALOME_Exception );
255 // Create mesh(es) and import data from STL file
256 SMESH::SMESH_Mesh_ptr CreateMeshesFromSTL( const char* theFileName )
257 throw ( SALOME::SALOME_Exception );
259 // Create mesh(es) and import data from CGNS file
260 SMESH::mesh_array* CreateMeshesFromCGNS( const char* theFileName,
261 SMESH::DriverMED_ReadStatus& theStatus )
262 throw ( SALOME::SALOME_Exception );
264 // Copy a part of mesh
265 SMESH::SMESH_Mesh_ptr CopyMesh(SMESH::SMESH_IDSource_ptr meshPart,
266 const char* meshName,
267 CORBA::Boolean toCopyGroups,
268 CORBA::Boolean toKeepIDs);
270 // Compute mesh on a shape
271 CORBA::Boolean Compute( SMESH::SMESH_Mesh_ptr theMesh,
272 GEOM::GEOM_Object_ptr theShapeObject )
273 throw ( SALOME::SALOME_Exception );
275 // Cancel Compute mesh on a shape
276 void CancelCompute( SMESH::SMESH_Mesh_ptr theMesh,
277 GEOM::GEOM_Object_ptr theShapeObject );
280 * \brief Return errors of mesh computation
282 SMESH::compute_error_array* GetComputeErrors(SMESH::SMESH_Mesh_ptr theMesh,
283 GEOM::GEOM_Object_ptr theShapeObject )
284 throw ( SALOME::SALOME_Exception );
287 * Evaluate mesh on a shape and
288 * returns statistic of mesh elements
289 * Result array of number enityties
291 SMESH::long_array* Evaluate(SMESH::SMESH_Mesh_ptr theMesh,
292 GEOM::GEOM_Object_ptr theShapeObject)
293 throw ( SALOME::SALOME_Exception );
295 // Returns true if mesh contains enough data to be computed
296 CORBA::Boolean IsReadyToCompute( SMESH::SMESH_Mesh_ptr theMesh,
297 GEOM::GEOM_Object_ptr theShapeObject )
298 throw ( SALOME::SALOME_Exception );
301 * Calculate Mesh as preview till indicated dimension on shape
302 * First, verify list of hypothesis associated with the subShape.
303 * Return mesh preview structure
305 SMESH::MeshPreviewStruct* Precompute( SMESH::SMESH_Mesh_ptr theMesh,
306 GEOM::GEOM_Object_ptr theSubObject,
307 SMESH::Dimension theDimension,
308 SMESH::long_array& theShapesId )
309 throw ( SALOME::SALOME_Exception );
311 // Returns errors of hypotheses definintion
312 SMESH::algo_error_array* GetAlgoState( SMESH::SMESH_Mesh_ptr theMesh,
313 GEOM::GEOM_Object_ptr theSubObject )
314 throw ( SALOME::SALOME_Exception );
316 // Return mesh elements preventing computation of a subshape
317 SMESH::MeshPreviewStruct* GetBadInputElements( SMESH::SMESH_Mesh_ptr theMesh,
318 CORBA::Short theSubShapeID )
319 throw ( SALOME::SALOME_Exception );
321 // Get sub-shapes unique ID's list
322 SMESH::long_array* GetSubShapesId( GEOM::GEOM_Object_ptr theMainShapeObject,
323 const SMESH::object_array& theListOfSubShape )
324 throw ( SALOME::SALOME_Exception );
326 // Return geometrical object the given element is built on. Publish it in study.
327 GEOM::GEOM_Object_ptr GetGeometryByMeshElement( SMESH::SMESH_Mesh_ptr theMesh,
328 CORBA::Long theElementID,
329 const char* theGeomName)
330 throw ( SALOME::SALOME_Exception );
332 // Return geometrical object the given element is built on. Don't publish it in study.
333 GEOM::GEOM_Object_ptr FindGeometryByMeshElement( SMESH::SMESH_Mesh_ptr theMesh,
334 CORBA::Long theElementID)
335 throw ( SALOME::SALOME_Exception );
337 // Concatenate the given meshes into one mesh
338 SMESH::SMESH_Mesh_ptr ConcatenateCommon(const SMESH::mesh_array& theMeshesArray,
339 CORBA::Boolean theUniteIdenticalGroups,
340 CORBA::Boolean theMergeNodesAndElements,
341 CORBA::Double theMergeTolerance,
342 CORBA::Boolean theCommonGroups)
343 throw ( SALOME::SALOME_Exception );
345 // Concatenate the given meshes into one mesh
346 SMESH::SMESH_Mesh_ptr Concatenate(const SMESH::mesh_array& theMeshesArray,
347 CORBA::Boolean theUniteIdenticalGroups,
348 CORBA::Boolean theMergeNodesAndElements,
349 CORBA::Double theMergeTolerance)
350 throw ( SALOME::SALOME_Exception );
352 // Concatenate the given meshes into one mesh
353 // Create the groups of all elements from initial meshes
354 SMESH::SMESH_Mesh_ptr ConcatenateWithGroups(const SMESH::mesh_array& theMeshesArray,
355 CORBA::Boolean theUniteIdenticalGroups,
356 CORBA::Boolean theMergeNodesAndElements,
357 CORBA::Double theMergeTolerance)
358 throw ( SALOME::SALOME_Exception );
360 // Get MED version of the file by its name
361 CORBA::Boolean GetMEDVersion(const char* theFileName,
362 SMESH::MED_VERSION& theVersion);
364 // Get names of meshes defined in file with the specified name
365 SMESH::string_array* GetMeshNames(const char* theFileName);
367 // ****************************************************
368 // Interface inherited methods (from SALOMEDS::Driver)
369 // ****************************************************
372 SALOMEDS::TMPFile* Save( SALOMEDS::SComponent_ptr theComponent,
376 bool Load( SALOMEDS::SComponent_ptr theComponent,
377 const SALOMEDS::TMPFile& theStream,
380 // Save SMESH data in ASCII format
381 SALOMEDS::TMPFile* SaveASCII( SALOMEDS::SComponent_ptr theComponent,
384 // Load SMESH data in ASCII format
385 bool LoadASCII( SALOMEDS::SComponent_ptr theComponent,
386 const SALOMEDS::TMPFile& theStream,
390 // Create filter manager
391 SMESH::FilterManager_ptr CreateFilterManager();
393 // Return a pattern mesher
394 SMESH::SMESH_Pattern_ptr GetPattern();
396 // Create measurement instance
397 SMESH::Measurements_ptr CreateMeasurements();
399 // Clears study-connected data when it is closed
400 void Close( SALOMEDS::SComponent_ptr theComponent );
402 // Get component data type
403 char* ComponentDataType();
405 // Transform data from transient form to persistent
406 char* IORToLocalPersistentID( SALOMEDS::SObject_ptr theSObject,
407 const char* IORString,
408 CORBA::Boolean isMultiFile,
409 CORBA::Boolean isASCII );
410 // Transform data from persistent form to transient
411 char* LocalPersistentIDToIOR( SALOMEDS::SObject_ptr theSObject,
412 const char* aLocalPersistentID,
413 CORBA::Boolean isMultiFile,
414 CORBA::Boolean isASCII );
416 // Returns true if object can be published in the study
417 bool CanPublishInStudy( CORBA::Object_ptr theIOR );
418 // Publish object in the study
419 SALOMEDS::SObject_ptr PublishInStudy( SALOMEDS::Study_ptr theStudy,
420 SALOMEDS::SObject_ptr theSObject,
421 CORBA::Object_ptr theObject,
422 const char* theName )
423 throw ( SALOME::SALOME_Exception );
425 // Copy-paste methods - returns true if object can be copied to the clipboard
426 CORBA::Boolean CanCopy( SALOMEDS::SObject_ptr theObject ) { return false; }
427 // Copy-paste methods - copy object to the clipboard
428 SALOMEDS::TMPFile* CopyFrom( SALOMEDS::SObject_ptr theObject, CORBA::Long& theObjectID ) { return false; }
429 // Copy-paste methods - returns true if object can be pasted from the clipboard
430 CORBA::Boolean CanPaste( const char* theComponentName, CORBA::Long theObjectID ) { return false; }
431 // Copy-paste methods - paste object from the clipboard
432 SALOMEDS::SObject_ptr PasteInto( const SALOMEDS::TMPFile& theStream,
433 CORBA::Long theObjectID,
434 SALOMEDS::SObject_ptr theObject ) {
435 SALOMEDS::SObject_var aResultSO;
436 return aResultSO._retn();
443 virtual Engines::TMPFile* DumpPython(CORBA::Object_ptr theStudy,
444 CORBA::Boolean isPublished,
445 CORBA::Boolean isMultiFile,
446 CORBA::Boolean& isValidScript);
448 void AddToPythonScript (int theStudyID, const TCollection_AsciiString& theString);
450 void RemoveLastFromPythonScript (int theStudyID);
452 void SavePython (SALOMEDS::Study_ptr theStudy);
454 TCollection_AsciiString DumpPython_impl (SALOMEDS::Study_ptr theStudy,
455 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
456 Resource_DataMapOfAsciiStringAsciiString& theNames,
459 bool isHistoricalDump,
461 const TCollection_AsciiString& theSavedTrace);
463 TCollection_AsciiString GetNewPythonLines (int theStudyID);
465 void CleanPythonTrace (int theStudyID);
468 // *****************************************
470 // *****************************************
473 GEOM_Client* GetShapeReader();
476 static long GetHypothesisRootTag();
477 static long GetAlgorithmsRootTag();
478 static long GetRefOnShapeTag();
479 static long GetRefOnAppliedHypothesisTag();
480 static long GetRefOnAppliedAlgorithmsTag();
481 static long GetSubMeshOnVertexTag();
482 static long GetSubMeshOnEdgeTag();
483 static long GetSubMeshOnFaceTag();
484 static long GetSubMeshOnSolidTag();
485 static long GetSubMeshOnCompoundTag();
486 static long GetSubMeshOnWireTag();
487 static long GetSubMeshOnShellTag();
488 static long GetNodeGroupsTag();
489 static long GetEdgeGroupsTag();
490 static long GetFaceGroupsTag();
491 static long GetVolumeGroupsTag();
492 static long Get0DElementsGroupsTag();
494 // publishing methods
495 SALOMEDS::SComponent_ptr PublishComponent(SALOMEDS::Study_ptr theStudy);
496 SALOMEDS::SObject_ptr PublishMesh (SALOMEDS::Study_ptr theStudy,
497 SMESH::SMESH_Mesh_ptr theMesh,
498 const char* theName = 0);
499 SALOMEDS::SObject_ptr PublishHypothesis (SALOMEDS::Study_ptr theStudy,
500 SMESH::SMESH_Hypothesis_ptr theHyp,
501 const char* theName = 0);
502 SALOMEDS::SObject_ptr PublishSubMesh (SALOMEDS::Study_ptr theStudy,
503 SMESH::SMESH_Mesh_ptr theMesh,
504 SMESH::SMESH_subMesh_ptr theSubMesh,
505 GEOM::GEOM_Object_ptr theShapeObject,
506 const char* theName = 0);
507 SALOMEDS::SObject_ptr PublishGroup (SALOMEDS::Study_ptr theStudy,
508 SMESH::SMESH_Mesh_ptr theMesh,
509 SMESH::SMESH_GroupBase_ptr theGroup,
510 GEOM::GEOM_Object_ptr theShapeObject,
511 const char* theName = 0);
512 bool AddHypothesisToShape(SALOMEDS::Study_ptr theStudy,
513 SMESH::SMESH_Mesh_ptr theMesh,
514 GEOM::GEOM_Object_ptr theShapeObject,
515 SMESH::SMESH_Hypothesis_ptr theHyp);
516 bool RemoveHypothesisFromShape(SALOMEDS::Study_ptr theStudy,
517 SMESH::SMESH_Mesh_ptr theMesh,
518 GEOM::GEOM_Object_ptr theShapeObject,
519 SMESH::SMESH_Hypothesis_ptr theHyp);
520 SALOMEDS::SObject_ptr GetMeshOrSubmeshByShape (SALOMEDS::Study_ptr theStudy,
521 SMESH::SMESH_Mesh_ptr theMesh,
522 GEOM::GEOM_Object_ptr theShape);
523 static void SetName(SALOMEDS::SObject_ptr theSObject,
525 const char* theDefaultName = 0);
527 static void SetPixMap(SALOMEDS::SObject_ptr theSObject,
528 const char* thePixMap);
531 StudyContext* GetCurrentStudyContext();
533 // Register an object in a StudyContext; return object id
534 int RegisterObject(CORBA::Object_ptr theObject);
536 // Return id of registered object
537 CORBA::Long GetObjectId(CORBA::Object_ptr theObject);
539 // Return an object that previously had an oldID
540 template<class TInterface>
541 typename TInterface::_var_type GetObjectByOldId( const int oldID )
543 if ( StudyContext* myStudyContext = GetCurrentStudyContext() ) {
544 string ior = myStudyContext->getIORbyOldId( oldID );
546 return TInterface::_narrow(GetORB()->string_to_object( ior.c_str() ));
548 return TInterface::_nil();
551 // Get current study ID
552 int GetCurrentStudyID();
555 * \brief Find SObject for an algo
557 SALOMEDS::SObject_ptr GetAlgoSO(const ::SMESH_Algo* algo);
559 void UpdateParameters(/*CORBA::Object_ptr theObject,*/ const char* theParameters);
560 char* GetParameters(CORBA::Object_ptr theObject);
561 char* ParseParameters(const char* theParameters);
562 const std::vector< std::string >& GetLastParameters() const { return myLastParameters; }
565 // Create hypothesis of given type
566 SMESH::SMESH_Hypothesis_ptr createHypothesis( const char* theHypName,
567 const char* theLibName)
568 throw ( SALOME::SALOME_Exception );
570 // Create empty mesh on shape
571 SMESH::SMESH_Mesh_ptr createMesh()
572 throw ( SALOME::SALOME_Exception );
574 static void loadGeomData( SALOMEDS::SComponent_ptr theCompRoot );
576 SMESH::mesh_array* CreateMeshesFromMEDorSAUV( const char* theFileName,
577 SMESH::DriverMED_ReadStatus& theStatus,
578 const char* theCommandNameForPython,
579 const char* theFileNameForPython);
582 static GEOM::GEOM_Gen_var myGeomGen;
583 static CORBA::ORB_var myOrb; // ORB reference
584 static PortableServer::POA_var myPoa; // POA reference
585 static SALOME_NamingService* myNS; // Naming Service
586 static SALOME_LifeCycleCORBA* myLCC; // Life Cycle CORBA
587 static SMESH_Gen_i* mySMESHGen; // Point to last created instance of the class
588 ::SMESH_Gen myGen; // SMESH_Gen local implementation
590 // hypotheses managing
591 map<string, GenericHypothesisCreator_i*> myHypCreatorMap;
593 map<int, StudyContext*> myStudyContextMap; // Map of study context objects
595 GEOM_Client* myShapeReader; // Shape reader
596 SALOMEDS::Study_var myCurrentStudy; // Current study
597 CORBA::Boolean myIsEmbeddedMode; // Current mode
599 // To load full mesh data from study at hyp modification or not
600 bool myToForgetMeshDataOnHypModif;
602 // Dump Python: trace of API methods calls
603 std::map < int, Handle(TColStd_HSequenceOfAsciiString) > myPythonScripts;
604 bool myIsHistoricalPythonDump;
605 std::vector< std::string > myLastParameters;
613 DownCast(CORBA::Object_ptr theArg)
615 return dynamic_cast<T>(SMESH_Gen_i::GetServant(theArg).in());