src/GEOM_I/GEOM_Gen_i.hh

   1 // Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   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.
  10 //
  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.
  15 //
  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
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef __GEOM_GEN_I_H__
  24 #define __GEOM_GEN_I_H__
  25
  26 #include "GEOM_GEOM_I.hxx"
  27
  28 #include "GEOMImpl_Gen.hxx"
  29
  30 // IDL headers
  31 #include <SALOMEconfig.h>
  32 #include CORBA_SERVER_HEADER(GEOM_Gen)
  33
  34 #include CORBA_CLIENT_HEADER(SALOMEDS)
  35 #include CORBA_CLIENT_HEADER(SALOMEDS_Attributes)
  36
  37
  38 #include "SALOME_Component_i.hxx"
  39 #include "SALOME_NamingService.hxx"
  40
  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"
  55
  56 #include <TopTools_IndexedMapOfShape.hxx>
  57 #include <TopTools_SequenceOfShape.hxx>
  58
  59 #include <map>
  60 #include <set>
  61 #include <list>
  62 #include <string>
  63
  64 //#include <Standard_ErrorHandler.hxx> // CAREFUL ! position of this file is critic : see Lucien PIGNOLONI / OCC
  65
  66 //=====================================================================
  67 // Generic operations creator (for plugins mechanism)
  68 //=====================================================================
  69 class GEOM_I_EXPORT GEOM_GenericOperationsCreator
  70 {
  71  public:
  72   // Create operations
  73   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;
  78   virtual ~GEOM_GenericOperationsCreator() {}
  79 };
  80
  81 //=====================================================================
  82 // GEOM_Gen_i : class definition
  83 //=====================================================================
  84 class GEOM_I_EXPORT GEOM_Gen_i: virtual public POA_GEOM::GEOM_Gen, virtual public Engines_Component_i
  85 {
  86  public:
  87
  88   //-----------------------------------------------------------------------//
  89   // Constructor / Destructor                                              //
  90   //-----------------------------------------------------------------------//
  91
  92   // constructor to be called for servant creation.
  93   GEOM_Gen_i();
  94   GEOM_Gen_i(CORBA::ORB_ptr orb,
  95              PortableServer::POA_ptr poa,
  96              PortableServer::ObjectId * contId,
  97              const char *instanceName,
  98              const char *interfaceName);
  99
 100   // destructor, doing nothing (for now)
 101   virtual ~GEOM_Gen_i();
 102
 103   // generic method to be put in a super class
 104   void register_name(char * name);
 105
 106   // Get ORB object
 107   CORBA::ORB_ptr GetORB() { return CORBA::ORB::_duplicate(_orb); }
 108
 109   // Get Naming Service object
 110   SALOME_NamingService* GetNS() { return name_service; }
 111
 112   // Get Study
 113   SALOMEDS::Study_var getStudyServant();
 114
 115   //-----------------------------------------------------------------------//
 116   // Inherited methods from SALOMEDS::Driver                               //
 117   //-----------------------------------------------------------------------//
 118
 119   SALOMEDS::TMPFile* Save(SALOMEDS::SComponent_ptr theComponent,
 120                           const char* theURL,
 121                           bool isMultiFile);
 122
 123   SALOMEDS::TMPFile* SaveASCII(SALOMEDS::SComponent_ptr theComponent,
 124                                const char* theURL,
 125                                bool isMultiFile);
 126
 127   CORBA::Boolean Load(SALOMEDS::SComponent_ptr theComponent,
 128                       const SALOMEDS::TMPFile& theStream,
 129                       const char* theURL,
 130                       bool isMultiFile);
 131
 132   CORBA::Boolean LoadASCII(SALOMEDS::SComponent_ptr theComponent,
 133                            const SALOMEDS::TMPFile& theStream,
 134                            const char* theURL,
 135                            bool isMultiFile);
 136
 137   void Close(SALOMEDS::SComponent_ptr theComponent);
 138   char* ComponentDataType();
 139
 140
 141   char* IORToLocalPersistentID(SALOMEDS::SObject_ptr theSObject,
 142                                const char* IORString,
 143                                CORBA::Boolean isMultiFile,
 144                                CORBA::Boolean isASCII);
 145   char* LocalPersistentIDToIOR(SALOMEDS::SObject_ptr theSObject,
 146                                const char* aLocalPersistentID,
 147                                CORBA::Boolean isMultiFile,
 148                                CORBA::Boolean isASCII);
 149
 150   bool CanPublishInStudy(CORBA::Object_ptr theIOR);
 151   SALOMEDS::SObject_ptr PublishInStudy(SALOMEDS::SObject_ptr theSObject,
 152                                        CORBA::Object_ptr theObject,
 153                                        const char* theName) throw (SALOME::SALOME_Exception) ;
 154
 155   GEOM::ListOfGO* PublishNamedShapesInStudy(CORBA::Object_ptr theObject);
 156
 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);
 163
 164   /*! \brief Adds theObject in the study with a name = theName, if
 165    *         theFather is not null the object is placed under theFather
 166    */
 167   SALOMEDS::SObject_ptr AddInStudy (GEOM::GEOM_BaseObject_ptr theObject,
 168                                     const char*               theName,
 169                                     GEOM::GEOM_BaseObject_ptr theFather);
 170
 171   /*! \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments.
 172    *         To be used from python scripts out of geompy.addToStudy (non-default usage)
 173    */
 174   GEOM::ListOfGO* RestoreSubShapesO (GEOM::GEOM_Object_ptr   theObject,
 175                                      const GEOM::ListOfGO&   theArgs,
 176                                      GEOM::find_shape_method theFindMethod,
 177                                      CORBA::Boolean          theInheritFirstArg,
 178                                      CORBA::Boolean          theAddPrefix);
 179
 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.
 182    */
 183   GEOM::ListOfGO* RestoreGivenSubShapesO (GEOM::GEOM_Object_ptr   theObject,
 184                                           const GEOM::ListOfGO&   theArgs,
 185                                           GEOM::find_shape_method theFindMethod,
 186                                           CORBA::Boolean          theInheritFirstArg,
 187                                           CORBA::Boolean          theAddPrefix);
 188
 189   /*! \brief Publish sub-shapes, standing for arguments and sub-shapes of arguments.
 190    *         To be used from GUI and from geompy.addToStudy
 191    */
 192   GEOM::ListOfGO* RestoreSubShapesSO (SALOMEDS::SObject_ptr   theSObject,
 193                                       const GEOM::ListOfGO&   theArgs,
 194                                       GEOM::find_shape_method theFindMethod,
 195                                       CORBA::Boolean          theInheritFirstArg,
 196                                       CORBA::Boolean          theAddPrefix);
 197
 198   //Collects dependencies of the given objects from other ones
 199   SALOMEDS::TMPFile* GetDependencyTree(const GEOM::string_array& theObjectEntries);
 200
 201   //-----------------------------------------------------------------------//
 202   // Transaction methods                                                   //
 203   //-----------------------------------------------------------------------//
 204
 205   //Undos one transaction in the document
 206   virtual void Undo();
 207
 208   //Redos one transaction in the document
 209   virtual void Redo();
 210
 211   //-----------------------------------------------------------------------//
 212   // Operations methods                                                    //
 213   //-----------------------------------------------------------------------//
 214
 215   //Returns a pointer to BasicOperations interface
 216   virtual GEOM::GEOM_IBasicOperations_ptr GetIBasicOperations()
 217     throw (SALOME::SALOME_Exception);
 218
 219   //Returns a pointer to TransformOperations interface
 220   virtual GEOM::GEOM_ITransformOperations_ptr GetITransformOperations()
 221     throw (SALOME::SALOME_Exception);
 222
 223   //Returns a pointer to 3DPrimOperations interface
 224   virtual GEOM::GEOM_I3DPrimOperations_ptr GetI3DPrimOperations()
 225     throw (SALOME::SALOME_Exception);
 226
 227   //Returns a pointer to ShapesOperations interface
 228   virtual GEOM::GEOM_IShapesOperations_ptr GetIShapesOperations()
 229     throw (SALOME::SALOME_Exception);
 230
 231   //Returns a pointer to BlocksOperations interface
 232   virtual GEOM::GEOM_IBlocksOperations_ptr GetIBlocksOperations()
 233     throw (SALOME::SALOME_Exception);
 234
 235   //Returns a pointer to BooleanOperations interface
 236   virtual GEOM::GEOM_IBooleanOperations_ptr GetIBooleanOperations()
 237     throw (SALOME::SALOME_Exception);
 238
 239   //Returns a pointer to CurvesOperations interface
 240   virtual GEOM::GEOM_ICurvesOperations_ptr GetICurvesOperations()
 241     throw (SALOME::SALOME_Exception);
 242
 243   //Returns a pointer to LocalOperations interface
 244   virtual GEOM::GEOM_ILocalOperations_ptr GetILocalOperations()
 245     throw (SALOME::SALOME_Exception);
 246
 247   //Returns a pointer to HealingOperations interface
 248   virtual GEOM::GEOM_IHealingOperations_ptr GetIHealingOperations()
 249     throw (SALOME::SALOME_Exception);
 250
 251   //Returns a pointer to InsertOperations interface
 252   virtual GEOM::GEOM_IInsertOperations_ptr GetIInsertOperations()
 253     throw (SALOME::SALOME_Exception);
 254
 255   //Returns a pointer to MeasureOperations interface
 256   virtual GEOM::GEOM_IMeasureOperations_ptr GetIMeasureOperations()
 257     throw (SALOME::SALOME_Exception);
 258
 259   //Returns a pointer to GroupOperations interface
 260   virtual GEOM::GEOM_IGroupOperations_ptr GetIGroupOperations()
 261     throw (SALOME::SALOME_Exception);
 262
 263   //Returns a pointer to FiedlOperations interface
 264   virtual GEOM::GEOM_IFieldOperations_ptr GetIFieldOperations()
 265     throw (SALOME::SALOME_Exception);
 266
 267   //Returns a pointer to corresponding plugin operations interface
 268   virtual GEOM::GEOM_IOperations_ptr GetPluginOperations (const char* theLibName)
 269     throw (SALOME::SALOME_Exception);
 270
 271   //Adds a new sub-shape
 272   virtual GEOM::GEOM_Object_ptr AddSubShape (GEOM::GEOM_Object_ptr theMainShape,
 273                                              const GEOM::ListOfLong& theIndices);
 274
 275   virtual void RemoveObject(GEOM::GEOM_BaseObject_ptr theObject);
 276
 277   virtual  char* GetStringFromIOR(GEOM::GEOM_Object_ptr theObject);
 278
 279   virtual GEOM::GEOM_Object_ptr GetIORFromString(const char* stringIOR);
 280
 281   virtual Engines::TMPFile* DumpPython(CORBA::Boolean isPublished,
 282                                        CORBA::Boolean isMultiFile,
 283                                        CORBA::Boolean& isValidScript);
 284
 285   char* GetDumpName (const char* theStudyEntry);
 286
 287   GEOM::string_array* GetAllDumpNames();
 288
 289   // Object information
 290   virtual bool hasObjectInfo();
 291   virtual char* getObjectInfo(const char* entry);
 292
 293   // Version information
 294   virtual char* getVersion();
 295
 296   // Create a new folder object
 297   SALOMEDS::SObject_ptr CreateFolder(const char* theName,
 298                                      SALOMEDS::SObject_ptr theFather);
 299
 300   // Move GEOM object to the specified folder
 301   void MoveToFolder(GEOM::GEOM_Object_ptr theObject,
 302                     SALOMEDS::SObject_ptr theFolder);
 303
 304   // Move list of GEOM objects to the specified folder
 305   void MoveListToFolder (const GEOM::ListOfGO& theListOfGO,
 306                          SALOMEDS::SObject_ptr theFolder);
 307
 308   // Move objects to the specified position
 309   void Move( const GEOM::object_list& what,
 310              SALOMEDS::SObject_ptr where,
 311              CORBA::Long row );
 312
 313   /*! \brief Fills 3 lists that is used to clean study of redundant objects.
 314    *         To be used from GUI.
 315    */
 316   void GetEntriesToReduceStudy(GEOM::string_array& theSelectedEntries,
 317                                GEOM::string_array& theParentEntries,
 318                                GEOM::string_array& theSubEntries,
 319                                GEOM::string_array& theOtherEntries);
 320
 321   //-----------------------------------------------------------------------//
 322   // Internal methods                                                      //
 323   //-----------------------------------------------------------------------//
 324
 325   virtual GEOM::GEOM_BaseObject_ptr GetObject(const char* theEntry);
 326
 327  private:
 328   GEOM::ListOfGO* RestoreSubShapes (GEOM::GEOM_Object_ptr   theObject,
 329                                     SALOMEDS::SObject_ptr   theSObject,
 330                                     const GEOM::ListOfGO&   theArgs,
 331                                     GEOM::find_shape_method theFindMethod,
 332                                     CORBA::Boolean          theInheritFirstArg,
 333                                     CORBA::Boolean          theAddPrefix);
 334
 335   GEOM::ListOfGO* RestoreSubShapesOneLevel (SALOMEDS::SObject_ptr   theOldSO,
 336                                             SALOMEDS::SObject_ptr   theNewSO,
 337                                             GEOM::GEOM_Object_ptr   theNewO,
 338                                             GEOM::ListOfGO&         theOutArgs,
 339                                             GEOM::find_shape_method theFindMethod,
 340                                             CORBA::Boolean          theAddPrefix);
 341
 342   GEOM::ListOfGO* RestoreGivenSubShapes (GEOM::GEOM_Object_ptr   theObject,
 343                                          SALOMEDS::SObject_ptr   theSObject,
 344                                          const GEOM::ListOfGO&   theArgs,
 345                                          GEOM::find_shape_method theFindMethod,
 346                                          CORBA::Boolean          theInheritFirstArg,
 347                                          CORBA::Boolean          theAddPrefix);
 348
 349   GEOM::ListOfGO* RestoreGivenSubShapesOneLevel (SALOMEDS::SObject_ptr   theOldSO,
 350                                                  SALOMEDS::SObject_ptr   theNewSO,
 351                                                  GEOM::GEOM_Object_ptr   theNewO,
 352                                                  std::set<std::string>   theArgs,
 353                                                  GEOM::find_shape_method theFindMethod,
 354                                                  CORBA::Boolean          theAddPrefix);
 355
 356   // auxilary for PublishNamedShapesInStudy
 357   void CreateAndPublishGroup(GEOM::GEOM_Object_var theMainShape,
 358                              const TopTools_IndexedMapOfShape& anIndices,
 359                              const TopTools_SequenceOfShape& SeqS,
 360                              const TColStd_SequenceOfAsciiString& SeqN,
 361                              const Standard_CString& GrName,
 362                              GEOM::ListOfGO_var aResList);
 363
 364   void getUpwardDependency( GEOM::GEOM_BaseObject_ptr gbo,
 365                             GEOMUtils::LevelsList &upLevelList,
 366                             std::map< std::string, std::set<std::string> > &passedEntries,
 367                             int level = 0 );
 368
 369   void getDownwardDependency( GEOM::GEOM_BaseObject_ptr gbo,
 370                               GEOMUtils::LevelsList &downLevelList,
 371                               std::map< std::string, std::set<std::string> > &passedEntries,
 372                               int level = 0 );
 373
 374   void includeParentDependencies(GEOM::GEOM_BaseObject_ptr gbo,
 375                                  std::set<std::string>& aSelected,
 376                                  std::set<std::string>& aParents,
 377                                  std::set<std::string>& aChildren,
 378                                  std::set<std::string>& anOthers);
 379
 380   void includeSubObjects(const std::string& aSelectedEntry,
 381                          std::set<std::string>& aSelected,
 382                          std::set<std::string>& aParents,
 383                          std::set<std::string>& aChildren,
 384                          std::set<std::string>& anOthers);
 385
 386   void LoadPlugin(const std::string& theLibName);
 387
 388  private:
 389
 390    ::GEOMImpl_Gen* _impl;
 391    SALOME_NamingService * name_service;
 392    char * _name;
 393
 394    // plugin operations managing
 395    std::map<std::string, GEOM_GenericOperationsCreator*> myOpCreatorMap;
 396 };
 397
 398 #endif