1 // Copyright (C) 2003 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
18 // See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
22 // File : SALOME_ModuleCatalog.idl
23 // Author : Estelle Deville
26 /*! \file SALOME_ModuleCatalog.idl This file conatins a set of interfaces used for
27 creation of the catalog of components in %SALOME application
31 The main package of interfaces used for creation of the module catalog in %SALOME application.
33 module SALOME_ModuleCatalog
37 This enumeration contains a set of definitions of %SALOME modules.
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 */
49 This struct contains fields defining the parameters of the services.
52 struct ServicesParameter
54 string Parametertype; /*!<Type of the parameter.*/
55 string Parametername; /*!<Name of the parameter.*/
58 typedef sequence<ServicesParameter> ListOfServicesParameter;
60 This struct contains fields completely defining each service.
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.*/
71 List of services of the interface.
73 typedef sequence<Service> ListOfInterfaceService;
77 typedef sequence<string> ListOfServices ;
79 This struct contains fields defining each interface.
81 struct DefinitionInterface
83 string interfacename ; /*!<Name of the interface.*/
84 ListOfInterfaceService interfaceservicelist ; /*!<List of services of the interface.*/
87 List of interface definitions.
89 typedef sequence<DefinitionInterface> ListOfDefInterface ;
93 typedef sequence<string> ListOfInterfaces ;
95 List of names of components.
97 typedef sequence<string> ListOfComponents ;
99 List of names of computers.
101 typedef sequence<string> ListOfComputers ;
103 This struct contains GUI elements used for representation of the module in %IAPP component.
107 string modulename; /*!<Name of the module.*/
108 string moduleusername; /*!<UserName of the module.*/
109 string moduleicone; /*!<Icone representing the module.*/
112 List of pair GUI elements (component name, component icone)
113 used for representation of the module in %IAPP component.
115 typedef sequence<IAPP_Affich> ListOfIAPP_Affich ;
118 This exception is raised when a %component, a %service or a % pathPrefix is not found.
122 string what ; /*!<Indicates if it's a %component, a %service or a % pathPrefix.*/
127 // GetInterfaceList : operation to get a list of the interfaces name of
130 Gets a list of names of interfaces of the component
131 \return a list of interfaces of the component
133 ListOfInterfaces GetInterfaceList() ;
135 // GetInterface : operation to get one interface of a component
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
143 DefinitionInterface GetInterface(in string interfacename) raises(NotFound);
145 // GetServiceList : operation to get a list of the services name of
146 // an interface of a component
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
153 ListOfServices GetServiceList(in string interfacename) raises(NotFound);
156 // GetService : operation to get one service of an interface of a component
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
166 Service GetService(in string interfacename,
167 in string servicename) raises(NotFound);
169 // GetDefaultService : operation to get the default service
170 // of an interface of a component
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
178 Service GetDefaultService(in string interfacename) raises(NotFound);
180 // GetPathPrefix : operation to get the PathPrefix of a computer
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
188 string GetPathPrefix(in string machinename) raises(NotFound);
191 Sets/gets the constraint affected to the component
192 (to be resolved by LifeCycle for the computer choice)
194 readonly attribute string constraint ;
197 Sets/gets the name of the component
199 readonly attribute string componentname;
202 Sets/gets the user name of the component
204 readonly attribute string componentusername;
207 Defines whether the component can be multistudy or not
209 readonly attribute boolean multistudy;
212 Defines the type of the component
214 readonly attribute ComponentType component_type ;
217 Sets/gets the icone of the component (for IAPP)
219 readonly attribute string component_icone;
221 /*! \brief %Module catalog interface
223 This interface is used for creation of the module catalog in %SALOME application.
225 interface ModuleCatalog
230 Gets a list of names of computers of the catalog
232 ListOfComputers GetComputerList();
235 Gets the %PathPrefix of a computer
237 string GetPathPrefix(in string machinename) raises(NotFound);
239 Gets a list of names of components of the catalog
241 ListOfComponents GetComponentList();
243 Gets a list of pair GUI elements (component name, component icone)
244 used for representation of the module in %IAPP component.
247 ListOfIAPP_Affich GetComponentIconeList();
249 Gets a list of names of components of a particular type, which belong to this catalog.
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);
256 Gets one component of the catalog.
258 Acomponent GetComponent(in string componentname) raises(NotFound);