1 // Copyright (C) 2007-2010 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 #ifndef __GEOM_GEN_I_H__
23 #define __GEOM_GEN_I_H__
25 #include "GEOM_GEOM_I.hxx"
27 #include "GEOMImpl_Gen.hxx"
30 #include <SALOMEconfig.h>
31 #include CORBA_SERVER_HEADER(GEOM_Gen)
33 #include CORBA_CLIENT_HEADER(SALOMEDS)
34 #include CORBA_CLIENT_HEADER(SALOMEDS_Attributes)
37 #include "SALOME_Component_i.hxx"
38 #include "SALOME_NamingService.hxx"
40 #include "GEOM_IBasicOperations_i.hh"
41 #include "GEOM_ITransformOperations_i.hh"
42 #include "GEOM_I3DPrimOperations_i.hh"
43 #include "GEOM_IShapesOperations_i.hh"
44 #include "GEOM_IBlocksOperations_i.hh"
45 #include "GEOM_IBooleanOperations_i.hh"
46 #include "GEOM_ICurvesOperations_i.hh"
47 #include "GEOM_ILocalOperations_i.hh"
48 #include "GEOM_IHealingOperations_i.hh"
49 #include "GEOM_IInsertOperations_i.hh"
50 #include "GEOM_IMeasureOperations_i.hh"
51 #include "GEOM_IGroupOperations_i.hh"
52 #include "GEOM_IAdvancedOperations_i.hh"
54 #include <TopTools_IndexedMapOfShape.hxx>
59 //#include <Standard_ErrorHandler.hxx> // CAREFUL ! position of this file is critic : see Lucien PIGNOLONI / OCC
62 //=====================================================================
63 // GEOM_Gen_i : class definition
64 //=====================================================================
65 class GEOM_I_EXPORT GEOM_Gen_i: virtual public POA_GEOM::GEOM_Gen, virtual public Engines_Component_i
69 //-----------------------------------------------------------------------//
70 // Constructor / Destructor //
71 //-----------------------------------------------------------------------//
73 // constructor to be called for servant creation.
75 GEOM_Gen_i(CORBA::ORB_ptr orb,
76 PortableServer::POA_ptr poa,
77 PortableServer::ObjectId * contId,
78 const char *instanceName,
79 const char *interfaceName);
81 // destructor, doing nothing (for now)
82 virtual ~GEOM_Gen_i();
84 // generic method to be put in a super class
85 void register_name(char * name);
88 //-----------------------------------------------------------------------//
89 // Inherited methods from SALOMEDS::Driver //
90 //-----------------------------------------------------------------------//
92 SALOMEDS::TMPFile* Save(SALOMEDS::SComponent_ptr theComponent,
96 SALOMEDS::TMPFile* SaveASCII(SALOMEDS::SComponent_ptr theComponent,
100 CORBA::Boolean Load(SALOMEDS::SComponent_ptr theComponent,
101 const SALOMEDS::TMPFile& theStream,
105 CORBA::Boolean LoadASCII(SALOMEDS::SComponent_ptr theComponent,
106 const SALOMEDS::TMPFile& theStream,
110 void Close(SALOMEDS::SComponent_ptr theComponent);
111 char* ComponentDataType();
114 char* IORToLocalPersistentID(SALOMEDS::SObject_ptr theSObject,
115 const char* IORString,
116 CORBA::Boolean isMultiFile,
117 CORBA::Boolean isASCII);
118 char* LocalPersistentIDToIOR(SALOMEDS::SObject_ptr theSObject,
119 const char* aLocalPersistentID,
120 CORBA::Boolean isMultiFile,
121 CORBA::Boolean isASCII);
123 bool CanPublishInStudy(CORBA::Object_ptr theIOR);
124 SALOMEDS::SObject_ptr PublishInStudy(SALOMEDS::Study_ptr theStudy,
125 SALOMEDS::SObject_ptr theSObject,
126 CORBA::Object_ptr theObject,
127 const char* theName) throw (SALOME::SALOME_Exception) ;
129 GEOM::ListOfGO* PublishNamedShapesInStudy(SALOMEDS::Study_ptr theStudy,
130 CORBA::Object_ptr theObject);
132 CORBA::Boolean CanCopy(SALOMEDS::SObject_ptr theObject);
133 SALOMEDS::TMPFile* CopyFrom(SALOMEDS::SObject_ptr theObject, CORBA::Long& theObjectID);
134 CORBA::Boolean CanPaste(const char* theComponentName, CORBA::Long theObjectID);
135 SALOMEDS::SObject_ptr PasteInto(const SALOMEDS::TMPFile& theStream,
136 CORBA::Long theObjectID,
137 SALOMEDS::SObject_ptr theObject);
139 /*! \brief Adds theObject in the study with a name = theName, if
140 * theFather is not null the object is placed under theFather
142 SALOMEDS::SObject_ptr AddInStudy (SALOMEDS::Study_ptr theStudy,
143 GEOM::GEOM_Object_ptr theObject,
145 GEOM::GEOM_Object_ptr theFather);
147 /*! \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments.
148 * To be used from python scripts out of geompy.addToStudy (non-default usage)
150 GEOM::ListOfGO* RestoreSubShapesO (SALOMEDS::Study_ptr theStudy,
151 GEOM::GEOM_Object_ptr theObject,
152 const GEOM::ListOfGO& theArgs,
153 GEOM::find_shape_method theFindMethod,
154 CORBA::Boolean theInheritFirstArg,
155 CORBA::Boolean theAddPrefix);
157 /*! \brief Publish sub-shapes, standing for given in \a theArgs arguments and sub-shapes.
158 * To be used from python scripts, generated by Dump Python.
160 GEOM::ListOfGO* RestoreGivenSubShapesO (SALOMEDS::Study_ptr theStudy,
161 GEOM::GEOM_Object_ptr theObject,
162 const GEOM::ListOfGO& theArgs,
163 GEOM::find_shape_method theFindMethod,
164 CORBA::Boolean theInheritFirstArg,
165 CORBA::Boolean theAddPrefix);
167 /*! \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments.
168 * To be used from GUI and from geompy.addToStudy
170 GEOM::ListOfGO* RestoreSubShapesSO (SALOMEDS::Study_ptr theStudy,
171 SALOMEDS::SObject_ptr theSObject,
172 const GEOM::ListOfGO& theArgs,
173 GEOM::find_shape_method theFindMethod,
174 CORBA::Boolean theInheritFirstArg,
175 CORBA::Boolean theAddPrefix);
177 //-----------------------------------------------------------------------//
178 // Transaction methods //
179 //-----------------------------------------------------------------------//
181 //Undos one transaction in the document associated with theStudyID
182 virtual void Undo(CORBA::Long theStudyID);
184 //Redos one transaction in the document associated with theStudyID
185 virtual void Redo(CORBA::Long theStudyID);
187 //-----------------------------------------------------------------------//
188 // Operations methods //
189 //-----------------------------------------------------------------------//
191 //Returns a pointer to BasicOperations interface
192 virtual GEOM::GEOM_IBasicOperations_ptr GetIBasicOperations (CORBA::Long theStudyID)
193 throw (SALOME::SALOME_Exception);
195 //Returns a pointer to TransformOperations interface
196 virtual GEOM::GEOM_ITransformOperations_ptr GetITransformOperations (CORBA::Long theStudyID)
197 throw (SALOME::SALOME_Exception);
199 //Returns a pointer to 3DPrimOperations interface
200 virtual GEOM::GEOM_I3DPrimOperations_ptr GetI3DPrimOperations (CORBA::Long theStudyID)
201 throw (SALOME::SALOME_Exception);
203 //Returns a pointer to ShapesOperations interface
204 virtual GEOM::GEOM_IShapesOperations_ptr GetIShapesOperations (CORBA::Long theStudyID)
205 throw (SALOME::SALOME_Exception);
207 //Returns a pointer to BlocksOperations interface
208 virtual GEOM::GEOM_IBlocksOperations_ptr GetIBlocksOperations (CORBA::Long theStudyID)
209 throw (SALOME::SALOME_Exception);
211 //Returns a pointer to BooleanOperations interface
212 virtual GEOM::GEOM_IBooleanOperations_ptr GetIBooleanOperations (CORBA::Long theStudyID)
213 throw (SALOME::SALOME_Exception);
215 //Returns a pointer to CurvesOperations interface
216 virtual GEOM::GEOM_ICurvesOperations_ptr GetICurvesOperations (CORBA::Long theStudyID)
217 throw (SALOME::SALOME_Exception);
219 //Returns a pointer to LocalOperations interface
220 virtual GEOM::GEOM_ILocalOperations_ptr GetILocalOperations (CORBA::Long theStudyID)
221 throw (SALOME::SALOME_Exception);
223 //Returns a pointer to HealingOperations interface
224 virtual GEOM::GEOM_IHealingOperations_ptr GetIHealingOperations (CORBA::Long theStudyID)
225 throw (SALOME::SALOME_Exception);
227 //Returns a pointer to InsertOperations interface
228 virtual GEOM::GEOM_IInsertOperations_ptr GetIInsertOperations (CORBA::Long theStudyID)
229 throw (SALOME::SALOME_Exception);
231 //Returns a pointer to MeasureOperations interface
232 virtual GEOM::GEOM_IMeasureOperations_ptr GetIMeasureOperations (CORBA::Long theStudyID)
233 throw (SALOME::SALOME_Exception);
235 //Returns a pointer to GroupOperations interface
236 virtual GEOM::GEOM_IGroupOperations_ptr GetIGroupOperations (CORBA::Long theStudyID)
237 throw (SALOME::SALOME_Exception);
239 //Returns a pointer to AdvancedOperations interface
240 virtual GEOM::GEOM_IAdvancedOperations_ptr GetIAdvancedOperations (CORBA::Long theStudyID)
241 throw (SALOME::SALOME_Exception);
243 //Adds a new sub shape
244 virtual GEOM::GEOM_Object_ptr AddSubShape (GEOM::GEOM_Object_ptr theMainShape,
245 const GEOM::ListOfLong& theIndices);
247 virtual void RemoveObject(GEOM::GEOM_Object_ptr theObject);
249 virtual char* GetStringFromIOR(GEOM::GEOM_Object_ptr theObject);
251 virtual GEOM::GEOM_Object_ptr GetIORFromString(const char* stringIOR);
253 virtual Engines::TMPFile* DumpPython(CORBA::Object_ptr theStudy,
254 CORBA::Boolean isPublished,
255 CORBA::Boolean& isValidScript);
257 char* GetDumpName (const char* theStudyEntry);
259 GEOM::string_array* GetAllDumpNames();
261 // Object information
262 virtual bool hasObjectInfo();
263 virtual char* getObjectInfo(CORBA::Long studyId, const char* entry);
265 //-----------------------------------------------------------------------//
266 // Internal methods //
267 //-----------------------------------------------------------------------//
269 virtual GEOM::GEOM_Object_ptr GetObject(CORBA::Long theStudyID, const char* theEntry);
272 GEOM::ListOfGO* RestoreSubShapes (SALOMEDS::Study_ptr theStudy,
273 GEOM::GEOM_Object_ptr theObject,
274 SALOMEDS::SObject_ptr theSObject,
275 const GEOM::ListOfGO& theArgs,
276 GEOM::find_shape_method theFindMethod,
277 CORBA::Boolean theInheritFirstArg,
278 CORBA::Boolean theAddPrefix);
280 GEOM::ListOfGO* RestoreSubShapesOneLevel (SALOMEDS::Study_ptr theStudy,
281 SALOMEDS::SObject_ptr theOldSO,
282 SALOMEDS::SObject_ptr theNewSO,
283 GEOM::GEOM_Object_ptr theNewO,
284 GEOM::ListOfGO& theOutArgs,
285 GEOM::find_shape_method theFindMethod,
286 CORBA::Boolean theAddPrefix);
288 GEOM::ListOfGO* RestoreGivenSubShapes (SALOMEDS::Study_ptr theStudy,
289 GEOM::GEOM_Object_ptr theObject,
290 SALOMEDS::SObject_ptr theSObject,
291 const GEOM::ListOfGO& theArgs,
292 GEOM::find_shape_method theFindMethod,
293 CORBA::Boolean theInheritFirstArg,
294 CORBA::Boolean theAddPrefix);
296 GEOM::ListOfGO* RestoreGivenSubShapesOneLevel (SALOMEDS::Study_ptr theStudy,
297 SALOMEDS::SObject_ptr theOldSO,
298 SALOMEDS::SObject_ptr theNewSO,
299 GEOM::GEOM_Object_ptr theNewO,
300 std::set<std::string> theArgs,
301 GEOM::find_shape_method theFindMethod,
302 CORBA::Boolean theAddPrefix);
304 // auxilary for PublishNamedShapesInStudy
305 void CreateAndPublishGroup(SALOMEDS::Study_ptr theStudy,
306 GEOM::GEOM_Object_var theMainShape,
307 const TopTools_IndexedMapOfShape& anIndices,
308 const TopTools_SequenceOfShape& SeqS,
309 const TColStd_SequenceOfAsciiString& SeqN,
310 const Standard_CString& GrName,
311 GEOM::ListOfGO_var aResList);
315 ::GEOMImpl_Gen* _impl;
316 SALOME_NamingService * name_service;