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 );
250 * Evaluate mesh on a shape and
251 * returns statistic of mesh elements
252 * Result array of number enityties
254 SMESH::long_array* Evaluate(SMESH::SMESH_Mesh_ptr theMesh,
255 GEOM::GEOM_Object_ptr theShapeObject)
256 throw ( SALOME::SALOME_Exception );
258 // Returns true if mesh contains enough data to be computed
259 CORBA::Boolean IsReadyToCompute( SMESH::SMESH_Mesh_ptr theMesh,
260 GEOM::GEOM_Object_ptr theShapeObject )
261 throw ( SALOME::SALOME_Exception );
264 * Calculate Mesh as preview till indicated dimension on shape
265 * First, verify list of hypothesis associated with the subShape.
266 * Return mesh preview structure
268 SMESH::MeshPreviewStruct* Precompute( SMESH::SMESH_Mesh_ptr theMesh,
269 GEOM::GEOM_Object_ptr theSubObject,
270 SMESH::Dimension theDimension,
271 SMESH::long_array& theShapesId )
272 throw ( SALOME::SALOME_Exception );
274 // Returns errors of hypotheses definintion
275 SMESH::algo_error_array* GetAlgoState( SMESH::SMESH_Mesh_ptr theMesh,
276 GEOM::GEOM_Object_ptr theSubObject )
277 throw ( SALOME::SALOME_Exception );
279 // Return mesh elements preventing computation of a subshape
280 SMESH::MeshPreviewStruct* GetBadInputElements( SMESH::SMESH_Mesh_ptr theMesh,
281 CORBA::Short theSubShapeID )
282 throw ( SALOME::SALOME_Exception );
284 // Get sub-shapes unique ID's list
285 SMESH::long_array* GetSubShapesId( GEOM::GEOM_Object_ptr theMainShapeObject,
286 const SMESH::object_array& theListOfSubShape )
287 throw ( SALOME::SALOME_Exception );
289 // Return geometrical object the given element is built on. Publish it in study.
290 GEOM::GEOM_Object_ptr GetGeometryByMeshElement( SMESH::SMESH_Mesh_ptr theMesh,
291 CORBA::Long theElementID,
292 const char* theGeomName)
293 throw ( SALOME::SALOME_Exception );
295 // Return geometrical object the given element is built on. Don't publish it in study.
296 GEOM::GEOM_Object_ptr FindGeometryByMeshElement( SMESH::SMESH_Mesh_ptr theMesh,
297 CORBA::Long theElementID)
298 throw ( SALOME::SALOME_Exception );
300 // Concatenate the given meshes into one mesh
301 SMESH::SMESH_Mesh_ptr ConcatenateCommon(const SMESH::mesh_array& theMeshesArray,
302 CORBA::Boolean theUniteIdenticalGroups,
303 CORBA::Boolean theMergeNodesAndElements,
304 CORBA::Double theMergeTolerance,
305 CORBA::Boolean theCommonGroups)
306 throw ( SALOME::SALOME_Exception );
308 // Concatenate the given meshes into one mesh
309 SMESH::SMESH_Mesh_ptr Concatenate(const SMESH::mesh_array& theMeshesArray,
310 CORBA::Boolean theUniteIdenticalGroups,
311 CORBA::Boolean theMergeNodesAndElements,
312 CORBA::Double theMergeTolerance)
313 throw ( SALOME::SALOME_Exception );
315 // Concatenate the given meshes into one mesh
316 // Create the groups of all elements from initial meshes
317 SMESH::SMESH_Mesh_ptr ConcatenateWithGroups(const SMESH::mesh_array& theMeshesArray,
318 CORBA::Boolean theUniteIdenticalGroups,
319 CORBA::Boolean theMergeNodesAndElements,
320 CORBA::Double theMergeTolerance)
321 throw ( SALOME::SALOME_Exception );
323 // ****************************************************
324 // Interface inherited methods (from SALOMEDS::Driver)
325 // ****************************************************
328 SALOMEDS::TMPFile* Save( SALOMEDS::SComponent_ptr theComponent,
332 bool Load( SALOMEDS::SComponent_ptr theComponent,
333 const SALOMEDS::TMPFile& theStream,
336 // Save SMESH data in ASCII format
337 SALOMEDS::TMPFile* SaveASCII( SALOMEDS::SComponent_ptr theComponent,
340 // Load SMESH data in ASCII format
341 bool LoadASCII( SALOMEDS::SComponent_ptr theComponent,
342 const SALOMEDS::TMPFile& theStream,
346 // Create filter manager
347 SMESH::FilterManager_ptr CreateFilterManager();
349 // Return a pattern mesher
350 SMESH::SMESH_Pattern_ptr GetPattern();
352 // Clears study-connected data when it is closed
353 void Close( SALOMEDS::SComponent_ptr theComponent );
355 // Get component data type
356 char* ComponentDataType();
358 // Transform data from transient form to persistent
359 char* IORToLocalPersistentID( SALOMEDS::SObject_ptr theSObject,
360 const char* IORString,
361 CORBA::Boolean isMultiFile,
362 CORBA::Boolean isASCII );
363 // Transform data from persistent form to transient
364 char* LocalPersistentIDToIOR( SALOMEDS::SObject_ptr theSObject,
365 const char* aLocalPersistentID,
366 CORBA::Boolean isMultiFile,
367 CORBA::Boolean isASCII );
369 // Returns true if object can be published in the study
370 bool CanPublishInStudy( CORBA::Object_ptr theIOR );
371 // Publish object in the study
372 SALOMEDS::SObject_ptr PublishInStudy( SALOMEDS::Study_ptr theStudy,
373 SALOMEDS::SObject_ptr theSObject,
374 CORBA::Object_ptr theObject,
375 const char* theName )
376 throw ( SALOME::SALOME_Exception );
378 // Copy-paste methods - returns true if object can be copied to the clipboard
379 CORBA::Boolean CanCopy( SALOMEDS::SObject_ptr theObject ) { return false; }
380 // Copy-paste methods - copy object to the clipboard
381 SALOMEDS::TMPFile* CopyFrom( SALOMEDS::SObject_ptr theObject, CORBA::Long& theObjectID ) { return false; }
382 // Copy-paste methods - returns true if object can be pasted from the clipboard
383 CORBA::Boolean CanPaste( const char* theComponentName, CORBA::Long theObjectID ) { return false; }
384 // Copy-paste methods - paste object from the clipboard
385 SALOMEDS::SObject_ptr PasteInto( const SALOMEDS::TMPFile& theStream,
386 CORBA::Long theObjectID,
387 SALOMEDS::SObject_ptr theObject ) {
388 SALOMEDS::SObject_var aResultSO;
389 return aResultSO._retn();
396 virtual Engines::TMPFile* DumpPython(CORBA::Object_ptr theStudy,
397 CORBA::Boolean isPublished,
398 CORBA::Boolean& isValidScript);
400 void AddToPythonScript (int theStudyID, const TCollection_AsciiString& theString);
402 void RemoveLastFromPythonScript (int theStudyID);
404 void SavePython (SALOMEDS::Study_ptr theStudy);
406 TCollection_AsciiString DumpPython_impl (SALOMEDS::Study_ptr theStudy,
407 Resource_DataMapOfAsciiStringAsciiString& theObjectNames,
408 Resource_DataMapOfAsciiStringAsciiString& theNames,
411 const TCollection_AsciiString& theSavedTrace);
413 TCollection_AsciiString GetNewPythonLines (int theStudyID);
415 void CleanPythonTrace (int theStudyID);
418 // *****************************************
420 // *****************************************
423 GEOM_Client* GetShapeReader();
426 static long GetHypothesisRootTag();
427 static long GetAlgorithmsRootTag();
428 static long GetRefOnShapeTag();
429 static long GetRefOnAppliedHypothesisTag();
430 static long GetRefOnAppliedAlgorithmsTag();
431 static long GetSubMeshOnVertexTag();
432 static long GetSubMeshOnEdgeTag();
433 static long GetSubMeshOnFaceTag();
434 static long GetSubMeshOnSolidTag();
435 static long GetSubMeshOnCompoundTag();
436 static long GetSubMeshOnWireTag();
437 static long GetSubMeshOnShellTag();
438 static long GetNodeGroupsTag();
439 static long GetEdgeGroupsTag();
440 static long GetFaceGroupsTag();
441 static long GetVolumeGroupsTag();
443 // publishing methods
444 SALOMEDS::SComponent_ptr PublishComponent(SALOMEDS::Study_ptr theStudy);
445 SALOMEDS::SObject_ptr PublishMesh (SALOMEDS::Study_ptr theStudy,
446 SMESH::SMESH_Mesh_ptr theMesh,
447 const char* theName = 0);
448 SALOMEDS::SObject_ptr PublishHypothesis (SALOMEDS::Study_ptr theStudy,
449 SMESH::SMESH_Hypothesis_ptr theHyp,
450 const char* theName = 0);
451 SALOMEDS::SObject_ptr PublishSubMesh (SALOMEDS::Study_ptr theStudy,
452 SMESH::SMESH_Mesh_ptr theMesh,
453 SMESH::SMESH_subMesh_ptr theSubMesh,
454 GEOM::GEOM_Object_ptr theShapeObject,
455 const char* theName = 0);
456 SALOMEDS::SObject_ptr PublishGroup (SALOMEDS::Study_ptr theStudy,
457 SMESH::SMESH_Mesh_ptr theMesh,
458 SMESH::SMESH_GroupBase_ptr theGroup,
459 GEOM::GEOM_Object_ptr theShapeObject,
460 const char* theName = 0);
461 bool AddHypothesisToShape(SALOMEDS::Study_ptr theStudy,
462 SMESH::SMESH_Mesh_ptr theMesh,
463 GEOM::GEOM_Object_ptr theShapeObject,
464 SMESH::SMESH_Hypothesis_ptr theHyp);
465 bool RemoveHypothesisFromShape(SALOMEDS::Study_ptr theStudy,
466 SMESH::SMESH_Mesh_ptr theMesh,
467 GEOM::GEOM_Object_ptr theShapeObject,
468 SMESH::SMESH_Hypothesis_ptr theHyp);
469 SALOMEDS::SObject_ptr GetMeshOrSubmeshByShape (SALOMEDS::Study_ptr theStudy,
470 SMESH::SMESH_Mesh_ptr theMesh,
471 GEOM::GEOM_Object_ptr theShape);
472 static void SetName(SALOMEDS::SObject_ptr theSObject,
474 const char* theDefaultName = 0);
476 static void SetPixMap(SALOMEDS::SObject_ptr theSObject,
477 const char* thePixMap);
480 StudyContext* GetCurrentStudyContext();
482 // Register an object in a StudyContext; return object id
483 int RegisterObject(CORBA::Object_ptr theObject);
485 // Return id of registered object
486 CORBA::Long GetObjectId(CORBA::Object_ptr theObject);
488 // Return an object that previously had an oldID
489 template<class TInterface>
490 typename TInterface::_var_type GetObjectByOldId( const int oldID )
492 if ( StudyContext* myStudyContext = GetCurrentStudyContext() ) {
493 string ior = myStudyContext->getIORbyOldId( oldID );
495 return TInterface::_narrow(GetORB()->string_to_object( ior.c_str() ));
497 return TInterface::_nil();
500 // Get current study ID
501 int GetCurrentStudyID();
504 * \brief Find SObject for an algo
506 SALOMEDS::SObject_ptr GetAlgoSO(const ::SMESH_Algo* algo);
508 void UpdateParameters(CORBA::Object_ptr theObject, const char* theParameters);
509 char* GetParameters(CORBA::Object_ptr theObject);
510 char* ParseParameters(const char* theParameters);
514 // Create hypothesis of given type
515 SMESH::SMESH_Hypothesis_ptr createHypothesis( const char* theHypName,
516 const char* theLibName)
517 throw ( SALOME::SALOME_Exception );
519 // Create empty mesh on shape
520 SMESH::SMESH_Mesh_ptr createMesh()
521 throw ( SALOME::SALOME_Exception );
523 static void loadGeomData( SALOMEDS::SComponent_ptr theCompRoot );
526 static GEOM::GEOM_Gen_var myGeomGen;
527 static CORBA::ORB_var myOrb; // ORB reference
528 static PortableServer::POA_var myPoa; // POA reference
529 static SALOME_NamingService* myNS; // Naming Service
530 static SALOME_LifeCycleCORBA* myLCC; // Life Cycle CORBA
531 static SMESH_Gen_i* mySMESHGen; // Point to last created instance of the class
532 ::SMESH_Gen myGen; // SMESH_Gen local implementation
534 // hypotheses managing
535 map<string, GenericHypothesisCreator_i*> myHypCreatorMap;
537 map<int, StudyContext*> myStudyContextMap; // Map of study context objects
539 GEOM_Client* myShapeReader; // Shape reader
540 SALOMEDS::Study_var myCurrentStudy; // Current study
541 CORBA::Boolean myIsEmbeddedMode; // Current mode
543 // Dump Python: trace of API methods calls
544 std::map < int, Handle(TColStd_HSequenceOfAsciiString) > myPythonScripts;
552 DownCast(CORBA::Object_ptr theArg)
554 return dynamic_cast<T>(SMESH_Gen_i::GetServant(theArg).in());