1 // Copyright (C) 2007-2008 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 // SMESH SMESH_I : idl implementation based on 'SMESH' unit's calsses
23 // File : SMESH_Gen_i.hxx
24 // Author : Paul RASCLE, EDF
27 #ifndef _SMESH_GEN_I_HXX_
28 #define _SMESH_GEN_I_HXX_
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)
40 #include "SMESH_Mesh_i.hxx"
41 #include "SMESH_Hypothesis_i.hxx"
42 #include "SALOME_Component_i.hxx"
43 #include "SALOME_NamingService.hxx"
45 #include "SMESH_Gen.hxx"
46 #include "GEOM_Client.hxx"
48 #include <TCollection_AsciiString.hxx>
49 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
50 #include <TColStd_HSequenceOfAsciiString.hxx>
56 class SALOME_LifeCycleCORBA;
58 // ===========================================================
59 // Study context - stores study-connected objects references
60 // ==========================================================
61 class SMESH_I_EXPORT StudyContext
72 // register object in the internal map and return its id
73 int addObject( string theIOR )
75 int nextId = getNextId();
76 mapIdToIOR[ nextId ] = theIOR;
79 // find the object id in the internal map by the IOR
80 int findId( string theIOR )
82 map<int, string>::iterator imap;
83 for ( imap = mapIdToIOR.begin(); imap != mapIdToIOR.end(); ++imap ) {
84 if ( imap->second == theIOR )
89 // get object's IOR by id
90 string getIORbyId( const int theId )
92 if ( mapIdToIOR.find( theId ) != mapIdToIOR.end() )
93 return mapIdToIOR[ theId ];
96 // get object's IOR by old id
97 string getIORbyOldId( const int theOldId )
99 if ( mapIdToId.find( theOldId ) != mapIdToId.end() )
100 return getIORbyId( mapIdToId[ theOldId ] );
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;
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 )
118 // get next free object identifier
122 while( mapIdToIOR.find( id ) != mapIdToIOR.end() )
127 map<int, string> mapIdToIOR; // persistent-to-transient map
128 map<int, int> mapIdToId; // used to translate object from persistent to transient form
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
139 // Get last created instance of the class
140 static SMESH_Gen_i* GetSMESHGen() { return mySMESHGen;}
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);
163 // Default constructor
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 );
172 virtual ~SMESH_Gen_i();
174 // *****************************************
176 // *****************************************
177 // Set a new Mesh object name
178 void SetName(const char* theIOR,
179 const char* theName);
181 //GEOM::GEOM_Gen_ptr SetGeomEngine( const char* containerLoc );
182 void SetGeomEngine( GEOM::GEOM_Gen_ptr geomcompo );
185 void SetEmbeddedMode( CORBA::Boolean theMode );
187 CORBA::Boolean IsEmbeddedMode();
190 void SetCurrentStudy( SALOMEDS::Study_ptr theStudy );
192 SALOMEDS::Study_ptr GetCurrentStudy();
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 );
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 );
208 * Sets number of segments per diagonal of boundary box of geometry by which
209 * default segment length of appropriate 1D hypotheses is defined
211 void SetBoundaryBoxSegmentation( CORBA::Long theNbSegments ) throw ( SALOME::SALOME_Exception );
213 * \brief Sets default number of segments per edge
215 void SetDefaultNbSegments(CORBA::Long theNbSegments) throw ( SALOME::SALOME_Exception );
217 // Create empty mesh on a shape
218 SMESH::SMESH_Mesh_ptr CreateMesh( GEOM::GEOM_Object_ptr theShapeObject )
219 throw ( SALOME::SALOME_Exception );
222 SMESH::SMESH_Mesh_ptr CreateEmptyMesh()
223 throw ( SALOME::SALOME_Exception );
225 // Create mesh(es) and import data from UNV file
226 SMESH::SMESH_Mesh_ptr CreateMeshesFromUNV( const char* theFileName )
227 throw ( SALOME::SALOME_Exception );
229 // Create mesh(es) and import data from MED file
230 SMESH::mesh_array* CreateMeshesFromMED( const char* theFileName,
231 SMESH::DriverMED_ReadStatus& theStatus )
232 throw ( SALOME::SALOME_Exception );
234 // Create mesh(es) and import data from STL file
235 SMESH::SMESH_Mesh_ptr CreateMeshesFromSTL( const char* theFileName )
236 throw ( SALOME::SALOME_Exception );
238 // Compute mesh on a shape
239 CORBA::Boolean Compute( SMESH::SMESH_Mesh_ptr theMesh,
240 GEOM::GEOM_Object_ptr theShapeObject )
241 throw ( SALOME::SALOME_Exception );
243 * \brief Return errors of mesh computation
245 SMESH::compute_error_array* GetComputeErrors(SMESH::SMESH_Mesh_ptr theMesh,
246 GEOM::GEOM_Object_ptr theShapeObject )
247 throw ( SALOME::SALOME_Exception );
249 // Returns true if mesh contains enough data to be computed
250 CORBA::Boolean IsReadyToCompute( SMESH::SMESH_Mesh_ptr theMesh,
251 GEOM::GEOM_Object_ptr theShapeObject )
252 throw ( SALOME::SALOME_Exception );
255 * Calculate Mesh as preview till indicated dimension on shape
256 * First, verify list of hypothesis associated with the subShape.
257 * Return mesh preview structure
259 SMESH::MeshPreviewStruct* Precompute( SMESH::SMESH_Mesh_ptr theMesh,
260 GEOM::GEOM_Object_ptr theSubObject,
261 SMESH::Dimension theDimension,
262 SMESH::long_array& theShapesId )
263 throw ( SALOME::SALOME_Exception );
265 // Returns errors of hypotheses definintion
266 SMESH::algo_error_array* GetAlgoState( SMESH::SMESH_Mesh_ptr theMesh,
267 GEOM::GEOM_Object_ptr theSubObject )
268 throw ( SALOME::SALOME_Exception );
270 // Return mesh elements preventing computation of a subshape
271 SMESH::MeshPreviewStruct* GetBadInputElements( SMESH::SMESH_Mesh_ptr theMesh,
272 CORBA::Short theSubShapeID )
273 throw ( SALOME::SALOME_Exception );
275 // Get sub-shapes unique ID's list
276 SMESH::long_array* GetSubShapesId( GEOM::GEOM_Object_ptr theMainShapeObject,
277 const SMESH::object_array& theListOfSubShape )
278 throw ( SALOME::SALOME_Exception );
280 // Return geometrical object the given element is built on. Publish it in study.
281 GEOM::GEOM_Object_ptr GetGeometryByMeshElement( SMESH::SMESH_Mesh_ptr theMesh,
282 CORBA::Long theElementID,
283 const char* theGeomName)
284 throw ( SALOME::SALOME_Exception );
286 // Return geometrical object the given element is built on. Don't publish it in study.
287 GEOM::GEOM_Object_ptr FindGeometryByMeshElement( SMESH::SMESH_Mesh_ptr theMesh,
288 CORBA::Long theElementID)
289 throw ( SALOME::SALOME_Exception );
291 // Concatenate the given meshes into one mesh
292 SMESH::SMESH_Mesh_ptr ConcatenateCommon(const SMESH::mesh_array& theMeshesArray,
293 CORBA::Boolean theUniteIdenticalGroups,
294 CORBA::Boolean theMergeNodesAndElements,
295 CORBA::Double theMergeTolerance,
296 CORBA::Boolean theCommonGroups)
297 throw ( SALOME::SALOME_Exception );
299 // Concatenate the given meshes into one mesh
300 SMESH::SMESH_Mesh_ptr Concatenate(const SMESH::mesh_array& theMeshesArray,
301 CORBA::Boolean theUniteIdenticalGroups,
302 CORBA::Boolean theMergeNodesAndElements,
303 CORBA::Double theMergeTolerance)
304 throw ( SALOME::SALOME_Exception );
306 // Concatenate the given meshes into one mesh
307 // Create the groups of all elements from initial meshes
308 SMESH::SMESH_Mesh_ptr ConcatenateWithGroups(const SMESH::mesh_array& theMeshesArray,
309 CORBA::Boolean theUniteIdenticalGroups,
310 CORBA::Boolean theMergeNodesAndElements,
311 CORBA::Double theMergeTolerance)
312 throw ( SALOME::SALOME_Exception );
314 // ****************************************************
315 // Interface inherited methods (from SALOMEDS::Driver)
316 // ****************************************************
319 SALOMEDS::TMPFile* Save( SALOMEDS::SComponent_ptr theComponent,
323 bool Load( SALOMEDS::SComponent_ptr theComponent,
324 const SALOMEDS::TMPFile& theStream,
327 // Save SMESH data in ASCII format
328 SALOMEDS::TMPFile* SaveASCII( SALOMEDS::SComponent_ptr theComponent,
331 // Load SMESH data in ASCII format
332 bool LoadASCII( SALOMEDS::SComponent_ptr theComponent,
333 const SALOMEDS::TMPFile& theStream,
337 // Create filter manager
338 SMESH::FilterManager_ptr CreateFilterManager();
340 // Return a pattern mesher
341 SMESH::SMESH_Pattern_ptr GetPattern();
343 // Clears study-connected data when it is closed
344 void Close( SALOMEDS::SComponent_ptr theComponent );
346 // Get component data type
347 char* ComponentDataType();
349 // Transform data from transient form to persistent
350 char* IORToLocalPersistentID( SALOMEDS::SObject_ptr theSObject,
351 const char* IORString,
352 CORBA::Boolean isMultiFile,
353 CORBA::Boolean isASCII );
354 // Transform data from persistent form to transient
355 char* LocalPersistentIDToIOR( SALOMEDS::SObject_ptr theSObject,
356 const char* aLocalPersistentID,
357 CORBA::Boolean isMultiFile,
358 CORBA::Boolean isASCII );
360 // Returns true if object can be published in the study
361 bool CanPublishInStudy( CORBA::Object_ptr theIOR );
362 // Publish object in the study
363 SALOMEDS::SObject_ptr PublishInStudy( SALOMEDS::Study_ptr theStudy,
364 SALOMEDS::SObject_ptr theSObject,
365 CORBA::Object_ptr theObject,
366 const char* theName )
367 throw ( SALOME::SALOME_Exception );
369 // Copy-paste methods - returns true if object can be copied to the clipboard
370 CORBA::Boolean CanCopy( SALOMEDS::SObject_ptr theObject ) { return false; }
371 // Copy-paste methods - copy object to the clipboard
372 SALOMEDS::TMPFile* CopyFrom( SALOMEDS::SObject_ptr theObject, CORBA::Long& theObjectID ) { return false; }
373 // Copy-paste methods - returns true if object can be pasted from the clipboard
374 CORBA::Boolean CanPaste( const char* theComponentName, CORBA::Long theObjectID ) { return false; }
375 // Copy-paste methods - paste object from the clipboard
376 SALOMEDS::SObject_ptr PasteInto( const SALOMEDS::TMPFile& theStream,
377 CORBA::Long theObjectID,
378 SALOMEDS::SObject_ptr theObject ) {
379 SALOMEDS::SObject_var aResultSO;
380 return aResultSO._retn();
387 virtual Engines::TMPFile* DumpPython(CORBA::Object_ptr theStudy,
388 CORBA::Boolean isPublished,
389 CORBA::Boolean& isValidScript);
391 void AddToPythonScript (int theStudyID, const TCollection_AsciiString& theString);
393 void RemoveLastFromPythonScript (int theStudyID);
395 void SavePython (SALOMEDS::Study_ptr theStudy);
397 TCollection_AsciiString DumpPython_impl (SALOMEDS::Study_ptr theStudy,
398 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
399 Resource_DataMapOfAsciiStringAsciiString& theNames,
402 const TCollection_AsciiString& theSavedTrace);
404 TCollection_AsciiString GetNewPythonLines (int theStudyID);
406 void CleanPythonTrace (int theStudyID);
409 // *****************************************
411 // *****************************************
414 GEOM_Client* GetShapeReader();
417 static long GetHypothesisRootTag();
418 static long GetAlgorithmsRootTag();
419 static long GetRefOnShapeTag();
420 static long GetRefOnAppliedHypothesisTag();
421 static long GetRefOnAppliedAlgorithmsTag();
422 static long GetSubMeshOnVertexTag();
423 static long GetSubMeshOnEdgeTag();
424 static long GetSubMeshOnFaceTag();
425 static long GetSubMeshOnSolidTag();
426 static long GetSubMeshOnCompoundTag();
427 static long GetSubMeshOnWireTag();
428 static long GetSubMeshOnShellTag();
429 static long GetNodeGroupsTag();
430 static long GetEdgeGroupsTag();
431 static long GetFaceGroupsTag();
432 static long GetVolumeGroupsTag();
434 // publishing methods
435 SALOMEDS::SComponent_ptr PublishComponent(SALOMEDS::Study_ptr theStudy);
436 SALOMEDS::SObject_ptr PublishMesh (SALOMEDS::Study_ptr theStudy,
437 SMESH::SMESH_Mesh_ptr theMesh,
438 const char* theName = 0);
439 SALOMEDS::SObject_ptr PublishHypothesis (SALOMEDS::Study_ptr theStudy,
440 SMESH::SMESH_Hypothesis_ptr theHyp,
441 const char* theName = 0);
442 SALOMEDS::SObject_ptr PublishSubMesh (SALOMEDS::Study_ptr theStudy,
443 SMESH::SMESH_Mesh_ptr theMesh,
444 SMESH::SMESH_subMesh_ptr theSubMesh,
445 GEOM::GEOM_Object_ptr theShapeObject,
446 const char* theName = 0);
447 SALOMEDS::SObject_ptr PublishGroup (SALOMEDS::Study_ptr theStudy,
448 SMESH::SMESH_Mesh_ptr theMesh,
449 SMESH::SMESH_GroupBase_ptr theGroup,
450 GEOM::GEOM_Object_ptr theShapeObject,
451 const char* theName = 0);
452 bool AddHypothesisToShape(SALOMEDS::Study_ptr theStudy,
453 SMESH::SMESH_Mesh_ptr theMesh,
454 GEOM::GEOM_Object_ptr theShapeObject,
455 SMESH::SMESH_Hypothesis_ptr theHyp);
456 bool RemoveHypothesisFromShape(SALOMEDS::Study_ptr theStudy,
457 SMESH::SMESH_Mesh_ptr theMesh,
458 GEOM::GEOM_Object_ptr theShapeObject,
459 SMESH::SMESH_Hypothesis_ptr theHyp);
460 SALOMEDS::SObject_ptr GetMeshOrSubmeshByShape (SALOMEDS::Study_ptr theStudy,
461 SMESH::SMESH_Mesh_ptr theMesh,
462 GEOM::GEOM_Object_ptr theShape);
463 static void SetName(SALOMEDS::SObject_ptr theSObject,
465 const char* theDefaultName = 0);
467 static void SetPixMap(SALOMEDS::SObject_ptr theSObject,
468 const char* thePixMap);
471 StudyContext* GetCurrentStudyContext();
473 // Register an object in a StudyContext; return object id
474 int RegisterObject(CORBA::Object_ptr theObject);
476 // Return id of registered object
477 CORBA::Long GetObjectId(CORBA::Object_ptr theObject);
479 // Return an object that previously had an oldID
480 template<class TInterface>
481 typename TInterface::_var_type GetObjectByOldId( const int oldID )
483 if ( StudyContext* myStudyContext = GetCurrentStudyContext() ) {
484 string ior = myStudyContext->getIORbyOldId( oldID );
486 return TInterface::_narrow(GetORB()->string_to_object( ior.c_str() ));
488 return TInterface::_nil();
491 // Get current study ID
492 int GetCurrentStudyID()
493 { return myCurrentStudy->_is_nil() ? -1 : myCurrentStudy->StudyId(); }
496 * \brief Find SObject for an algo
498 SALOMEDS::SObject_ptr GetAlgoSO(const ::SMESH_Algo* algo);
500 void UpdateParameters(CORBA::Object_ptr theObject, const char* theParameters);
501 char* GetParameters(CORBA::Object_ptr theObject);
502 char* ParseParameters(const char* theParameters);
506 // Create hypothesis of given type
507 SMESH::SMESH_Hypothesis_ptr createHypothesis( const char* theHypName,
508 const char* theLibName)
509 throw ( SALOME::SALOME_Exception );
511 // Create empty mesh on shape
512 SMESH::SMESH_Mesh_ptr createMesh()
513 throw ( SALOME::SALOME_Exception );
515 static void loadGeomData( SALOMEDS::SComponent_ptr theCompRoot );
518 static GEOM::GEOM_Gen_var myGeomGen;
519 static CORBA::ORB_var myOrb; // ORB reference
520 static PortableServer::POA_var myPoa; // POA reference
521 static SALOME_NamingService* myNS; // Naming Service
522 static SALOME_LifeCycleCORBA* myLCC; // Life Cycle CORBA
523 static SMESH_Gen_i* mySMESHGen; // Point to last created instance of the class
524 ::SMESH_Gen myGen; // SMESH_Gen local implementation
526 // hypotheses managing
527 map<string, GenericHypothesisCreator_i*> myHypCreatorMap;
529 map<int, StudyContext*> myStudyContextMap; // Map of study context objects
531 GEOM_Client* myShapeReader; // Shape reader
532 SALOMEDS::Study_var myCurrentStudy; // Current study
533 CORBA::Boolean myIsEmbeddedMode; // Current mode
535 // Dump Python: trace of API methods calls
536 std::map < int, Handle(TColStd_HSequenceOfAsciiString) > myPythonScripts;
544 DownCast(CORBA::Object_ptr theArg)
546 return dynamic_cast<T>(SMESH_Gen_i::GetServant(theArg).in());