src/SALOMEDS/SALOMEDS_StudyManager_i.hxx

   1 // Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 // This library is free software; you can redistribute it and/or
   5 // modify it under the terms of the GNU Lesser General Public
   6 // License as published by the Free Software Foundation; either
   7 // version 2.1 of the License.
   8 //
   9 // This library is distributed in the hope that it will be useful
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 // Lesser General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Lesser General Public
  15 // License along with this library; if not, write to the Free Software
  16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 //
  20 //  File   : SALOMEDS_StudyManager_i.hxx
  21 //  Author : Sergey RUIN
  22 //  Module : SALOME
  23
  24 #ifndef __SALOMEDS_STUDYMANAGER_I_H__
  25 #define __SALOMEDS_STUDYMANAGER_I_H__
  26
  27 // std C++ headers
  28 #include <iostream>
  29
  30 // IDL headers
  31 #include <SALOMEconfig.h>
  32 #include CORBA_SERVER_HEADER(SALOMEDS)
  33
  34 // Naming Service header
  35 #include "SALOME_NamingService.hxx"
  36
  37 #include <stdlib.h>
  38
  39 #include "SALOMEDS_Driver_i.hxx"
  40 #include "SALOMEDSImpl_StudyManager.hxx"
  41
  42 namespace SALOMEDS{
  43
  44   // To convert CORBA::Object to  PortableServer::ServantBase
  45   PortableServer::ServantBase_var GetServant(CORBA::Object_ptr, PortableServer::POA_ptr);
  46
  47 }
  48
  49 class Standard_EXPORT SALOMEDS_StudyManager_i: public POA_SALOMEDS::StudyManager
  50 {
  51 private:
  52
  53   CORBA::ORB_ptr                    _orb;
  54   PortableServer::POA_var           _poa;
  55   SALOMEDSImpl_StudyManager*        _impl;
  56   SALOME_NamingService*             _name_service;
  57   SALOMEDS_DriverFactory_i*         _factory;
  58
  59 public:
  60
  61   //! standard constructor
  62   SALOMEDS_StudyManager_i(CORBA::ORB_ptr orb, PortableServer::POA_ptr thePOA);
  63
  64   //! standard destructor
  65   virtual  ~SALOMEDS_StudyManager_i();
  66
  67  //! method to Register study Manager in the naming service
  68   /*!
  69     \param char* arguments, the context to register the study manager in the NS
  70   */
  71   void register_name(char * name);
  72
  73  //! method to Create a New Study of name study_name
  74   /*!
  75     \param char* arguments, the new study name
  76     \return Study_ptr arguments
  77   */
  78   virtual SALOMEDS::Study_ptr NewStudy(const char* study_name);
  79
  80   //! method to Open a Study from it's persistent reference
  81   /*!
  82     \param char* arguments, the study URL
  83     \return Study_ptr arguments
  84   */
  85   virtual SALOMEDS::Study_ptr Open(const char* aStudyUrl) throw (SALOME::SALOME_Exception);
  86
  87
  88   //! method to close a Study
  89   /*!
  90     \param Study_ptr arguments
  91   */
  92   virtual void Close( SALOMEDS::Study_ptr aStudy);
  93
  94   //! method to save a Study
  95   /*!
  96     \param Study_ptr arguments
  97   */
  98   virtual CORBA::Boolean Save( SALOMEDS::Study_ptr aStudy, CORBA::Boolean theMultiFile);
  99
 100   virtual CORBA::Boolean SaveASCII( SALOMEDS::Study_ptr aStudy, CORBA::Boolean theMultiFile);
 101
 102   //! method to save a Study to the persistent reference aUrl
 103   /*!
 104     \param char* arguments, the new URL of the study
 105     \param Study_ptr arguments
 106   */
 107   virtual CORBA::Boolean SaveAs(const char* aUrl,  SALOMEDS::Study_ptr aStudy, CORBA::Boolean theMultiFile);
 108   virtual CORBA::Boolean SaveAsASCII(const char* aUrl,  SALOMEDS::Study_ptr aStudy, CORBA::Boolean theMultiFile);
 109
 110  //! method to Get name list of open studies in the session
 111   /*!
 112     \return ListOfOpenStudies* arguments
 113   */
 114   virtual SALOMEDS::ListOfOpenStudies* GetOpenStudies();
 115
 116   //! method to get a Study from it's name
 117   /*!
 118     \param char* arguments, the study name
 119     \return Study_ptr arguments
 120   */
 121   virtual SALOMEDS::Study_ptr GetStudyByName(const char* aStudyName) ;
 122
 123   //! method to get a Study from it's ID
 124   /*!
 125     \param char* arguments, the study ID
 126     \return Study_ptr arguments
 127   */
 128   virtual SALOMEDS::Study_ptr GetStudyByID(CORBA::Short aStudyID) ;
 129
 130   virtual CORBA::Boolean CanCopy(SALOMEDS::SObject_ptr theObject);
 131   virtual CORBA::Boolean Copy(SALOMEDS::SObject_ptr theObject);
 132   virtual CORBA::Boolean CanPaste(SALOMEDS::SObject_ptr theObject);
 133   virtual SALOMEDS::SObject_ptr Paste(SALOMEDS::SObject_ptr theObject) throw(SALOMEDS::StudyBuilder::LockProtection);
 134
 135   virtual char* ConvertObjectToIOR(CORBA::Object_ptr theObject) {return _orb->object_to_string(theObject); }
 136   virtual CORBA::Object_ptr ConvertIORToObject(const char* theIOR) { return _orb->string_to_object(theIOR); };
 137
 138   void ping(){};
 139
 140   virtual CORBA::LongLong GetLocalImpl(const char* theHostname, CORBA::Long thePID, CORBA::Boolean& isLocal);
 141
 142   static PortableServer::POA_ptr GetPOA(const SALOMEDS::Study_ptr theStudy);
 143
 144   void Shutdown() { if(!CORBA::is_nil(_orb)) _orb->shutdown(0); }
 145 };
 146
 147 #endif