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"
55 #include <TopTools_IndexedMapOfShape.hxx>
61 //#include <Standard_ErrorHandler.hxx> // CAREFUL ! position of this file is critic : see Lucien PIGNOLONI / OCC
63 class TopTools_SequenceOfShape;
65 //=====================================================================
66 // Generic operations creator (for plugins mechanism)
67 //=====================================================================
68 class GEOM_I_EXPORT GEOM_GenericOperationsCreator
72 virtual GEOM_IOperations_i* Create (PortableServer::POA_ptr thePOA,
74 GEOM::GEOM_Gen_ptr theEngine,
75 ::GEOMImpl_Gen* theGenImpl) = 0;
76 // return the name of IDL module
77 //virtual std::string GetModuleName() = 0;
80 //=====================================================================
81 // GEOM_Gen_i : class definition
82 //=====================================================================
83 class GEOM_I_EXPORT GEOM_Gen_i: virtual public POA_GEOM::GEOM_Gen, virtual public Engines_Component_i
87 //-----------------------------------------------------------------------//
88 // Constructor / Destructor //
89 //-----------------------------------------------------------------------//
91 // constructor to be called for servant creation.
93 GEOM_Gen_i(CORBA::ORB_ptr orb,
94 PortableServer::POA_ptr poa,
95 PortableServer::ObjectId * contId,
96 const char *instanceName,
97 const char *interfaceName);
99 // destructor, doing nothing (for now)
100 virtual ~GEOM_Gen_i();
102 // generic method to be put in a super class
103 void register_name(char * name);
106 CORBA::ORB_ptr GetORB() { return CORBA::ORB::_duplicate(_orb); }
108 // Get Naming Service object
109 SALOME_NamingService* GetNS() { return name_service; }
111 //-----------------------------------------------------------------------//
112 // Inherited methods from SALOMEDS::Driver //
113 //-----------------------------------------------------------------------//
115 SALOMEDS::TMPFile* Save(SALOMEDS::SComponent_ptr theComponent,
119 SALOMEDS::TMPFile* SaveASCII(SALOMEDS::SComponent_ptr theComponent,
123 CORBA::Boolean Load(SALOMEDS::SComponent_ptr theComponent,
124 const SALOMEDS::TMPFile& theStream,
128 CORBA::Boolean LoadASCII(SALOMEDS::SComponent_ptr theComponent,
129 const SALOMEDS::TMPFile& theStream,
133 void Close(SALOMEDS::SComponent_ptr theComponent);
134 char* ComponentDataType();
137 char* IORToLocalPersistentID(SALOMEDS::SObject_ptr theSObject,
138 const char* IORString,
139 CORBA::Boolean isMultiFile,
140 CORBA::Boolean isASCII);
141 char* LocalPersistentIDToIOR(SALOMEDS::SObject_ptr theSObject,
142 const char* aLocalPersistentID,
143 CORBA::Boolean isMultiFile,
144 CORBA::Boolean isASCII);
146 bool CanPublishInStudy(CORBA::Object_ptr theIOR);
147 SALOMEDS::SObject_ptr PublishInStudy(SALOMEDS::Study_ptr theStudy,
148 SALOMEDS::SObject_ptr theSObject,
149 CORBA::Object_ptr theObject,
150 const char* theName) throw (SALOME::SALOME_Exception) ;
152 GEOM::ListOfGO* PublishNamedShapesInStudy(SALOMEDS::Study_ptr theStudy,
153 CORBA::Object_ptr theObject);
155 CORBA::Boolean CanCopy(SALOMEDS::SObject_ptr theObject);
156 SALOMEDS::TMPFile* CopyFrom(SALOMEDS::SObject_ptr theObject, CORBA::Long& theObjectID);
157 CORBA::Boolean CanPaste(const char* theComponentName, CORBA::Long theObjectID);
158 SALOMEDS::SObject_ptr PasteInto(const SALOMEDS::TMPFile& theStream,
159 CORBA::Long theObjectID,
160 SALOMEDS::SObject_ptr theObject);
162 /*! \brief Adds theObject in the study with a name = theName, if
163 * theFather is not null the object is placed under theFather
165 SALOMEDS::SObject_ptr AddInStudy (SALOMEDS::Study_ptr theStudy,
166 GEOM::GEOM_BaseObject_ptr theObject,
168 GEOM::GEOM_BaseObject_ptr theFather);
170 /*! \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments.
171 * To be used from python scripts out of geompy.addToStudy (non-default usage)
173 GEOM::ListOfGO* RestoreSubShapesO (SALOMEDS::Study_ptr theStudy,
174 GEOM::GEOM_Object_ptr theObject,
175 const GEOM::ListOfGO& theArgs,
176 GEOM::find_shape_method theFindMethod,
177 CORBA::Boolean theInheritFirstArg,
178 CORBA::Boolean theAddPrefix);
180 /*! \brief Publish sub-shapes, standing for given in \a theArgs arguments and sub-shapes.
181 * To be used from python scripts, generated by Dump Python.
183 GEOM::ListOfGO* RestoreGivenSubShapesO (SALOMEDS::Study_ptr theStudy,
184 GEOM::GEOM_Object_ptr theObject,
185 const GEOM::ListOfGO& theArgs,
186 GEOM::find_shape_method theFindMethod,
187 CORBA::Boolean theInheritFirstArg,
188 CORBA::Boolean theAddPrefix);
190 /*! \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments.
191 * To be used from GUI and from geompy.addToStudy
193 GEOM::ListOfGO* RestoreSubShapesSO (SALOMEDS::Study_ptr theStudy,
194 SALOMEDS::SObject_ptr theSObject,
195 const GEOM::ListOfGO& theArgs,
196 GEOM::find_shape_method theFindMethod,
197 CORBA::Boolean theInheritFirstArg,
198 CORBA::Boolean theAddPrefix);
200 SALOMEDS::TMPFile* GetDependencyTree(const GEOM::string_array&);
202 //-----------------------------------------------------------------------//
203 // Transaction methods //
204 //-----------------------------------------------------------------------//
206 //Undos one transaction in the document associated with theStudyID
207 virtual void Undo(CORBA::Long theStudyID);
209 //Redos one transaction in the document associated with theStudyID
210 virtual void Redo(CORBA::Long theStudyID);
212 //-----------------------------------------------------------------------//
213 // Operations methods //
214 //-----------------------------------------------------------------------//
216 //Returns a pointer to BasicOperations interface
217 virtual GEOM::GEOM_IBasicOperations_ptr GetIBasicOperations (CORBA::Long theStudyID)
218 throw (SALOME::SALOME_Exception);
220 //Returns a pointer to TransformOperations interface
221 virtual GEOM::GEOM_ITransformOperations_ptr GetITransformOperations (CORBA::Long theStudyID)
222 throw (SALOME::SALOME_Exception);
224 //Returns a pointer to 3DPrimOperations interface
225 virtual GEOM::GEOM_I3DPrimOperations_ptr GetI3DPrimOperations (CORBA::Long theStudyID)
226 throw (SALOME::SALOME_Exception);
228 //Returns a pointer to ShapesOperations interface
229 virtual GEOM::GEOM_IShapesOperations_ptr GetIShapesOperations (CORBA::Long theStudyID)
230 throw (SALOME::SALOME_Exception);
232 //Returns a pointer to BlocksOperations interface
233 virtual GEOM::GEOM_IBlocksOperations_ptr GetIBlocksOperations (CORBA::Long theStudyID)
234 throw (SALOME::SALOME_Exception);
236 //Returns a pointer to BooleanOperations interface
237 virtual GEOM::GEOM_IBooleanOperations_ptr GetIBooleanOperations (CORBA::Long theStudyID)
238 throw (SALOME::SALOME_Exception);
240 //Returns a pointer to CurvesOperations interface
241 virtual GEOM::GEOM_ICurvesOperations_ptr GetICurvesOperations (CORBA::Long theStudyID)
242 throw (SALOME::SALOME_Exception);
244 //Returns a pointer to LocalOperations interface
245 virtual GEOM::GEOM_ILocalOperations_ptr GetILocalOperations (CORBA::Long theStudyID)
246 throw (SALOME::SALOME_Exception);
248 //Returns a pointer to HealingOperations interface
249 virtual GEOM::GEOM_IHealingOperations_ptr GetIHealingOperations (CORBA::Long theStudyID)
250 throw (SALOME::SALOME_Exception);
252 //Returns a pointer to InsertOperations interface
253 virtual GEOM::GEOM_IInsertOperations_ptr GetIInsertOperations (CORBA::Long theStudyID)
254 throw (SALOME::SALOME_Exception);
256 //Returns a pointer to MeasureOperations interface
257 virtual GEOM::GEOM_IMeasureOperations_ptr GetIMeasureOperations (CORBA::Long theStudyID)
258 throw (SALOME::SALOME_Exception);
260 //Returns a pointer to GroupOperations interface
261 virtual GEOM::GEOM_IGroupOperations_ptr GetIGroupOperations (CORBA::Long theStudyID)
262 throw (SALOME::SALOME_Exception);
264 //Returns a pointer to FiedlOperations interface
265 virtual GEOM::GEOM_IFieldOperations_ptr GetIFieldOperations (CORBA::Long theStudyID)
266 throw (SALOME::SALOME_Exception);
268 //Returns a pointer to corresponding plugin operations interface
269 virtual GEOM::GEOM_IOperations_ptr GetPluginOperations (CORBA::Long theStudyID,
270 const char* theLibName)
271 throw (SALOME::SALOME_Exception);
273 //Adds a new sub-shape
274 virtual GEOM::GEOM_Object_ptr AddSubShape (GEOM::GEOM_Object_ptr theMainShape,
275 const GEOM::ListOfLong& theIndices);
277 virtual void RemoveObject(GEOM::GEOM_BaseObject_ptr theObject);
279 virtual char* GetStringFromIOR(GEOM::GEOM_Object_ptr theObject);
281 virtual GEOM::GEOM_Object_ptr GetIORFromString(const char* stringIOR);
283 virtual Engines::TMPFile* DumpPython(CORBA::Object_ptr theStudy,
284 CORBA::Boolean isPublished,
285 CORBA::Boolean isMultiFile,
286 CORBA::Boolean& isValidScript);
288 char* GetDumpName (const char* theStudyEntry);
290 GEOM::string_array* GetAllDumpNames();
292 // Object information
293 virtual bool hasObjectInfo();
294 virtual char* getObjectInfo(CORBA::Long studyId, const char* entry);
296 // Version information
297 virtual char* getVersion();
299 // Create a new folder object
300 SALOMEDS::SObject_ptr CreateFolder(const char* theName,
301 SALOMEDS::SObject_ptr theFather);
303 // Move GEOM object to the specified folder
304 void MoveToFolder(GEOM::GEOM_Object_ptr theObject,
305 SALOMEDS::SObject_ptr theFolder);
307 // Move list of GEOM objects to the specified folder
308 void MoveListToFolder (const GEOM::ListOfGO& theListOfGO,
309 SALOMEDS::SObject_ptr theFolder);
311 // Move objects to the specified position
312 void Move( const GEOM::object_list& what,
313 SALOMEDS::SObject_ptr where,
316 // SIMAN-related functions (check out/check in) : import data to study
317 virtual Engines::ListOfIdentifiers* importData(CORBA::Long studyId,
318 Engines::DataContainer_ptr data,
319 const Engines::ListOfOptions& options);
320 // SIMAN-related functions (check out/check in) : get modified data
321 virtual Engines::ListOfData* getModifiedData(CORBA::Long studyId);
323 //-----------------------------------------------------------------------//
324 // Internal methods //
325 //-----------------------------------------------------------------------//
327 virtual GEOM::GEOM_BaseObject_ptr GetObject(CORBA::Long theStudyID, const char* theEntry);
330 GEOM::ListOfGO* RestoreSubShapes (SALOMEDS::Study_ptr theStudy,
331 GEOM::GEOM_Object_ptr theObject,
332 SALOMEDS::SObject_ptr theSObject,
333 const GEOM::ListOfGO& theArgs,
334 GEOM::find_shape_method theFindMethod,
335 CORBA::Boolean theInheritFirstArg,
336 CORBA::Boolean theAddPrefix);
338 GEOM::ListOfGO* RestoreSubShapesOneLevel (SALOMEDS::Study_ptr theStudy,
339 SALOMEDS::SObject_ptr theOldSO,
340 SALOMEDS::SObject_ptr theNewSO,
341 GEOM::GEOM_Object_ptr theNewO,
342 GEOM::ListOfGO& theOutArgs,
343 GEOM::find_shape_method theFindMethod,
344 CORBA::Boolean theAddPrefix);
346 GEOM::ListOfGO* RestoreGivenSubShapes (SALOMEDS::Study_ptr theStudy,
347 GEOM::GEOM_Object_ptr theObject,
348 SALOMEDS::SObject_ptr theSObject,
349 const GEOM::ListOfGO& theArgs,
350 GEOM::find_shape_method theFindMethod,
351 CORBA::Boolean theInheritFirstArg,
352 CORBA::Boolean theAddPrefix);
354 GEOM::ListOfGO* RestoreGivenSubShapesOneLevel (SALOMEDS::Study_ptr theStudy,
355 SALOMEDS::SObject_ptr theOldSO,
356 SALOMEDS::SObject_ptr theNewSO,
357 GEOM::GEOM_Object_ptr theNewO,
358 std::set<std::string> theArgs,
359 GEOM::find_shape_method theFindMethod,
360 CORBA::Boolean theAddPrefix);
362 // auxilary for PublishNamedShapesInStudy
363 void CreateAndPublishGroup(SALOMEDS::Study_ptr theStudy,
364 GEOM::GEOM_Object_var theMainShape,
365 const TopTools_IndexedMapOfShape& anIndices,
366 const TopTools_SequenceOfShape& SeqS,
367 const TColStd_SequenceOfAsciiString& SeqN,
368 const Standard_CString& GrName,
369 GEOM::ListOfGO_var aResList);
373 ::GEOMImpl_Gen* _impl;
374 SALOME_NamingService * name_service;
377 // plugin operations managing
378 std::map<std::string, GEOM_GenericOperationsCreator*> myOpCreatorMap;