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 );
207 * Sets number of segments per diagonal of boundary box of geometry by which
208 * default segment length of appropriate 1D hypotheses is defined
210 void SetBoundaryBoxSegmentation( CORBA::Long theNbSegments ) throw ( SALOME::SALOME_Exception );
212 * \brief Sets default number of segments per edge
214 void SetDefaultNbSegments(CORBA::Long theNbSegments) throw ( SALOME::SALOME_Exception );
219 virtual void SetOption(const char*, const char*);
221 Return an option value
223 virtual char* GetOption(const char*);
225 // Create empty mesh on a shape
226 SMESH::SMESH_Mesh_ptr CreateMesh( GEOM::GEOM_Object_ptr theShapeObject )
227 throw ( SALOME::SALOME_Exception );
230 SMESH::SMESH_Mesh_ptr CreateEmptyMesh()
231 throw ( SALOME::SALOME_Exception );
233 // Create mesh(es) and import data from UNV fileter
234 SMESH::SMESH_Mesh_ptr CreateMeshesFromUNV( const char* theFileName )
235 throw ( SALOME::SALOME_Exception );
237 // Create mesh(es) and import data from MED file
238 SMESH::mesh_array* CreateMeshesFromMED( const char* theFileName,
239 SMESH::DriverMED_ReadStatus& theStatus )
240 throw ( SALOME::SALOME_Exception );
242 // Create mesh(es) and import data from MED file
243 SMESH::mesh_array* CreateMeshesFromSAUV( const char* theFileName,
244 SMESH::DriverMED_ReadStatus& theStatus )
245 throw ( SALOME::SALOME_Exception );
247 // Create mesh(es) and import data from STL file
248 SMESH::SMESH_Mesh_ptr CreateMeshesFromSTL( const char* theFileName )
249 throw ( SALOME::SALOME_Exception );
251 // Create mesh(es) and import data from CGNS file
252 SMESH::mesh_array* CreateMeshesFromCGNS( const char* theFileName,
253 SMESH::DriverMED_ReadStatus& theStatus )
254 throw ( SALOME::SALOME_Exception );
256 // Copy a part of mesh
257 SMESH::SMESH_Mesh_ptr CopyMesh(SMESH::SMESH_IDSource_ptr meshPart,
258 const char* meshName,
259 CORBA::Boolean toCopyGroups,
260 CORBA::Boolean toKeepIDs);
262 // Compute mesh on a shape
263 CORBA::Boolean Compute( SMESH::SMESH_Mesh_ptr theMesh,
264 GEOM::GEOM_Object_ptr theShapeObject )
265 throw ( SALOME::SALOME_Exception );
267 // Cancel Compute mesh on a shape
268 void CancelCompute( SMESH::SMESH_Mesh_ptr theMesh,
269 GEOM::GEOM_Object_ptr theShapeObject );
272 * \brief Return errors of mesh computation
274 SMESH::compute_error_array* GetComputeErrors(SMESH::SMESH_Mesh_ptr theMesh,
275 GEOM::GEOM_Object_ptr theShapeObject )
276 throw ( SALOME::SALOME_Exception );
279 * Evaluate mesh on a shape and
280 * returns statistic of mesh elements
281 * Result array of number enityties
283 SMESH::long_array* Evaluate(SMESH::SMESH_Mesh_ptr theMesh,
284 GEOM::GEOM_Object_ptr theShapeObject)
285 throw ( SALOME::SALOME_Exception );
287 // Returns true if mesh contains enough data to be computed
288 CORBA::Boolean IsReadyToCompute( SMESH::SMESH_Mesh_ptr theMesh,
289 GEOM::GEOM_Object_ptr theShapeObject )
290 throw ( SALOME::SALOME_Exception );
293 * Calculate Mesh as preview till indicated dimension on shape
294 * First, verify list of hypothesis associated with the subShape.
295 * Return mesh preview structure
297 SMESH::MeshPreviewStruct* Precompute( SMESH::SMESH_Mesh_ptr theMesh,
298 GEOM::GEOM_Object_ptr theSubObject,
299 SMESH::Dimension theDimension,
300 SMESH::long_array& theShapesId )
301 throw ( SALOME::SALOME_Exception );
303 // Returns errors of hypotheses definintion
304 SMESH::algo_error_array* GetAlgoState( SMESH::SMESH_Mesh_ptr theMesh,
305 GEOM::GEOM_Object_ptr theSubObject )
306 throw ( SALOME::SALOME_Exception );
308 // Return mesh elements preventing computation of a subshape
309 SMESH::MeshPreviewStruct* GetBadInputElements( SMESH::SMESH_Mesh_ptr theMesh,
310 CORBA::Short theSubShapeID )
311 throw ( SALOME::SALOME_Exception );
313 // Get sub-shapes unique ID's list
314 SMESH::long_array* GetSubShapesId( GEOM::GEOM_Object_ptr theMainShapeObject,
315 const SMESH::object_array& theListOfSubShape )
316 throw ( SALOME::SALOME_Exception );
318 // Return geometrical object the given element is built on. Publish it in study.
319 GEOM::GEOM_Object_ptr GetGeometryByMeshElement( SMESH::SMESH_Mesh_ptr theMesh,
320 CORBA::Long theElementID,
321 const char* theGeomName)
322 throw ( SALOME::SALOME_Exception );
324 // Return geometrical object the given element is built on. Don't publish it in study.
325 GEOM::GEOM_Object_ptr FindGeometryByMeshElement( SMESH::SMESH_Mesh_ptr theMesh,
326 CORBA::Long theElementID)
327 throw ( SALOME::SALOME_Exception );
329 // Concatenate the given meshes into one mesh
330 SMESH::SMESH_Mesh_ptr ConcatenateCommon(const SMESH::mesh_array& theMeshesArray,
331 CORBA::Boolean theUniteIdenticalGroups,
332 CORBA::Boolean theMergeNodesAndElements,
333 CORBA::Double theMergeTolerance,
334 CORBA::Boolean theCommonGroups)
335 throw ( SALOME::SALOME_Exception );
337 // Concatenate the given meshes into one mesh
338 SMESH::SMESH_Mesh_ptr Concatenate(const SMESH::mesh_array& theMeshesArray,
339 CORBA::Boolean theUniteIdenticalGroups,
340 CORBA::Boolean theMergeNodesAndElements,
341 CORBA::Double theMergeTolerance)
342 throw ( SALOME::SALOME_Exception );
344 // Concatenate the given meshes into one mesh
345 // Create the groups of all elements from initial meshes
346 SMESH::SMESH_Mesh_ptr ConcatenateWithGroups(const SMESH::mesh_array& theMeshesArray,
347 CORBA::Boolean theUniteIdenticalGroups,
348 CORBA::Boolean theMergeNodesAndElements,
349 CORBA::Double theMergeTolerance)
350 throw ( SALOME::SALOME_Exception );
352 // Get MED version of the file by its name
353 CORBA::Boolean GetMEDVersion(const char* theFileName,
354 SMESH::MED_VERSION& theVersion);
356 // Get names of meshes defined in file with the specified name
357 SMESH::string_array* GetMeshNames(const char* theFileName);
359 // ****************************************************
360 // Interface inherited methods (from SALOMEDS::Driver)
361 // ****************************************************
364 SALOMEDS::TMPFile* Save( SALOMEDS::SComponent_ptr theComponent,
368 bool Load( SALOMEDS::SComponent_ptr theComponent,
369 const SALOMEDS::TMPFile& theStream,
372 // Save SMESH data in ASCII format
373 SALOMEDS::TMPFile* SaveASCII( SALOMEDS::SComponent_ptr theComponent,
376 // Load SMESH data in ASCII format
377 bool LoadASCII( SALOMEDS::SComponent_ptr theComponent,
378 const SALOMEDS::TMPFile& theStream,
382 // Create filter manager
383 SMESH::FilterManager_ptr CreateFilterManager();
385 // Return a pattern mesher
386 SMESH::SMESH_Pattern_ptr GetPattern();
388 // Create measurement instance
389 SMESH::Measurements_ptr CreateMeasurements();
391 // Clears study-connected data when it is closed
392 void Close( SALOMEDS::SComponent_ptr theComponent );
394 // Get component data type
395 char* ComponentDataType();
397 // Transform data from transient form to persistent
398 char* IORToLocalPersistentID( SALOMEDS::SObject_ptr theSObject,
399 const char* IORString,
400 CORBA::Boolean isMultiFile,
401 CORBA::Boolean isASCII );
402 // Transform data from persistent form to transient
403 char* LocalPersistentIDToIOR( SALOMEDS::SObject_ptr theSObject,
404 const char* aLocalPersistentID,
405 CORBA::Boolean isMultiFile,
406 CORBA::Boolean isASCII );
408 // Returns true if object can be published in the study
409 bool CanPublishInStudy( CORBA::Object_ptr theIOR );
410 // Publish object in the study
411 SALOMEDS::SObject_ptr PublishInStudy( SALOMEDS::Study_ptr theStudy,
412 SALOMEDS::SObject_ptr theSObject,
413 CORBA::Object_ptr theObject,
414 const char* theName )
415 throw ( SALOME::SALOME_Exception );
417 // Copy-paste methods - returns true if object can be copied to the clipboard
418 CORBA::Boolean CanCopy( SALOMEDS::SObject_ptr theObject ) { return false; }
419 // Copy-paste methods - copy object to the clipboard
420 SALOMEDS::TMPFile* CopyFrom( SALOMEDS::SObject_ptr theObject, CORBA::Long& theObjectID ) { return false; }
421 // Copy-paste methods - returns true if object can be pasted from the clipboard
422 CORBA::Boolean CanPaste( const char* theComponentName, CORBA::Long theObjectID ) { return false; }
423 // Copy-paste methods - paste object from the clipboard
424 SALOMEDS::SObject_ptr PasteInto( const SALOMEDS::TMPFile& theStream,
425 CORBA::Long theObjectID,
426 SALOMEDS::SObject_ptr theObject ) {
427 SALOMEDS::SObject_var aResultSO;
428 return aResultSO._retn();
435 virtual Engines::TMPFile* DumpPython(CORBA::Object_ptr theStudy,
436 CORBA::Boolean isPublished,
437 CORBA::Boolean isMultiFile,
438 CORBA::Boolean& isValidScript);
440 void AddToPythonScript (int theStudyID, const TCollection_AsciiString& theString);
442 void RemoveLastFromPythonScript (int theStudyID);
444 void SavePython (SALOMEDS::Study_ptr theStudy);
446 TCollection_AsciiString DumpPython_impl (SALOMEDS::Study_ptr theStudy,
447 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
448 Resource_DataMapOfAsciiStringAsciiString& theNames,
451 bool isHistoricalDump,
453 const TCollection_AsciiString& theSavedTrace);
455 TCollection_AsciiString GetNewPythonLines (int theStudyID);
457 void CleanPythonTrace (int theStudyID);
460 // *****************************************
462 // *****************************************
465 GEOM_Client* GetShapeReader();
468 static long GetHypothesisRootTag();
469 static long GetAlgorithmsRootTag();
470 static long GetRefOnShapeTag();
471 static long GetRefOnAppliedHypothesisTag();
472 static long GetRefOnAppliedAlgorithmsTag();
473 static long GetSubMeshOnVertexTag();
474 static long GetSubMeshOnEdgeTag();
475 static long GetSubMeshOnFaceTag();
476 static long GetSubMeshOnSolidTag();
477 static long GetSubMeshOnCompoundTag();
478 static long GetSubMeshOnWireTag();
479 static long GetSubMeshOnShellTag();
480 static long GetNodeGroupsTag();
481 static long GetEdgeGroupsTag();
482 static long GetFaceGroupsTag();
483 static long GetVolumeGroupsTag();
484 static long Get0DElementsGroupsTag();
486 // publishing methods
487 SALOMEDS::SComponent_ptr PublishComponent(SALOMEDS::Study_ptr theStudy);
488 SALOMEDS::SObject_ptr PublishMesh (SALOMEDS::Study_ptr theStudy,
489 SMESH::SMESH_Mesh_ptr theMesh,
490 const char* theName = 0);
491 SALOMEDS::SObject_ptr PublishHypothesis (SALOMEDS::Study_ptr theStudy,
492 SMESH::SMESH_Hypothesis_ptr theHyp,
493 const char* theName = 0);
494 SALOMEDS::SObject_ptr PublishSubMesh (SALOMEDS::Study_ptr theStudy,
495 SMESH::SMESH_Mesh_ptr theMesh,
496 SMESH::SMESH_subMesh_ptr theSubMesh,
497 GEOM::GEOM_Object_ptr theShapeObject,
498 const char* theName = 0);
499 SALOMEDS::SObject_ptr PublishGroup (SALOMEDS::Study_ptr theStudy,
500 SMESH::SMESH_Mesh_ptr theMesh,
501 SMESH::SMESH_GroupBase_ptr theGroup,
502 GEOM::GEOM_Object_ptr theShapeObject,
503 const char* theName = 0);
504 bool AddHypothesisToShape(SALOMEDS::Study_ptr theStudy,
505 SMESH::SMESH_Mesh_ptr theMesh,
506 GEOM::GEOM_Object_ptr theShapeObject,
507 SMESH::SMESH_Hypothesis_ptr theHyp);
508 bool RemoveHypothesisFromShape(SALOMEDS::Study_ptr theStudy,
509 SMESH::SMESH_Mesh_ptr theMesh,
510 GEOM::GEOM_Object_ptr theShapeObject,
511 SMESH::SMESH_Hypothesis_ptr theHyp);
512 SALOMEDS::SObject_ptr GetMeshOrSubmeshByShape (SALOMEDS::Study_ptr theStudy,
513 SMESH::SMESH_Mesh_ptr theMesh,
514 GEOM::GEOM_Object_ptr theShape);
515 static void SetName(SALOMEDS::SObject_ptr theSObject,
517 const char* theDefaultName = 0);
519 static void SetPixMap(SALOMEDS::SObject_ptr theSObject,
520 const char* thePixMap);
523 StudyContext* GetCurrentStudyContext();
525 // Register an object in a StudyContext; return object id
526 int RegisterObject(CORBA::Object_ptr theObject);
528 // Return id of registered object
529 CORBA::Long GetObjectId(CORBA::Object_ptr theObject);
531 // Return an object that previously had an oldID
532 template<class TInterface>
533 typename TInterface::_var_type GetObjectByOldId( const int oldID )
535 if ( StudyContext* myStudyContext = GetCurrentStudyContext() ) {
536 string ior = myStudyContext->getIORbyOldId( oldID );
538 return TInterface::_narrow(GetORB()->string_to_object( ior.c_str() ));
540 return TInterface::_nil();
543 // Get current study ID
544 int GetCurrentStudyID();
547 * \brief Find SObject for an algo
549 SALOMEDS::SObject_ptr GetAlgoSO(const ::SMESH_Algo* algo);
551 void UpdateParameters(CORBA::Object_ptr theObject, const char* theParameters);
552 char* GetParameters(CORBA::Object_ptr theObject);
553 char* ParseParameters(const char* theParameters);
557 // Create hypothesis of given type
558 SMESH::SMESH_Hypothesis_ptr createHypothesis( const char* theHypName,
559 const char* theLibName)
560 throw ( SALOME::SALOME_Exception );
562 // Create empty mesh on shape
563 SMESH::SMESH_Mesh_ptr createMesh()
564 throw ( SALOME::SALOME_Exception );
566 static void loadGeomData( SALOMEDS::SComponent_ptr theCompRoot );
568 SMESH::mesh_array* CreateMeshesFromMEDorSAUV( const char* theFileName,
569 SMESH::DriverMED_ReadStatus& theStatus,
570 const char* theCommandNameForPython,
571 const char* theFileNameForPython);
574 static GEOM::GEOM_Gen_var myGeomGen;
575 static CORBA::ORB_var myOrb; // ORB reference
576 static PortableServer::POA_var myPoa; // POA reference
577 static SALOME_NamingService* myNS; // Naming Service
578 static SALOME_LifeCycleCORBA* myLCC; // Life Cycle CORBA
579 static SMESH_Gen_i* mySMESHGen; // Point to last created instance of the class
580 ::SMESH_Gen myGen; // SMESH_Gen local implementation
582 // hypotheses managing
583 map<string, GenericHypothesisCreator_i*> myHypCreatorMap;
585 map<int, StudyContext*> myStudyContextMap; // Map of study context objects
587 GEOM_Client* myShapeReader; // Shape reader
588 SALOMEDS::Study_var myCurrentStudy; // Current study
589 CORBA::Boolean myIsEmbeddedMode; // Current mode
591 // Dump Python: trace of API methods calls
592 std::map < int, Handle(TColStd_HSequenceOfAsciiString) > myPythonScripts;
593 bool myIsHistoricalPythonDump;
601 DownCast(CORBA::Object_ptr theArg)
603 return dynamic_cast<T>(SMESH_Gen_i::GetServant(theArg).in());