src/SALOMEDSClient/SALOMEDSClient_ClientFactory.hxx

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