src/SALOMEDSClient/SALOMEDSClient_ClientFactory.hxx

   1 // Copyright (C) 2006  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   : SALOMEDSClient_ClientFactory.hxx
  21 //  Author : Sergey RUIN
  22 //  Module : SALOME
  23 //  $Header:
  24
  25 #ifndef SALOMEDSClient_ClientFactory_HeaderFile
  26 #define SALOMEDSClient_ClientFactory_HeaderFile
  27
  28 #include "SALOMEDSClient_definitions.hxx"
  29 #include "SALOMEDSClient_SObject.hxx"
  30 #include "SALOMEDSClient_SComponent.hxx"
  31 #include "SALOMEDSClient_Study.hxx"
  32 #include "SALOMEDSClient_StudyManager.hxx"
  33 #include "SALOMEDSClient_IParameters.hxx"
  34
  35 #include <string>
  36
  37 // IDL headers
  38 #include <SALOMEconfig.h>
  39 #include CORBA_CLIENT_HEADER(SALOMEDS)
  40
  41 class ClientFactory {
  42
  43 public:
  44   /*!
  45    *  Returns a client SObject wrapper that corresponds %theSObject
  46    */
  47   static _PTR(SObject) SObject(SALOMEDS::SObject_ptr theSObject);
  48
  49   /*!
  50    *  Returns a client SComponent wrapper that corresponds %theSComponent
  51    */
  52   static _PTR(SComponent) SComponent(SALOMEDS::SComponent_ptr theSComponent);
  53
  54   /*!
  55    *  Returns a client Study wrapper that corresponds %theStudy
  56    */
  57   static _PTR(Study) Study(SALOMEDS::Study_ptr theStudy);
  58
  59   /*!
  60    *  Returns a client StudyBuilder wrapper that corresponds %theStudy
  61    */
  62   static _PTR(StudyBuilder) StudyBuilder(SALOMEDS::StudyBuilder_ptr theBuilder);
  63
  64   /*!
  65    *  Returns a client StudyManager wrapper
  66    */
  67   static _PTR(StudyManager) StudyManager();
  68
  69   /*!
  70    *  Creates and returns a client StudyManager wrapper
  71    */
  72   static _PTR(StudyManager) createStudyManager(CORBA::ORB_ptr orb, PortableServer::POA_ptr poa);
  73
  74   /*!
  75    * Returns an IParameters interface
  76    */
  77   static _PTR(IParameters) getIParameters(const _PTR(AttributeParameter)& ap);
  78
  79
  80   /*!
  81    *  Returns a CORBA SObject that corresponds %theStudy
  82    */
  83   static SALOMEDS::SObject_ptr crbSObject(const _PTR(SObject)& theSObject);
  84
  85   /*!
  86    *  Returns a CORBA Study that corresponds %theStudy
  87    */
  88   static SALOMEDS::Study_ptr crbStudy(const _PTR(Study)& theStudy);
  89
  90   /*!
  91    *  Returns a CORBA StudyBuilder that corresponds %theStudyBuilder
  92    */
  93   static SALOMEDS::StudyBuilder_ptr crbStudyBuilder(const _PTR(StudyBuilder)& theStudyBuilder);
  94
  95 };
  96
  97 #endif