idl/SALOME_ModuleCatalog.idl

   1 //  Copyright (C) 2003  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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  19 //
  20 //
  21 //
  22 //  File   : SALOME_ModuleCatalog.idl
  23 //  Author : Estelle Deville
  24 //  $Header$
  25
  26 /*! \file SALOME_ModuleCatalog.idl This file conatins a set of interfaces used for
  27   creation of the catalog of components in %SALOME application
  28 */
  29
  30 /*! \ingroup Kernel
  31 The main package of interfaces used for creation of the module catalog in %SALOME application.
  32 */
  33 module SALOME_ModuleCatalog
  34 {
  35   // Type Definitions
  36 /*!
  37 This enumeration contains a set of definitions of %SALOME modules.
  38 */
  39   enum ComponentType {  GEOM,  /*!<Module %GEOM */
  40                         MESH,  /*!<Module %MESH */
  41                          Med,  /*!<Module %Med*/
  42                       SOLVER,  /*!<Module of %SOLVER type */
  43                         DATA,  /*!<Module %DATA */
  44                         VISU,  /*!<Module %VISU */
  45                       SUPERV,  /*!<Module %SUPERVISION */
  46                        OTHER   /*!<Any other type of module */
  47                      } ;
  48 /*!
  49 This struct contains fields defining the parameters of the services.
  50 */
  51
  52   struct ServicesParameter
  53   {
  54     string Parametertype; /*!<Type of the parameter.*/
  55     string Parametername; /*!<Name of the parameter.*/
  56   } ;
  57
  58   typedef sequence<ServicesParameter> ListOfServicesParameter;
  59 /*!
  60 This struct contains fields completely defining each service.
  61 */
  62
  63   struct Service
  64   {
  65     string                  ServiceName; /*!<Name of the service.*/
  66     ListOfServicesParameter ServiceinParameter; /*!< List of input parameters of the services.*/
  67     ListOfServicesParameter ServiceoutParameter; /*!< List of input parameters of the services.*/
  68     boolean                 Servicebydefault; /*!<True if the service is taken with its defult fields.*/
  69   } ;
  70 /*!
  71 List of services of the interface.
  72 */
  73   typedef sequence<Service> ListOfInterfaceService;
  74 /*!
  75 List of services.
  76 */
  77   typedef sequence<string> ListOfServices ;
  78 /*!
  79 This struct contains fields defining each interface.
  80 */
  81   struct DefinitionInterface
  82   {
  83     string                 interfacename ; /*!<Name of the interface.*/
  84     ListOfInterfaceService interfaceservicelist ; /*!<List of services of the interface.*/
  85   } ;
  86 /*!
  87 List of interface definitions.
  88 */
  89   typedef sequence<DefinitionInterface> ListOfDefInterface ;
  90 /*!
  91 List of interfaces.
  92 */
  93   typedef sequence<string> ListOfInterfaces ;
  94 /*!
  95 List of names of components.
  96 */
  97   typedef sequence<string> ListOfComponents ;
  98 /*!
  99 List of names of computers.
 100 */
 101   typedef sequence<string> ListOfComputers ;
 102 /*!
 103 This struct contains GUI elements used for representation of the module in %IAPP component.
 104 */
 105   struct IAPP_Affich
 106   {
 107     string modulename; /*!<Name of the module.*/
 108     string moduleusername; /*!<UserName of the module.*/
 109     string moduleicone; /*!<Icone representing the module.*/
 110   };
 111 /*!
 112 List of pair GUI elements (component name, component icone)
 113  used for representation of the module in %IAPP component.
 114 */
 115   typedef sequence<IAPP_Affich> ListOfIAPP_Affich ;
 116
 117 /*!
 118  This exception is raised when a %component, a %service or a % pathPrefix is not found.
 119 */
 120   exception NotFound
 121   {
 122     string what ; /*!<Indicates if it's a %component, a %service or a % pathPrefix.*/
 123   } ;
 124
 125   interface Acomponent
 126   {
 127     // GetInterfaceList : operation to get a list of the interfaces name of
 128     //                    a component
 129   /*!
 130    Gets a list of names of interfaces of the component
 131     \return a list of interfaces of the component
 132   */
 133     ListOfInterfaces GetInterfaceList() ;
 134
 135     // GetInterface : operation to get one interface of a component
 136
 137   /*!
 138     Gets a definite interface of the component
 139     \note <BR>If the specified interface doesn't exist, Notfound exception is thrown
 140     \param interfacename  Name of the interface
 141     \return Required interface
 142   */
 143     DefinitionInterface GetInterface(in string interfacename) raises(NotFound);
 144
 145     // GetServiceList : operation to get a list of the services name of
 146     //                  an interface of a component
 147  /*!
 148    Gets a list of names of services of a definite interface belonging to the component.
 149    \note <BR>If the specified interface doesn't exist, Notfound exception is thrown.
 150    \param interfacename Name of the interface
 151    \return List of services of the required interface
 152  */
 153     ListOfServices GetServiceList(in string interfacename) raises(NotFound);
 154
 155
 156     // GetService : operation to get one service of an interface of a component
 157
 158  /*!
 159    Gets a definite service of an interface of the component.
 160    \note <BR>If the required service or the specified interface don't exist, Notfound exception is thrown.
 161    \param interfacename Name of the interface
 162    \param servicename Name of the service
 163    \return Required service
 164  */
 165
 166     Service GetService(in string interfacename,
 167                        in string servicename) raises(NotFound);
 168
 169     // GetDefaultService : operation to get the default service
 170     //                     of an interface of a component
 171 /*!
 172    Gets the default service of an interface of the component.
 173    \note <BR>If the required service or the specified interface don't exist, Notfound exception is thrown.
 174    \param interfacename Name of the interface
 175    \return Required service
 176  */
 177
 178     Service GetDefaultService(in string interfacename) raises(NotFound);
 179
 180     // GetPathPrefix : operation to get the PathPrefix of a computer
 181  /*!
 182    Gets the prefix path of the computer containing the %component.
 183    \note <BR>If the required computer doesn't exist, Notfound exception is thrown
 184    \param machinename Name of the machine
 185    \return Prefix path
 186  */
 187
 188     string GetPathPrefix(in string machinename) raises(NotFound);
 189
 190 /*!
 191     Sets/gets the constraint affected to the component
 192     (to be resolved by LifeCycle for the computer choice)
 193 */
 194     readonly attribute string constraint ;
 195
 196 /*!
 197 Sets/gets the name of the component
 198 */
 199     readonly attribute string componentname;
 200
 201 /*!
 202 Sets/gets the user name of the component
 203 */
 204     readonly attribute string componentusername;
 205
 206 /*!
 207 Defines whether the component can be multistudy or not
 208 */
 209     readonly attribute boolean multistudy;
 210
 211 /*!
 212 Defines the type of the component
 213 */
 214     readonly attribute ComponentType component_type ;
 215
 216 /*!
 217 Sets/gets the icone of the component (for IAPP)
 218 */
 219     readonly attribute string component_icone;
 220   } ;
 221 /*! \brief %Module catalog interface
 222
 223 This interface is used for creation of the module catalog in %SALOME application.
 224 */
 225   interface ModuleCatalog
 226   {
 227     void ping();
 228
 229 /*!
 230  Gets a list of names of computers of the catalog
 231 */
 232     ListOfComputers GetComputerList();
 233
 234 /*!
 235 Gets the %PathPrefix of a computer
 236 */
 237     string GetPathPrefix(in string machinename) raises(NotFound);
 238 /*!
 239  Gets a list of names of components of the catalog
 240 */
 241     ListOfComponents GetComponentList();
 242 /*!
 243 Gets a list of pair GUI elements (component name, component icone)
 244 used for representation of the module in %IAPP component.
 245 */
 246
 247     ListOfIAPP_Affich GetComponentIconeList();
 248 /*!
 249 Gets a list of names of components of a particular type, which belong to this catalog.
 250 */
 251     // GetComponentList : operation to get a list of the components name of
 252     //                    a particular type of the catalog
 253     ListOfComponents GetTypedComponentList(in ComponentType _component_type);
 254
 255 /*!
 256 Gets one component of the catalog.
 257 */
 258     Acomponent GetComponent(in string componentname) raises(NotFound);
 259   } ;
 260 };