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 );
241 // Returns errors of hypotheses definintion
242 SMESH::algo_error_array* GetAlgoState( SMESH::SMESH_Mesh_ptr theMesh,
243 GEOM::GEOM_Object_ptr theSubObject )
244 throw ( SALOME::SALOME_Exception );
246 // Get sub-shapes unique ID's list
247 SMESH::long_array* GetSubShapesId( GEOM::GEOM_Object_ptr theMainShapeObject,
248 const SMESH::object_array& theListOfSubShape )
249 throw ( SALOME::SALOME_Exception );
251 // Return geometrical object the given element is built on. Publish it in study.
252 GEOM::GEOM_Object_ptr GetGeometryByMeshElement( SMESH::SMESH_Mesh_ptr theMesh,
253 CORBA::Long theElementID,
254 const char* theGeomName)
255 throw ( SALOME::SALOME_Exception );
257 // Return geometrical object the given element is built on. Don't publish it in study.
258 GEOM::GEOM_Object_ptr FindGeometryByMeshElement( SMESH::SMESH_Mesh_ptr theMesh,
259 CORBA::Long theElementID)
260 throw ( SALOME::SALOME_Exception );
262 // Concatenate the given meshes into one mesh
263 SMESH::SMESH_Mesh_ptr ConcatenateCommon(const SMESH::mesh_array& theMeshesArray,
264 CORBA::Boolean theUniteIdenticalGroups,
265 CORBA::Boolean theMergeNodesAndElements,
266 CORBA::Double theMergeTolerance,
267 CORBA::Boolean theCommonGroups)
268 throw ( SALOME::SALOME_Exception );
270 // Concatenate the given meshes into one mesh
271 SMESH::SMESH_Mesh_ptr Concatenate(const SMESH::mesh_array& theMeshesArray,
272 CORBA::Boolean theUniteIdenticalGroups,
273 CORBA::Boolean theMergeNodesAndElements,
274 CORBA::Double theMergeTolerance)
275 throw ( SALOME::SALOME_Exception );
277 // Concatenate the given meshes into one mesh
278 // Create the groups of all elements from initial meshes
279 SMESH::SMESH_Mesh_ptr ConcatenateWithGroups(const SMESH::mesh_array& theMeshesArray,
280 CORBA::Boolean theUniteIdenticalGroups,
281 CORBA::Boolean theMergeNodesAndElements,
282 CORBA::Double theMergeTolerance)
283 throw ( SALOME::SALOME_Exception );
285 // ****************************************************
286 // Interface inherited methods (from SALOMEDS::Driver)
287 // ****************************************************
290 SALOMEDS::TMPFile* Save( SALOMEDS::SComponent_ptr theComponent,
294 bool Load( SALOMEDS::SComponent_ptr theComponent,
295 const SALOMEDS::TMPFile& theStream,
298 // Save SMESH data in ASCII format
299 SALOMEDS::TMPFile* SaveASCII( SALOMEDS::SComponent_ptr theComponent,
302 // Load SMESH data in ASCII format
303 bool LoadASCII( SALOMEDS::SComponent_ptr theComponent,
304 const SALOMEDS::TMPFile& theStream,
308 // Create filter manager
309 SMESH::FilterManager_ptr CreateFilterManager();
311 // Return a pattern mesher
312 SMESH::SMESH_Pattern_ptr GetPattern();
314 // Clears study-connected data when it is closed
315 void Close( SALOMEDS::SComponent_ptr theComponent );
317 // Get component data type
318 char* ComponentDataType();
320 // Transform data from transient form to persistent
321 char* IORToLocalPersistentID( SALOMEDS::SObject_ptr theSObject,
322 const char* IORString,
323 CORBA::Boolean isMultiFile,
324 CORBA::Boolean isASCII );
325 // Transform data from persistent form to transient
326 char* LocalPersistentIDToIOR( SALOMEDS::SObject_ptr theSObject,
327 const char* aLocalPersistentID,
328 CORBA::Boolean isMultiFile,
329 CORBA::Boolean isASCII );
331 // Returns true if object can be published in the study
332 bool CanPublishInStudy( CORBA::Object_ptr theIOR );
333 // Publish object in the study
334 SALOMEDS::SObject_ptr PublishInStudy( SALOMEDS::Study_ptr theStudy,
335 SALOMEDS::SObject_ptr theSObject,
336 CORBA::Object_ptr theObject,
337 const char* theName )
338 throw ( SALOME::SALOME_Exception );
340 // Copy-paste methods - returns true if object can be copied to the clipboard
341 CORBA::Boolean CanCopy( SALOMEDS::SObject_ptr theObject ) { return false; }
342 // Copy-paste methods - copy object to the clipboard
343 SALOMEDS::TMPFile* CopyFrom( SALOMEDS::SObject_ptr theObject, CORBA::Long& theObjectID ) { return false; }
344 // Copy-paste methods - returns true if object can be pasted from the clipboard
345 CORBA::Boolean CanPaste( const char* theComponentName, CORBA::Long theObjectID ) { return false; }
346 // Copy-paste methods - paste object from the clipboard
347 SALOMEDS::SObject_ptr PasteInto( const SALOMEDS::TMPFile& theStream,
348 CORBA::Long theObjectID,
349 SALOMEDS::SObject_ptr theObject ) {
350 SALOMEDS::SObject_var aResultSO;
351 return aResultSO._retn();
358 virtual Engines::TMPFile* DumpPython(CORBA::Object_ptr theStudy,
359 CORBA::Boolean isPublished,
360 CORBA::Boolean& isValidScript);
362 void AddToPythonScript (int theStudyID, const TCollection_AsciiString& theString);
364 void RemoveLastFromPythonScript (int theStudyID);
366 void SavePython (SALOMEDS::Study_ptr theStudy);
368 TCollection_AsciiString DumpPython_impl (int theStudyID,
369 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
370 Resource_DataMapOfAsciiStringAsciiString& theNames,
373 const TCollection_AsciiString& theSavedTrace);
375 TCollection_AsciiString GetNewPythonLines (int theStudyID);
377 void CleanPythonTrace (int theStudyID);
380 // *****************************************
382 // *****************************************
385 GEOM_Client* GetShapeReader();
388 static long GetHypothesisRootTag();
389 static long GetAlgorithmsRootTag();
390 static long GetRefOnShapeTag();
391 static long GetRefOnAppliedHypothesisTag();
392 static long GetRefOnAppliedAlgorithmsTag();
393 static long GetSubMeshOnVertexTag();
394 static long GetSubMeshOnEdgeTag();
395 static long GetSubMeshOnFaceTag();
396 static long GetSubMeshOnSolidTag();
397 static long GetSubMeshOnCompoundTag();
398 static long GetSubMeshOnWireTag();
399 static long GetSubMeshOnShellTag();
400 static long GetNodeGroupsTag();
401 static long GetEdgeGroupsTag();
402 static long GetFaceGroupsTag();
403 static long GetVolumeGroupsTag();
405 // publishing methods
406 SALOMEDS::SComponent_ptr PublishComponent(SALOMEDS::Study_ptr theStudy);
407 SALOMEDS::SObject_ptr PublishMesh (SALOMEDS::Study_ptr theStudy,
408 SMESH::SMESH_Mesh_ptr theMesh,
409 const char* theName = 0);
410 SALOMEDS::SObject_ptr PublishHypothesis (SALOMEDS::Study_ptr theStudy,
411 SMESH::SMESH_Hypothesis_ptr theHyp,
412 const char* theName = 0);
413 SALOMEDS::SObject_ptr PublishSubMesh (SALOMEDS::Study_ptr theStudy,
414 SMESH::SMESH_Mesh_ptr theMesh,
415 SMESH::SMESH_subMesh_ptr theSubMesh,
416 GEOM::GEOM_Object_ptr theShapeObject,
417 const char* theName = 0);
418 SALOMEDS::SObject_ptr PublishGroup (SALOMEDS::Study_ptr theStudy,
419 SMESH::SMESH_Mesh_ptr theMesh,
420 SMESH::SMESH_GroupBase_ptr theGroup,
421 GEOM::GEOM_Object_ptr theShapeObject,
422 const char* theName = 0);
423 bool AddHypothesisToShape(SALOMEDS::Study_ptr theStudy,
424 SMESH::SMESH_Mesh_ptr theMesh,
425 GEOM::GEOM_Object_ptr theShapeObject,
426 SMESH::SMESH_Hypothesis_ptr theHyp);
427 bool RemoveHypothesisFromShape(SALOMEDS::Study_ptr theStudy,
428 SMESH::SMESH_Mesh_ptr theMesh,
429 GEOM::GEOM_Object_ptr theShapeObject,
430 SMESH::SMESH_Hypothesis_ptr theHyp);
431 SALOMEDS::SObject_ptr GetMeshOrSubmeshByShape (SALOMEDS::Study_ptr theStudy,
432 SMESH::SMESH_Mesh_ptr theMesh,
433 GEOM::GEOM_Object_ptr theShape);
434 static void SetName(SALOMEDS::SObject_ptr theSObject,
436 const char* theDefaultName = 0);
439 StudyContext* GetCurrentStudyContext();
441 // Register an object in a StudyContext; return object id
442 int RegisterObject(CORBA::Object_ptr theObject);
444 // Return id of registered object
445 CORBA::Long GetObjectId(CORBA::Object_ptr theObject);
447 // Return an object that previously had an oldID
448 template<class TInterface>
449 typename TInterface::_var_type GetObjectByOldId( const int oldID )
451 if ( StudyContext* myStudyContext = GetCurrentStudyContext() ) {
452 string ior = myStudyContext->getIORbyOldId( oldID );
454 return TInterface::_narrow(GetORB()->string_to_object( ior.c_str() ));
456 return TInterface::_nil();
459 // Get current study ID
460 int GetCurrentStudyID()
461 { return myCurrentStudy->_is_nil() ? -1 : myCurrentStudy->StudyId(); }
464 * \brief Find SObject for an algo
466 SALOMEDS::SObject_ptr GetAlgoSO(const ::SMESH_Algo* algo);
469 // Create hypothesis of given type
470 SMESH::SMESH_Hypothesis_ptr createHypothesis( const char* theHypName,
471 const char* theLibName)
472 throw ( SALOME::SALOME_Exception );
474 // Create empty mesh on shape
475 SMESH::SMESH_Mesh_ptr createMesh()
476 throw ( SALOME::SALOME_Exception );
478 static void loadGeomData( SALOMEDS::SComponent_ptr theCompRoot );
481 static GEOM::GEOM_Gen_var myGeomGen;
482 static CORBA::ORB_var myOrb; // ORB reference
483 static PortableServer::POA_var myPoa; // POA reference
484 static SALOME_NamingService* myNS; // Naming Service
485 static SALOME_LifeCycleCORBA* myLCC; // Life Cycle CORBA
486 static SMESH_Gen_i* mySMESHGen; // Point to last created instance of the class
487 ::SMESH_Gen myGen; // SMESH_Gen local implementation
489 // hypotheses managing
490 map<string, GenericHypothesisCreator_i*> myHypCreatorMap;
492 map<int, StudyContext*> myStudyContextMap; // Map of study context objects
494 GEOM_Client* myShapeReader; // Shape reader
495 SALOMEDS::Study_var myCurrentStudy; // Current study
496 CORBA::Boolean myIsEmbeddedMode; // Current mode
498 // Dump Python: trace of API methods calls
499 std::map < int, Handle(TColStd_HSequenceOfAsciiString) > myPythonScripts;
507 DownCast(CORBA::Object_ptr theArg)
509 return dynamic_cast<T>(SMESH_Gen_i::GetServant(theArg).in());