src/SALOMEDSClient/SALOMEDSClient_ClientFactory.hxx

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