1 // Copyright (C) 2007-2014 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, or (at your option) any later version.
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
23 #ifndef __GEOM_GEN_I_H__
24 #define __GEOM_GEN_I_H__
26 #include "GEOM_GEOM_I.hxx"
28 #include "GEOMImpl_Gen.hxx"
31 #include <SALOMEconfig.h>
32 #include CORBA_SERVER_HEADER(GEOM_Gen)
34 #include CORBA_CLIENT_HEADER(SALOMEDS)
35 #include CORBA_CLIENT_HEADER(SALOMEDS_Attributes)
38 #include "SALOME_Component_i.hxx"
39 #include "SALOME_NamingService.hxx"
41 #include "GEOM_IBasicOperations_i.hh"
42 #include "GEOM_ITransformOperations_i.hh"
43 #include "GEOM_I3DPrimOperations_i.hh"
44 #include "GEOM_IShapesOperations_i.hh"
45 #include "GEOM_IBlocksOperations_i.hh"
46 #include "GEOM_IBooleanOperations_i.hh"
47 #include "GEOM_ICurvesOperations_i.hh"
48 #include "GEOM_ILocalOperations_i.hh"
49 #include "GEOM_IHealingOperations_i.hh"
50 #include "GEOM_IInsertOperations_i.hh"
51 #include "GEOM_IMeasureOperations_i.hh"
52 #include "GEOM_IGroupOperations_i.hh"
53 #include "GEOM_IFieldOperations_i.hh"
54 #include "GEOMUtils.hxx"
56 #include <TopTools_IndexedMapOfShape.hxx>
63 //#include <Standard_ErrorHandler.hxx> // CAREFUL ! position of this file is critic : see Lucien PIGNOLONI / OCC
65 class TopTools_SequenceOfShape;
67 //=====================================================================
68 // Generic operations creator (for plugins mechanism)
69 //=====================================================================
70 class GEOM_I_EXPORT GEOM_GenericOperationsCreator
74 virtual GEOM_IOperations_i* Create (PortableServer::POA_ptr thePOA,
76 GEOM::GEOM_Gen_ptr theEngine,
77 ::GEOMImpl_Gen* theGenImpl) = 0;
78 // return the name of IDL module
79 //virtual std::string GetModuleName() = 0;
82 //=====================================================================
83 // GEOM_Gen_i : class definition
84 //=====================================================================
85 class GEOM_I_EXPORT GEOM_Gen_i: virtual public POA_GEOM::GEOM_Gen, virtual public Engines_Component_i
89 //-----------------------------------------------------------------------//
90 // Constructor / Destructor //
91 //-----------------------------------------------------------------------//
93 // constructor to be called for servant creation.
95 GEOM_Gen_i(CORBA::ORB_ptr orb,
96 PortableServer::POA_ptr poa,
97 PortableServer::ObjectId * contId,
98 const char *instanceName,
99 const char *interfaceName);
101 // destructor, doing nothing (for now)
102 virtual ~GEOM_Gen_i();
104 // generic method to be put in a super class
105 void register_name(char * name);
108 CORBA::ORB_ptr GetORB() { return CORBA::ORB::_duplicate(_orb); }
110 // Get Naming Service object
111 SALOME_NamingService* GetNS() { return name_service; }
113 //-----------------------------------------------------------------------//
114 // Inherited methods from SALOMEDS::Driver //
115 //-----------------------------------------------------------------------//
117 SALOMEDS::TMPFile* Save(SALOMEDS::SComponent_ptr theComponent,
121 SALOMEDS::TMPFile* SaveASCII(SALOMEDS::SComponent_ptr theComponent,
125 CORBA::Boolean Load(SALOMEDS::SComponent_ptr theComponent,
126 const SALOMEDS::TMPFile& theStream,
130 CORBA::Boolean LoadASCII(SALOMEDS::SComponent_ptr theComponent,
131 const SALOMEDS::TMPFile& theStream,
135 void Close(SALOMEDS::SComponent_ptr theComponent);
136 char* ComponentDataType();
139 char* IORToLocalPersistentID(SALOMEDS::SObject_ptr theSObject,
140 const char* IORString,
141 CORBA::Boolean isMultiFile,
142 CORBA::Boolean isASCII);
143 char* LocalPersistentIDToIOR(SALOMEDS::SObject_ptr theSObject,
144 const char* aLocalPersistentID,
145 CORBA::Boolean isMultiFile,
146 CORBA::Boolean isASCII);
148 bool CanPublishInStudy(CORBA::Object_ptr theIOR);
149 SALOMEDS::SObject_ptr PublishInStudy(SALOMEDS::Study_ptr theStudy,
150 SALOMEDS::SObject_ptr theSObject,
151 CORBA::Object_ptr theObject,
152 const char* theName) throw (SALOME::SALOME_Exception) ;
154 GEOM::ListOfGO* PublishNamedShapesInStudy(SALOMEDS::Study_ptr theStudy,
155 CORBA::Object_ptr theObject);
157 CORBA::Boolean CanCopy(SALOMEDS::SObject_ptr theObject);
158 SALOMEDS::TMPFile* CopyFrom(SALOMEDS::SObject_ptr theObject, CORBA::Long& theObjectID);
159 CORBA::Boolean CanPaste(const char* theComponentName, CORBA::Long theObjectID);
160 SALOMEDS::SObject_ptr PasteInto(const SALOMEDS::TMPFile& theStream,
161 CORBA::Long theObjectID,
162 SALOMEDS::SObject_ptr theObject);
164 /*! \brief Adds theObject in the study with a name = theName, if
165 * theFather is not null the object is placed under theFather
167 SALOMEDS::SObject_ptr AddInStudy (SALOMEDS::Study_ptr theStudy,
168 GEOM::GEOM_BaseObject_ptr theObject,
170 GEOM::GEOM_BaseObject_ptr theFather);
172 /*! \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments.
173 * To be used from python scripts out of geompy.addToStudy (non-default usage)
175 GEOM::ListOfGO* RestoreSubShapesO (SALOMEDS::Study_ptr theStudy,
176 GEOM::GEOM_Object_ptr theObject,
177 const GEOM::ListOfGO& theArgs,
178 GEOM::find_shape_method theFindMethod,
179 CORBA::Boolean theInheritFirstArg,
180 CORBA::Boolean theAddPrefix);
182 /*! \brief Publish sub-shapes, standing for given in \a theArgs arguments and sub-shapes.
183 * To be used from python scripts, generated by Dump Python.
185 GEOM::ListOfGO* RestoreGivenSubShapesO (SALOMEDS::Study_ptr theStudy,
186 GEOM::GEOM_Object_ptr theObject,
187 const GEOM::ListOfGO& theArgs,
188 GEOM::find_shape_method theFindMethod,
189 CORBA::Boolean theInheritFirstArg,
190 CORBA::Boolean theAddPrefix);
192 /*! \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments.
193 * To be used from GUI and from geompy.addToStudy
195 GEOM::ListOfGO* RestoreSubShapesSO (SALOMEDS::Study_ptr theStudy,
196 SALOMEDS::SObject_ptr theSObject,
197 const GEOM::ListOfGO& theArgs,
198 GEOM::find_shape_method theFindMethod,
199 CORBA::Boolean theInheritFirstArg,
200 CORBA::Boolean theAddPrefix);
202 SALOMEDS::TMPFile* GetDependencyTree(SALOMEDS::Study_ptr theStudy,
203 const GEOM::string_array& theObjectIORs);
205 //-----------------------------------------------------------------------//
206 // Transaction methods //
207 //-----------------------------------------------------------------------//
209 //Undos one transaction in the document associated with theStudyID
210 virtual void Undo(CORBA::Long theStudyID);
212 //Redos one transaction in the document associated with theStudyID
213 virtual void Redo(CORBA::Long theStudyID);
215 //-----------------------------------------------------------------------//
216 // Operations methods //
217 //-----------------------------------------------------------------------//
219 //Returns a pointer to BasicOperations interface
220 virtual GEOM::GEOM_IBasicOperations_ptr GetIBasicOperations (CORBA::Long theStudyID)
221 throw (SALOME::SALOME_Exception);
223 //Returns a pointer to TransformOperations interface
224 virtual GEOM::GEOM_ITransformOperations_ptr GetITransformOperations (CORBA::Long theStudyID)
225 throw (SALOME::SALOME_Exception);
227 //Returns a pointer to 3DPrimOperations interface
228 virtual GEOM::GEOM_I3DPrimOperations_ptr GetI3DPrimOperations (CORBA::Long theStudyID)
229 throw (SALOME::SALOME_Exception);
231 //Returns a pointer to ShapesOperations interface
232 virtual GEOM::GEOM_IShapesOperations_ptr GetIShapesOperations (CORBA::Long theStudyID)
233 throw (SALOME::SALOME_Exception);
235 //Returns a pointer to BlocksOperations interface
236 virtual GEOM::GEOM_IBlocksOperations_ptr GetIBlocksOperations (CORBA::Long theStudyID)
237 throw (SALOME::SALOME_Exception);
239 //Returns a pointer to BooleanOperations interface
240 virtual GEOM::GEOM_IBooleanOperations_ptr GetIBooleanOperations (CORBA::Long theStudyID)
241 throw (SALOME::SALOME_Exception);
243 //Returns a pointer to CurvesOperations interface
244 virtual GEOM::GEOM_ICurvesOperations_ptr GetICurvesOperations (CORBA::Long theStudyID)
245 throw (SALOME::SALOME_Exception);
247 //Returns a pointer to LocalOperations interface
248 virtual GEOM::GEOM_ILocalOperations_ptr GetILocalOperations (CORBA::Long theStudyID)
249 throw (SALOME::SALOME_Exception);
251 //Returns a pointer to HealingOperations interface
252 virtual GEOM::GEOM_IHealingOperations_ptr GetIHealingOperations (CORBA::Long theStudyID)
253 throw (SALOME::SALOME_Exception);
255 //Returns a pointer to InsertOperations interface
256 virtual GEOM::GEOM_IInsertOperations_ptr GetIInsertOperations (CORBA::Long theStudyID)
257 throw (SALOME::SALOME_Exception);
259 //Returns a pointer to MeasureOperations interface
260 virtual GEOM::GEOM_IMeasureOperations_ptr GetIMeasureOperations (CORBA::Long theStudyID)
261 throw (SALOME::SALOME_Exception);
263 //Returns a pointer to GroupOperations interface
264 virtual GEOM::GEOM_IGroupOperations_ptr GetIGroupOperations (CORBA::Long theStudyID)
265 throw (SALOME::SALOME_Exception);
267 //Returns a pointer to FiedlOperations interface
268 virtual GEOM::GEOM_IFieldOperations_ptr GetIFieldOperations (CORBA::Long theStudyID)
269 throw (SALOME::SALOME_Exception);
271 //Returns a pointer to corresponding plugin operations interface
272 virtual GEOM::GEOM_IOperations_ptr GetPluginOperations (CORBA::Long theStudyID,
273 const char* theLibName)
274 throw (SALOME::SALOME_Exception);
276 //Adds a new sub-shape
277 virtual GEOM::GEOM_Object_ptr AddSubShape (GEOM::GEOM_Object_ptr theMainShape,
278 const GEOM::ListOfLong& theIndices);
280 virtual void RemoveObject(GEOM::GEOM_BaseObject_ptr theObject);
282 virtual char* GetStringFromIOR(GEOM::GEOM_Object_ptr theObject);
284 virtual GEOM::GEOM_Object_ptr GetIORFromString(const char* stringIOR);
286 virtual Engines::TMPFile* DumpPython(CORBA::Object_ptr theStudy,
287 CORBA::Boolean isPublished,
288 CORBA::Boolean isMultiFile,
289 CORBA::Boolean& isValidScript);
291 char* GetDumpName (const char* theStudyEntry);
293 GEOM::string_array* GetAllDumpNames();
295 // Object information
296 virtual bool hasObjectInfo();
297 virtual char* getObjectInfo(CORBA::Long studyId, const char* entry);
299 // Version information
300 virtual char* getVersion();
302 // Create a new folder object
303 SALOMEDS::SObject_ptr CreateFolder(const char* theName,
304 SALOMEDS::SObject_ptr theFather);
306 // Move GEOM object to the specified folder
307 void MoveToFolder(GEOM::GEOM_Object_ptr theObject,
308 SALOMEDS::SObject_ptr theFolder);
310 // Move list of GEOM objects to the specified folder
311 void MoveListToFolder (const GEOM::ListOfGO& theListOfGO,
312 SALOMEDS::SObject_ptr theFolder);
314 // Move objects to the specified position
315 void Move( const GEOM::object_list& what,
316 SALOMEDS::SObject_ptr where,
319 // SIMAN-related functions (check out/check in) : import data to study
320 virtual Engines::ListOfIdentifiers* importData(CORBA::Long studyId,
321 Engines::DataContainer_ptr data,
322 const Engines::ListOfOptions& options);
323 // SIMAN-related functions (check out/check in) : get modified data
324 virtual Engines::ListOfData* getModifiedData(CORBA::Long studyId);
326 //-----------------------------------------------------------------------//
327 // Internal methods //
328 //-----------------------------------------------------------------------//
330 virtual GEOM::GEOM_BaseObject_ptr GetObject(CORBA::Long theStudyID, const char* theEntry);
333 GEOM::ListOfGO* RestoreSubShapes (SALOMEDS::Study_ptr theStudy,
334 GEOM::GEOM_Object_ptr theObject,
335 SALOMEDS::SObject_ptr theSObject,
336 const GEOM::ListOfGO& theArgs,
337 GEOM::find_shape_method theFindMethod,
338 CORBA::Boolean theInheritFirstArg,
339 CORBA::Boolean theAddPrefix);
341 GEOM::ListOfGO* RestoreSubShapesOneLevel (SALOMEDS::Study_ptr theStudy,
342 SALOMEDS::SObject_ptr theOldSO,
343 SALOMEDS::SObject_ptr theNewSO,
344 GEOM::GEOM_Object_ptr theNewO,
345 GEOM::ListOfGO& theOutArgs,
346 GEOM::find_shape_method theFindMethod,
347 CORBA::Boolean theAddPrefix);
349 GEOM::ListOfGO* RestoreGivenSubShapes (SALOMEDS::Study_ptr theStudy,
350 GEOM::GEOM_Object_ptr theObject,
351 SALOMEDS::SObject_ptr theSObject,
352 const GEOM::ListOfGO& theArgs,
353 GEOM::find_shape_method theFindMethod,
354 CORBA::Boolean theInheritFirstArg,
355 CORBA::Boolean theAddPrefix);
357 GEOM::ListOfGO* RestoreGivenSubShapesOneLevel (SALOMEDS::Study_ptr theStudy,
358 SALOMEDS::SObject_ptr theOldSO,
359 SALOMEDS::SObject_ptr theNewSO,
360 GEOM::GEOM_Object_ptr theNewO,
361 std::set<std::string> theArgs,
362 GEOM::find_shape_method theFindMethod,
363 CORBA::Boolean theAddPrefix);
365 // auxilary for PublishNamedShapesInStudy
366 void CreateAndPublishGroup(SALOMEDS::Study_ptr theStudy,
367 GEOM::GEOM_Object_var theMainShape,
368 const TopTools_IndexedMapOfShape& anIndices,
369 const TopTools_SequenceOfShape& SeqS,
370 const TColStd_SequenceOfAsciiString& SeqN,
371 const Standard_CString& GrName,
372 GEOM::ListOfGO_var aResList);
374 void getUpwardDependency( GEOM::GEOM_BaseObject_ptr gbo,
375 GEOMUtils::LevelsList &upLevelList,
378 void getDownwardDependency( SALOMEDS::Study_ptr theStudy,
379 GEOM::GEOM_BaseObject_ptr gbo,
380 GEOMUtils::LevelsList &downLevelList,
385 ::GEOMImpl_Gen* _impl;
386 SALOME_NamingService * name_service;
389 // plugin operations managing
390 std::map<std::string, GEOM_GenericOperationsCreator*> myOpCreatorMap;