src/ModuleCatalog/SALOME_ModuleCatalog_Acomponent_impl.hxx

   1 //  SALOME ModuleCatalog : implementation of ModuleCatalog server which parsers xml description of modules
   2 //
   3 //  Copyright (C) 2003  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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  21 //
  22 //
  23 //
  24 //  File   : SALOME_ModuleCatalog_Acomponent_impl.hxx
  25 //  Author : Estelle Deville
  26 //  Module : SALOME
  27 //  $Header$
  28
  29 #ifndef ACOMPONENT_IMPL_H
  30 #define ACOMPONENT_IMPL_H
  31
  32 #include "SALOME_ModuleCatalog_Parser.hxx"
  33 #include <SALOMEconfig.h>
  34
  35 #include CORBA_SERVER_HEADER(SALOME_ModuleCatalog)
  36
  37 class SALOME_ModuleCatalog_AcomponentImpl: public POA_SALOME_ModuleCatalog::Acomponent,
  38                       public PortableServer::RefCountServantBase
  39 {
  40 public:
  41   //! standard constructor
  42   SALOME_ModuleCatalog_AcomponentImpl(SALOME_ModuleCatalog::Component &C);
  43
  44   //! standard destructor
  45   virtual ~SALOME_ModuleCatalog_AcomponentImpl();
  46
  47   //! method to get a list of the interfaces name of a component
  48   /*!
  49     \return a list of the interfaces of a component
  50   */
  51   virtual SALOME_ModuleCatalog::ListOfInterfaces* GetInterfaceList() ;
  52
  53   //! method to get one interface of a component
  54   /*! If the specified interface doesn't exist, the Notfound exception is thrown
  55     \param interface name const car* arguments
  56     \return the wanted interface
  57   */
  58   virtual SALOME_ModuleCatalog::DefinitionInterface*
  59              GetInterface(const char* interfacename)
  60              throw(SALOME_ModuleCatalog::NotFound);
  61
  62   //! method to get a list of the services name of an interface of a component
  63  /*!If the specified interface doesn't exist, the Notfound exception is thrown
  64    \param interfacename const char* arguments
  65    \return a list of the services of the wanted interface
  66  */
  67   virtual SALOME_ModuleCatalog::ListOfServices*
  68              GetServiceList(const char* interfacename)
  69              throw(SALOME_ModuleCatalog::NotFound);
  70
  71
  72   //! method to get one service of an interface of a component
  73  /*! If the wanted service or the specified interface don't exist,
  74   *  the Notfound exception is thrown
  75    \param interfacename const char* arguments
  76    \param servicename const char* arguments
  77    \return the wanted service
  78  */
  79   virtual SALOME_ModuleCatalog::Service*
  80              GetService(const char* interfacename,
  81                         const char* servicename)
  82              throw(SALOME_ModuleCatalog::NotFound);
  83
  84   //! method to get the default service of an interface of a component
  85   /*! If the specified interface doesn't exist, the Notfound exception is thrown
  86     \param interfacename const char* arguments
  87     \return the default service of the interface
  88   */
  89   virtual SALOME_ModuleCatalog::Service*
  90              GetDefaultService(const char* interfacename)
  91              throw(SALOME_ModuleCatalog::NotFound);
  92
  93   //! method to get the PathPrefix of a computer
  94  /*! If the wanted computer doesn't exist, the Notfound exception is thrown
  95    \param machinename const char* arguments
  96    \return the prefix path
  97  */
  98   virtual char* GetPathPrefix(const char* machinename)
  99                 throw(SALOME_ModuleCatalog::NotFound);
 100
 101   //! method to obtain the constraint affected to a component
 102   /*! to be resolved by LifeCycle for the computer choice
 103     \return the constraint
 104   */
 105   virtual char* constraint() ;
 106
 107   //! method to obtain the componentname
 108   /*!
 109     \return the component name
 110   */
 111   virtual char* componentname();
 112
 113   //! method to obtain the componentusername
 114   /*!
 115     \return the component user name
 116   */
 117   virtual char* componentusername();
 118
 119   //! method to define if a component can be multistudy or not
 120   /*!
 121     \return true if the component supports multistudy
 122   */
 123   virtual CORBA::Boolean multistudy();
 124
 125   //! method to define the type of the component
 126   /*!
 127     \return the component type
 128   */
 129   virtual SALOME_ModuleCatalog::ComponentType component_type() ;
 130
 131   //! method to obtain the component icone (for IAPP)
 132   /*!
 133     \return the component icon
 134   */
 135   virtual char* component_icone();
 136
 137   //! method to define if a component is implemented in C++ or Python
 138   /*!
 139     \return true if it's a C++ component
 140   */
 141   virtual CORBA::Boolean implementation_type();
 142
 143 private :
 144
 145   SALOME_ModuleCatalog::Component _Component;
 146
 147  //! method to duplicate an interface
 148   /*!
 149     \param service SALOME_ModuleCatalog::DefinitionInterface arguments
 150     \return the interface
 151   */
 152   void duplicate(SALOME_ModuleCatalog::DefinitionInterface &I_out,
 153                  const SALOME_ModuleCatalog::DefinitionInterface &I_in);
 154
 155  //! method to duplicate a service
 156   /*!
 157     \param service SALOME_ModuleCatalog::Service arguments
 158     \return the service
 159   */
 160   void duplicate(SALOME_ModuleCatalog::Service & S_out,
 161                  const SALOME_ModuleCatalog::Service &S_in);
 162
 163  //! method to duplicate a parameter
 164   /*!
 165     \param parameter SALOME_ModuleCatalog::ServicesParameter arguments
 166     \return the parameter
 167   */
 168   void duplicate(SALOME_ModuleCatalog::ServicesParameter & P_out,
 169                  const SALOME_ModuleCatalog::ServicesParameter & P_in);
 170
 171  //! method to duplicate a parameter
 172   /*!
 173     \param parameter SALOME_ModuleCatalog::ServicesDataStreamParameter arguments
 174     \return the parameter
 175   */
 176   void duplicate(SALOME_ModuleCatalog::ServicesDataStreamParameter & P_out,
 177                  const SALOME_ModuleCatalog::ServicesDataStreamParameter &P_in);
 178
 179 };
 180
 181
 182 #endif // ACOMPONENT_IMPL_H