1 // SMESH SMESH_I : idl implementation based on 'SMESH' unit's calsses
3 // Copyright (C) 2003 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
24 // File : SMESH_Gen_i.hxx
25 // Author : Paul RASCLE, EDF
29 #ifndef _SMESH_GEN_I_HXX_
30 #define _SMESH_GEN_I_HXX_
34 #include <SALOMEconfig.h>
35 #include CORBA_SERVER_HEADER(SMESH_Gen)
36 #include CORBA_SERVER_HEADER(SMESH_Mesh)
37 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
38 #include CORBA_CLIENT_HEADER(GEOM_Gen)
39 #include CORBA_CLIENT_HEADER(SALOMEDS)
40 #include CORBA_CLIENT_HEADER(SALOMEDS_Attributes)
42 #include "SMESH_Mesh_i.hxx"
43 #include "SMESH_Hypothesis_i.hxx"
44 #include "SALOME_Component_i.hxx"
45 #include "SALOME_NamingService.hxx"
47 #include "SMESH_Gen.hxx"
48 #include "GEOM_Client.hxx"
50 #include <TCollection_AsciiString.hxx>
51 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
52 #include <TColStd_HSequenceOfAsciiString.hxx>
58 class SALOME_LifeCycleCORBA;
60 // ===========================================================
61 // Study context - stores study-connected objects references
62 // ==========================================================
63 class SMESH_I_EXPORT StudyContext
74 // register object in the internal map and return its id
75 int addObject( string theIOR )
77 int nextId = getNextId();
78 mapIdToIOR[ nextId ] = theIOR;
81 // find the object id in the internal map by the IOR
82 int findId( string theIOR )
84 map<int, string>::iterator imap;
85 for ( imap = mapIdToIOR.begin(); imap != mapIdToIOR.end(); ++imap ) {
86 if ( imap->second == theIOR )
91 // get object's IOR by id
92 string getIORbyId( const int theId )
94 if ( mapIdToIOR.find( theId ) != mapIdToIOR.end() )
95 return mapIdToIOR[ theId ];
98 // get object's IOR by old id
99 string getIORbyOldId( const int theOldId )
101 if ( mapIdToId.find( theOldId ) != mapIdToId.end() )
102 return getIORbyId( mapIdToId[ theOldId ] );
105 // maps old object id to the new one (used when restoring data)
106 void mapOldToNew( const int oldId, const int newId ) {
107 mapIdToId[ oldId ] = newId;
109 // get old id by a new one
110 int getOldId( const int newId ) {
111 map<int, int>::iterator imap;
112 for ( imap = mapIdToId.begin(); imap != mapIdToId.end(); ++imap ) {
113 if ( imap->second == newId )
120 // get next free object identifier
124 while( mapIdToIOR.find( id ) != mapIdToIOR.end() )
129 map<int, string> mapIdToIOR; // persistent-to-transient map
130 map<int, int> mapIdToId; // used to translate object from persistent to transient form
133 // ===========================================================
134 // SMESH module's engine
135 // ==========================================================
136 class SMESH_I_EXPORT SMESH_Gen_i:
137 public virtual POA_SMESH::SMESH_Gen,
138 public virtual Engines_Component_i
141 // Get last created instance of the class
142 static SMESH_Gen_i* GetSMESHGen() { return mySMESHGen;}
144 static CORBA::ORB_var GetORB() { return myOrb;}
145 // Get SMESH module's POA object
146 static PortableServer::POA_var GetPOA() { return myPoa;}
147 // Get Naming Service object
148 static SALOME_NamingService* GetNS();
149 // Get SALOME_LifeCycleCORBA object
150 static SALOME_LifeCycleCORBA* GetLCC();
151 // Retrieve and get GEOM engine reference
152 static GEOM::GEOM_Gen_ptr GetGeomEngine();
153 // Get object of the CORBA reference
154 static PortableServer::ServantBase_var GetServant( CORBA::Object_ptr theObject );
155 // Get CORBA object corresponding to the SALOMEDS::SObject
156 static CORBA::Object_var SObjectToObject( SALOMEDS::SObject_ptr theSObject );
157 // Get the SALOMEDS::SObject corresponding to a CORBA object
158 static SALOMEDS::SObject_ptr ObjectToSObject(SALOMEDS::Study_ptr theStudy,
159 CORBA::Object_ptr theObject);
160 // Get GEOM Object correspoding to TopoDS_Shape
161 GEOM::GEOM_Object_ptr ShapeToGeomObject (const TopoDS_Shape& theShape );
162 // Get TopoDS_Shape correspoding to GEOM_Object
163 TopoDS_Shape GeomObjectToShape(GEOM::GEOM_Object_ptr theGeomObject);
165 // Default constructor
167 // Standard constructor
168 SMESH_Gen_i( CORBA::ORB_ptr orb,
169 PortableServer::POA_ptr poa,
170 PortableServer::ObjectId* contId,
171 const char* instanceName,
172 const char* interfaceName );
174 virtual ~SMESH_Gen_i();
176 // *****************************************
178 // *****************************************
179 //GEOM::GEOM_Gen_ptr SetGeomEngine( const char* containerLoc );
180 void SetGeomEngine( GEOM::GEOM_Gen_ptr geomcompo );
183 void SetEmbeddedMode( CORBA::Boolean theMode );
185 CORBA::Boolean IsEmbeddedMode();
188 void SetCurrentStudy( SALOMEDS::Study_ptr theStudy );
190 SALOMEDS::Study_ptr GetCurrentStudy();
192 // Create hypothesis/algorothm of given type
193 SMESH::SMESH_Hypothesis_ptr CreateHypothesis (const char* theHypType,
194 const char* theLibName)
195 throw ( SALOME::SALOME_Exception );
197 // Return hypothesis of given type holding parameter values of the existing mesh
198 SMESH::SMESH_Hypothesis_ptr GetHypothesisParameterValues (const char* theHypType,
199 const char* theLibName,
200 SMESH::SMESH_Mesh_ptr theMesh,
201 GEOM::GEOM_Object_ptr theGeom)
202 throw ( SALOME::SALOME_Exception );
204 // Create empty mesh on a shape
205 SMESH::SMESH_Mesh_ptr CreateMesh( GEOM::GEOM_Object_ptr theShapeObject )
206 throw ( SALOME::SALOME_Exception );
209 SMESH::SMESH_Mesh_ptr CreateEmptyMesh()
210 throw ( SALOME::SALOME_Exception );
212 // Create mesh(es) and import data from UNV file
213 SMESH::SMESH_Mesh_ptr CreateMeshesFromUNV( const char* theFileName )
214 throw ( SALOME::SALOME_Exception );
216 // Create mesh(es) and import data from MED file
217 SMESH::mesh_array* CreateMeshesFromMED( const char* theFileName,
218 SMESH::DriverMED_ReadStatus& theStatus )
219 throw ( SALOME::SALOME_Exception );
221 // Create mesh(es) and import data from STL file
222 SMESH::SMESH_Mesh_ptr CreateMeshesFromSTL( const char* theFileName )
223 throw ( SALOME::SALOME_Exception );
225 // Compute mesh on a shape
226 CORBA::Boolean Compute( SMESH::SMESH_Mesh_ptr theMesh,
227 GEOM::GEOM_Object_ptr theShapeObject )
228 throw ( SALOME::SALOME_Exception );
230 * \brief Return errors of mesh computation
232 SMESH::compute_error_array* GetComputeErrors(SMESH::SMESH_Mesh_ptr theMesh,
233 GEOM::GEOM_Object_ptr theShapeObject )
234 throw ( SALOME::SALOME_Exception );
236 // Returns true if mesh contains enough data to be computed
237 CORBA::Boolean IsReadyToCompute( SMESH::SMESH_Mesh_ptr theMesh,
238 GEOM::GEOM_Object_ptr theShapeObject )
239 throw ( SALOME::SALOME_Exception );
242 * Calculate Mesh as preview till indicated dimension on shape
243 * First, verify list of hypothesis associated with the subShape.
244 * Return mesh preview structure
246 SMESH::MeshPreviewStruct* Precompute( SMESH::SMESH_Mesh_ptr theMesh,
247 GEOM::GEOM_Object_ptr theSubObject,
248 SMESH::Dimension theDimension,
249 SMESH::long_array& theShapesId )
250 throw ( SALOME::SALOME_Exception );
252 // Returns errors of hypotheses definintion
253 SMESH::algo_error_array* GetAlgoState( SMESH::SMESH_Mesh_ptr theMesh,
254 GEOM::GEOM_Object_ptr theSubObject )
255 throw ( SALOME::SALOME_Exception );
257 // Return mesh elements preventing computation of a subshape
258 SMESH::MeshPreviewStruct* GetBadInputElements( SMESH::SMESH_Mesh_ptr theMesh,
259 CORBA::Short theSubShapeID )
260 throw ( SALOME::SALOME_Exception );
262 // Get sub-shapes unique ID's list
263 SMESH::long_array* GetSubShapesId( GEOM::GEOM_Object_ptr theMainShapeObject,
264 const SMESH::object_array& theListOfSubShape )
265 throw ( SALOME::SALOME_Exception );
267 // Return geometrical object the given element is built on. Publish it in study.
268 GEOM::GEOM_Object_ptr GetGeometryByMeshElement( SMESH::SMESH_Mesh_ptr theMesh,
269 CORBA::Long theElementID,
270 const char* theGeomName)
271 throw ( SALOME::SALOME_Exception );
273 // Return geometrical object the given element is built on. Don't publish it in study.
274 GEOM::GEOM_Object_ptr FindGeometryByMeshElement( SMESH::SMESH_Mesh_ptr theMesh,
275 CORBA::Long theElementID)
276 throw ( SALOME::SALOME_Exception );
278 // Concatenate the given meshes into one mesh
279 SMESH::SMESH_Mesh_ptr ConcatenateCommon(const SMESH::mesh_array& theMeshesArray,
280 CORBA::Boolean theUniteIdenticalGroups,
281 CORBA::Boolean theMergeNodesAndElements,
282 CORBA::Double theMergeTolerance,
283 CORBA::Boolean theCommonGroups)
284 throw ( SALOME::SALOME_Exception );
286 // Concatenate the given meshes into one mesh
287 SMESH::SMESH_Mesh_ptr Concatenate(const SMESH::mesh_array& theMeshesArray,
288 CORBA::Boolean theUniteIdenticalGroups,
289 CORBA::Boolean theMergeNodesAndElements,
290 CORBA::Double theMergeTolerance)
291 throw ( SALOME::SALOME_Exception );
293 // Concatenate the given meshes into one mesh
294 // Create the groups of all elements from initial meshes
295 SMESH::SMESH_Mesh_ptr ConcatenateWithGroups(const SMESH::mesh_array& theMeshesArray,
296 CORBA::Boolean theUniteIdenticalGroups,
297 CORBA::Boolean theMergeNodesAndElements,
298 CORBA::Double theMergeTolerance)
299 throw ( SALOME::SALOME_Exception );
301 // ****************************************************
302 // Interface inherited methods (from SALOMEDS::Driver)
303 // ****************************************************
306 SALOMEDS::TMPFile* Save( SALOMEDS::SComponent_ptr theComponent,
310 bool Load( SALOMEDS::SComponent_ptr theComponent,
311 const SALOMEDS::TMPFile& theStream,
314 // Save SMESH data in ASCII format
315 SALOMEDS::TMPFile* SaveASCII( SALOMEDS::SComponent_ptr theComponent,
318 // Load SMESH data in ASCII format
319 bool LoadASCII( SALOMEDS::SComponent_ptr theComponent,
320 const SALOMEDS::TMPFile& theStream,
324 // Create filter manager
325 SMESH::FilterManager_ptr CreateFilterManager();
327 // Return a pattern mesher
328 SMESH::SMESH_Pattern_ptr GetPattern();
330 // Clears study-connected data when it is closed
331 void Close( SALOMEDS::SComponent_ptr theComponent );
333 // Get component data type
334 char* ComponentDataType();
336 // Transform data from transient form to persistent
337 char* IORToLocalPersistentID( SALOMEDS::SObject_ptr theSObject,
338 const char* IORString,
339 CORBA::Boolean isMultiFile,
340 CORBA::Boolean isASCII );
341 // Transform data from persistent form to transient
342 char* LocalPersistentIDToIOR( SALOMEDS::SObject_ptr theSObject,
343 const char* aLocalPersistentID,
344 CORBA::Boolean isMultiFile,
345 CORBA::Boolean isASCII );
347 // Returns true if object can be published in the study
348 bool CanPublishInStudy( CORBA::Object_ptr theIOR );
349 // Publish object in the study
350 SALOMEDS::SObject_ptr PublishInStudy( SALOMEDS::Study_ptr theStudy,
351 SALOMEDS::SObject_ptr theSObject,
352 CORBA::Object_ptr theObject,
353 const char* theName )
354 throw ( SALOME::SALOME_Exception );
356 // Copy-paste methods - returns true if object can be copied to the clipboard
357 CORBA::Boolean CanCopy( SALOMEDS::SObject_ptr theObject ) { return false; }
358 // Copy-paste methods - copy object to the clipboard
359 SALOMEDS::TMPFile* CopyFrom( SALOMEDS::SObject_ptr theObject, CORBA::Long& theObjectID ) { return false; }
360 // Copy-paste methods - returns true if object can be pasted from the clipboard
361 CORBA::Boolean CanPaste( const char* theComponentName, CORBA::Long theObjectID ) { return false; }
362 // Copy-paste methods - paste object from the clipboard
363 SALOMEDS::SObject_ptr PasteInto( const SALOMEDS::TMPFile& theStream,
364 CORBA::Long theObjectID,
365 SALOMEDS::SObject_ptr theObject ) {
366 SALOMEDS::SObject_var aResultSO;
367 return aResultSO._retn();
374 virtual Engines::TMPFile* DumpPython(CORBA::Object_ptr theStudy,
375 CORBA::Boolean isPublished,
376 CORBA::Boolean& isValidScript);
378 void AddToPythonScript (int theStudyID, const TCollection_AsciiString& theString);
380 void RemoveLastFromPythonScript (int theStudyID);
382 void SavePython (SALOMEDS::Study_ptr theStudy);
384 TCollection_AsciiString DumpPython_impl (SALOMEDS::Study_ptr theStudy,
385 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
386 Resource_DataMapOfAsciiStringAsciiString& theNames,
389 const TCollection_AsciiString& theSavedTrace);
391 TCollection_AsciiString GetNewPythonLines (int theStudyID);
393 void CleanPythonTrace (int theStudyID);
396 // *****************************************
398 // *****************************************
401 GEOM_Client* GetShapeReader();
404 static long GetHypothesisRootTag();
405 static long GetAlgorithmsRootTag();
406 static long GetRefOnShapeTag();
407 static long GetRefOnAppliedHypothesisTag();
408 static long GetRefOnAppliedAlgorithmsTag();
409 static long GetSubMeshOnVertexTag();
410 static long GetSubMeshOnEdgeTag();
411 static long GetSubMeshOnFaceTag();
412 static long GetSubMeshOnSolidTag();
413 static long GetSubMeshOnCompoundTag();
414 static long GetSubMeshOnWireTag();
415 static long GetSubMeshOnShellTag();
416 static long GetNodeGroupsTag();
417 static long GetEdgeGroupsTag();
418 static long GetFaceGroupsTag();
419 static long GetVolumeGroupsTag();
421 // publishing methods
422 SALOMEDS::SComponent_ptr PublishComponent(SALOMEDS::Study_ptr theStudy);
423 SALOMEDS::SObject_ptr PublishMesh (SALOMEDS::Study_ptr theStudy,
424 SMESH::SMESH_Mesh_ptr theMesh,
425 const char* theName = 0);
426 SALOMEDS::SObject_ptr PublishHypothesis (SALOMEDS::Study_ptr theStudy,
427 SMESH::SMESH_Hypothesis_ptr theHyp,
428 const char* theName = 0);
429 SALOMEDS::SObject_ptr PublishSubMesh (SALOMEDS::Study_ptr theStudy,
430 SMESH::SMESH_Mesh_ptr theMesh,
431 SMESH::SMESH_subMesh_ptr theSubMesh,
432 GEOM::GEOM_Object_ptr theShapeObject,
433 const char* theName = 0);
434 SALOMEDS::SObject_ptr PublishGroup (SALOMEDS::Study_ptr theStudy,
435 SMESH::SMESH_Mesh_ptr theMesh,
436 SMESH::SMESH_GroupBase_ptr theGroup,
437 GEOM::GEOM_Object_ptr theShapeObject,
438 const char* theName = 0);
439 bool AddHypothesisToShape(SALOMEDS::Study_ptr theStudy,
440 SMESH::SMESH_Mesh_ptr theMesh,
441 GEOM::GEOM_Object_ptr theShapeObject,
442 SMESH::SMESH_Hypothesis_ptr theHyp);
443 bool RemoveHypothesisFromShape(SALOMEDS::Study_ptr theStudy,
444 SMESH::SMESH_Mesh_ptr theMesh,
445 GEOM::GEOM_Object_ptr theShapeObject,
446 SMESH::SMESH_Hypothesis_ptr theHyp);
447 SALOMEDS::SObject_ptr GetMeshOrSubmeshByShape (SALOMEDS::Study_ptr theStudy,
448 SMESH::SMESH_Mesh_ptr theMesh,
449 GEOM::GEOM_Object_ptr theShape);
450 static void SetName(SALOMEDS::SObject_ptr theSObject,
452 const char* theDefaultName = 0);
455 StudyContext* GetCurrentStudyContext();
457 // Register an object in a StudyContext; return object id
458 int RegisterObject(CORBA::Object_ptr theObject);
460 // Return id of registered object
461 CORBA::Long GetObjectId(CORBA::Object_ptr theObject);
463 // Return an object that previously had an oldID
464 template<class TInterface>
465 typename TInterface::_var_type GetObjectByOldId( const int oldID )
467 if ( StudyContext* myStudyContext = GetCurrentStudyContext() ) {
468 string ior = myStudyContext->getIORbyOldId( oldID );
470 return TInterface::_narrow(GetORB()->string_to_object( ior.c_str() ));
472 return TInterface::_nil();
475 // Get current study ID
476 int GetCurrentStudyID()
477 { return myCurrentStudy->_is_nil() ? -1 : myCurrentStudy->StudyId(); }
480 * \brief Find SObject for an algo
482 SALOMEDS::SObject_ptr GetAlgoSO(const ::SMESH_Algo* algo);
485 // Create hypothesis of given type
486 SMESH::SMESH_Hypothesis_ptr createHypothesis( const char* theHypName,
487 const char* theLibName)
488 throw ( SALOME::SALOME_Exception );
490 // Create empty mesh on shape
491 SMESH::SMESH_Mesh_ptr createMesh()
492 throw ( SALOME::SALOME_Exception );
494 static void loadGeomData( SALOMEDS::SComponent_ptr theCompRoot );
497 static GEOM::GEOM_Gen_var myGeomGen;
498 static CORBA::ORB_var myOrb; // ORB reference
499 static PortableServer::POA_var myPoa; // POA reference
500 static SALOME_NamingService* myNS; // Naming Service
501 static SALOME_LifeCycleCORBA* myLCC; // Life Cycle CORBA
502 static SMESH_Gen_i* mySMESHGen; // Point to last created instance of the class
503 ::SMESH_Gen myGen; // SMESH_Gen local implementation
505 // hypotheses managing
506 map<string, GenericHypothesisCreator_i*> myHypCreatorMap;
508 map<int, StudyContext*> myStudyContextMap; // Map of study context objects
510 GEOM_Client* myShapeReader; // Shape reader
511 SALOMEDS::Study_var myCurrentStudy; // Current study
512 CORBA::Boolean myIsEmbeddedMode; // Current mode
514 // Dump Python: trace of API methods calls
515 std::map < int, Handle(TColStd_HSequenceOfAsciiString) > myPythonScripts;
523 DownCast(CORBA::Object_ptr theArg)
525 return dynamic_cast<T>(SMESH_Gen_i::GetServant(theArg).in());