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 #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"
53 //#include <Standard_ErrorHandler.hxx> // CAREFUL ! position of this file is critic : see Lucien PIGNOLONI / OCC
56 //=====================================================================
57 // GEOM_Gen_i : class definition
58 //=====================================================================
59 class GEOM_I_EXPORT GEOM_Gen_i: virtual public POA_GEOM::GEOM_Gen, virtual public Engines_Component_i
63 //-----------------------------------------------------------------------//
64 // Constructor / Destructor //
65 //-----------------------------------------------------------------------//
67 // constructor to be called for servant creation.
69 GEOM_Gen_i(CORBA::ORB_ptr orb,
70 PortableServer::POA_ptr poa,
71 PortableServer::ObjectId * contId,
72 const char *instanceName,
73 const char *interfaceName);
75 // destructor, doing nothing (for now)
76 virtual ~GEOM_Gen_i();
78 // generic method to be put in a super class
79 void register_name(char * name);
82 //-----------------------------------------------------------------------//
83 // Inherited methods from SALOMEDS::Driver //
84 //-----------------------------------------------------------------------//
86 SALOMEDS::TMPFile* Save(SALOMEDS::SComponent_ptr theComponent,
90 SALOMEDS::TMPFile* SaveASCII(SALOMEDS::SComponent_ptr theComponent,
94 CORBA::Boolean Load(SALOMEDS::SComponent_ptr theComponent,
95 const SALOMEDS::TMPFile& theStream,
99 CORBA::Boolean LoadASCII(SALOMEDS::SComponent_ptr theComponent,
100 const SALOMEDS::TMPFile& theStream,
104 void Close(SALOMEDS::SComponent_ptr theComponent);
105 char* ComponentDataType();
108 char* IORToLocalPersistentID(SALOMEDS::SObject_ptr theSObject,
109 const char* IORString,
110 CORBA::Boolean isMultiFile,
111 CORBA::Boolean isASCII);
112 char* LocalPersistentIDToIOR(SALOMEDS::SObject_ptr theSObject,
113 const char* aLocalPersistentID,
114 CORBA::Boolean isMultiFile,
115 CORBA::Boolean isASCII);
117 bool CanPublishInStudy(CORBA::Object_ptr theIOR);
118 SALOMEDS::SObject_ptr PublishInStudy(SALOMEDS::Study_ptr theStudy,
119 SALOMEDS::SObject_ptr theSObject,
120 CORBA::Object_ptr theObject,
121 const char* theName) throw (SALOME::SALOME_Exception) ;
123 CORBA::Boolean CanCopy(SALOMEDS::SObject_ptr theObject);
124 SALOMEDS::TMPFile* CopyFrom(SALOMEDS::SObject_ptr theObject, CORBA::Long& theObjectID);
125 CORBA::Boolean CanPaste(const char* theComponentName, CORBA::Long theObjectID);
126 SALOMEDS::SObject_ptr PasteInto(const SALOMEDS::TMPFile& theStream,
127 CORBA::Long theObjectID,
128 SALOMEDS::SObject_ptr theObject);
130 /*! \brief Adds theObject in the study with a name = theName, if
131 * theFather is not null the object is placed under theFather
133 SALOMEDS::SObject_ptr AddInStudy (SALOMEDS::Study_ptr theStudy,
134 GEOM::GEOM_Object_ptr theObject,
136 GEOM::GEOM_Object_ptr theFather);
138 /*! \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments.
139 * To be used from python scripts out of geompy.addToStudy (non-default usage)
141 CORBA::Boolean RestoreSubShapesO (SALOMEDS::Study_ptr theStudy,
142 GEOM::GEOM_Object_ptr theObject,
143 const GEOM::ListOfGO& theArgs,
144 GEOM::find_shape_method theFindMethod,
145 CORBA::Boolean theInheritFirstArg);
147 /*! \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments.
148 * To be used from GUI and from geompy.addToStudy
150 CORBA::Boolean RestoreSubShapesSO (SALOMEDS::Study_ptr theStudy,
151 SALOMEDS::SObject_ptr theSObject,
152 const GEOM::ListOfGO& theArgs,
153 GEOM::find_shape_method theFindMethod,
154 CORBA::Boolean theInheritFirstArg);
156 //-----------------------------------------------------------------------//
157 // Transaction methods //
158 //-----------------------------------------------------------------------//
160 //Undos one transaction in the document associated with theStudyID
161 virtual void Undo(CORBA::Long theStudyID);
163 //Redos one transaction in the document associated with theStudyID
164 virtual void Redo(CORBA::Long theStudyID);
166 //-----------------------------------------------------------------------//
167 // Operations methods //
168 //-----------------------------------------------------------------------//
170 //Returns a pointer to BasicOperations interface
171 virtual GEOM::GEOM_IBasicOperations_ptr GetIBasicOperations (CORBA::Long theStudyID)
172 throw (SALOME::SALOME_Exception);
174 //Returns a pointer to TransformOperations interface
175 virtual GEOM::GEOM_ITransformOperations_ptr GetITransformOperations (CORBA::Long theStudyID)
176 throw (SALOME::SALOME_Exception);
178 //Returns a pointer to 3DPrimOperations interface
179 virtual GEOM::GEOM_I3DPrimOperations_ptr GetI3DPrimOperations (CORBA::Long theStudyID)
180 throw (SALOME::SALOME_Exception);
182 //Returns a pointer to ShapesOperations interface
183 virtual GEOM::GEOM_IShapesOperations_ptr GetIShapesOperations (CORBA::Long theStudyID)
184 throw (SALOME::SALOME_Exception);
186 //Returns a pointer to BlocksOperations interface
187 virtual GEOM::GEOM_IBlocksOperations_ptr GetIBlocksOperations (CORBA::Long theStudyID)
188 throw (SALOME::SALOME_Exception);
190 //Returns a pointer to BooleanOperations interface
191 virtual GEOM::GEOM_IBooleanOperations_ptr GetIBooleanOperations (CORBA::Long theStudyID)
192 throw (SALOME::SALOME_Exception);
194 //Returns a pointer to CurvesOperations interface
195 virtual GEOM::GEOM_ICurvesOperations_ptr GetICurvesOperations (CORBA::Long theStudyID)
196 throw (SALOME::SALOME_Exception);
198 //Returns a pointer to LocalOperations interface
199 virtual GEOM::GEOM_ILocalOperations_ptr GetILocalOperations (CORBA::Long theStudyID)
200 throw (SALOME::SALOME_Exception);
202 //Returns a pointer to HealingOperations interface
203 virtual GEOM::GEOM_IHealingOperations_ptr GetIHealingOperations (CORBA::Long theStudyID)
204 throw (SALOME::SALOME_Exception);
206 //Returns a pointer to InsertOperations interface
207 virtual GEOM::GEOM_IInsertOperations_ptr GetIInsertOperations (CORBA::Long theStudyID)
208 throw (SALOME::SALOME_Exception);
210 //Returns a pointer to MeasureOperations interface
211 virtual GEOM::GEOM_IMeasureOperations_ptr GetIMeasureOperations (CORBA::Long theStudyID)
212 throw (SALOME::SALOME_Exception);
214 //Returns a pointer to GroupOperations interface
215 virtual GEOM::GEOM_IGroupOperations_ptr GetIGroupOperations (CORBA::Long theStudyID)
216 throw (SALOME::SALOME_Exception);
218 //Adds a new sub shape
219 virtual GEOM::GEOM_Object_ptr AddSubShape (GEOM::GEOM_Object_ptr theMainShape,
220 const GEOM::ListOfLong& theIndices);
222 virtual void RemoveObject(GEOM::GEOM_Object_ptr theObject);
224 virtual char* GetStringFromIOR(GEOM::GEOM_Object_ptr theObject);
226 virtual GEOM::GEOM_Object_ptr GetIORFromString(const char* stringIOR);
228 virtual Engines::TMPFile* DumpPython(CORBA::Object_ptr theStudy,
229 CORBA::Boolean isPublished,
230 CORBA::Boolean& isValidScript);
232 char* GetDumpName (const char* theStudyEntry);
234 GEOM::string_array* GetAllDumpNames();
236 // Object information
237 virtual bool hasObjectInfo();
238 virtual char* getObjectInfo(CORBA::Long studyId, const char* entry);
240 //-----------------------------------------------------------------------//
241 // Internal methods //
242 //-----------------------------------------------------------------------//
244 virtual GEOM::GEOM_Object_ptr GetObject(CORBA::Long theStudyID, const char* theEntry);
247 GEOM::ListOfGO* RestoreSubShapesOneLevel (SALOMEDS::Study_ptr theStudy,
248 SALOMEDS::SObject_ptr theOldSO,
249 SALOMEDS::SObject_ptr theNewSO,
250 GEOM::GEOM_Object_ptr theNewO,
251 GEOM::find_shape_method theFindMethod);
253 CORBA::Boolean RestoreSubShapes (SALOMEDS::Study_ptr theStudy,
254 GEOM::GEOM_Object_ptr theObject,
255 SALOMEDS::SObject_ptr theSObject,
256 const GEOM::ListOfGO& theArgs,
257 GEOM::find_shape_method theFindMethod,
258 CORBA::Boolean theInheritFirstArg);
262 ::GEOMImpl_Gen* _impl;
263 SALOME_NamingService * name_service;