src/KernelHelpers/SALOME_KernelServices.hxx

   1 // Copyright (C) 2007-2021  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 // Author: Guillaume Boulant (EDF/R&D)
  21 #ifndef __SALOME_KERNEL_SERVICES_HXX__
  22 #define __SALOME_KERNEL_SERVICES_HXX__
  23 #pragma once
  24
  25 #include "KernelHelpers.hxx"
  26
  27 #include "SALOMEconfig.h"
  28 #include CORBA_SERVER_HEADER(SALOMEDS)
  29 #include CORBA_SERVER_HEADER(SALOMEDS_Attributes)
  30 #include CORBA_SERVER_HEADER(SALOME_Launcher)
  31 #include CORBA_CLIENT_HEADER(SALOME_Session)
  32 #include CORBA_SERVER_HEADER(SALOME_Exception)
  33
  34 #include "SALOME_NamingService.hxx"
  35 #include "SALOME_LifeCycleCORBA.hxx"
  36
  37 namespace KERNEL {
  38
  39   // ---------------------------------------------
  40   // SALOME KERNEL main services
  41   KERNELHELPERS_EXPORT CORBA::ORB_ptr                getORB();
  42   KERNELHELPERS_EXPORT SALOME_NamingService_Abstract *getNamingService();
  43   KERNELHELPERS_EXPORT void assignNamingServiceSL();
  44   KERNELHELPERS_EXPORT SALOME_LifeCycleCORBA *       getLifeCycleCORBA();
  45   KERNELHELPERS_EXPORT SALOME::Session_ptr           getSalomeSession();
  46   KERNELHELPERS_EXPORT SALOMEDS::Study_ptr           getStudyServant();
  47   KERNELHELPERS_EXPORT Engines::SalomeLauncher_ptr   getSalomeLauncher();
  48   KERNELHELPERS_EXPORT Engines::ResourcesManager_ptr getResourcesManager();
  49
  50   // ---------------------------------------------
  51   // SALOME KERNEL services to deal with a SALOME study, SObject and
  52   // SComponent.
  53   //
  54   KERNELHELPERS_EXPORT CORBA::Object_ptr   IORToObject(char * IOR);
  55   KERNELHELPERS_EXPORT CORBA::Object_ptr   SObjectToObject(SALOMEDS::SObject_ptr);
  56
  57
  58   KERNELHELPERS_EXPORT void RegisterCompo(const std::string& compoName, CORBA::Object_var compoPtr);
  59   KERNELHELPERS_EXPORT CORBA::Object_var RetrieveCompo(const std::string& compoName);
  60   /*!
  61    * This template function provides you with the servant (CORBA
  62    * object narrowed to its interface) corresponding to the specified
  63    * CORBA object (naked CORBA pointer).
  64    */
  65   template<class TInterface> typename TInterface::_var_type
  66   ObjectToInterface(CORBA::Object_ptr object) {
  67     if(!CORBA::is_nil(object))
  68       return TInterface::_narrow(object);
  69     return TInterface::_nil();
  70   }
  71
  72   template<class TInterface> typename TInterface::_var_type
  73   SObjectToInterface(SALOMEDS::SObject_ptr sobject) {
  74     CORBA::Object_ptr object = SObjectToObject(sobject);
  75     return ObjectToInterface<TInterface>(object);
  76   }
  77
  78   // _MEM_: note that template functions have to be declared AND
  79   // implemented in the header because they are not compiled in this
  80   // library but in every client library that includes this header
  81   // file. The effective compilation depends on the particular class
  82   // used for TInterface.
  83
  84   // ---------------------------------------------
  85   // To create a standard SALOME exception embedding a simple text
  86   KERNELHELPERS_EXPORT SALOME::SALOME_Exception createSalomeException(const char * text);
  87 }
  88
  89
  90 //
  91 // =============================================================
  92 // SALOME Logger macros
  93 // =============================================================
  94 //
  95 // We can use the macros defined by SALOMELocalTrace/utilities.h
  96 #include "utilities.h"
  97 #define SALOMELOG(msg) {MESS_BEGIN("[XSALOME]") << msg << MESS_END}
  98 #ifdef LOG
  99 #undef LOG
 100 #endif
 101 #define LOG SALOMELOG
 102
 103 #include "Utils_CorbaException.hxx"
 104 // Tip: CORBA exceptions can be used with LOG (or more generally in streams)
 105 // Ex: LOG("An exception occurs: "<<e) will log the data of the exception e
 106 #endif //__SALOME_KERNEL_SERVICES_HXX__