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.
32 Module catalog allows to manage components of %SALOME application, to call specified in the
33 xml files interfaces with the help of AComponent interface.
35 module SALOME_ModuleCatalog
39 This enumeration contains a current set of definitions of the components integrated
40 into %SALOME application.
42 enum ComponentType { GEOM, /*!<Module %GEOM */
43 MESH, /*!<Module %MESH */
44 Med, /*!<Module %Med*/
45 SOLVER, /*!<Module of %SOLVER type */
46 DATA, /*!<Module %DATA */
47 VISU, /*!<Module %VISU */
48 SUPERV, /*!<Module %SUPERVISION */
49 OTHER /*!<Any other type of module */
52 This struct contains fields defining the parameter of the service.
55 struct ServicesParameter
57 string Parametertype; /*!<Type of the parameter.*/
58 string Parametername; /*!<Name of the parameter.*/
61 enum DataStreamDependency {
76 struct ServicesDataStreamParameter
78 DataStreamType Parametertype; /*!<Type of the parameter.*/
79 string Parametername; /*!<Name of the parameter.*/
80 DataStreamDependency Parameterdependency; /*!<Temporal or iterative dependency.*/
84 The list of the parameters of service.
87 typedef sequence<ServicesParameter> ListOfServicesParameter;
88 typedef sequence<ServicesDataStreamParameter> ListOfServicesDataStreamParameter;
91 This struct contains fields completely defining each service.
96 string ServiceName; /*!<Name of the service.*/
97 ListOfServicesParameter ServiceinParameter; /*!< List of input parameters of the services.*/
98 ListOfServicesParameter ServiceoutParameter; /*!< List of output parameters of the services.*/
99 ListOfServicesDataStreamParameter ServiceinDataStreamParameter; /*!< List of input parameters of the services.*/
100 ListOfServicesDataStreamParameter ServiceoutDataStreamParameter; /*!< List of output parameters of the services.*/
101 boolean Servicebydefault; /*!<True if the service is taken with its default fields.*/
102 boolean TypeOfNode; /*!<True is the service is a factory node. Otherwise, it's a compute node.*/
105 List of services of the interface.
107 typedef sequence<Service> ListOfInterfaceService;
111 typedef sequence<string> ListOfServices ;
113 This struct contains fields defining each interface.
115 struct DefinitionInterface
117 string interfacename ; /*!<Name of the interface.*/
118 ListOfInterfaceService interfaceservicelist ; /*!<List of services of the interface.*/
121 List of interface definitions.
123 typedef sequence<DefinitionInterface> ListOfDefInterface ;
125 List of names of interfaces.
127 typedef sequence<string> ListOfInterfaces ;
130 PathPrefix : association of a machine name and
131 a path to a component
139 List of path prefixes
141 typedef sequence<PathPrefix> PathPrefixes;
144 Description of a component
152 boolean implementationType;
155 ListOfDefInterface interfaces;
160 List of names of components.
162 typedef sequence<string> ListOfComponents ;
164 List of names of computers.
166 typedef sequence<string> ListOfComputers ;
168 This struct contains GUI elements used for representation of the module in %IAPP component.
172 string modulename; /*!<Name of the module.*/
173 string moduleusername; /*!<UserName of the module.*/
174 string moduleicone; /*!<Icone representing the module.*/
177 List of pair GUI elements (component name, component icone)
178 used for representation of the module in %IAPP component.
180 typedef sequence<IAPP_Affich> ListOfIAPP_Affich ;
183 This exception is raised when a %component, a %service or a % pathPrefix is not found.
187 string what ; /*!<Indicates if it's a %component, a %service or a % pathPrefix.*/
191 This interface provides the common funcionality information of corresponding component.
192 Information is loaded from specific xml files.
196 // GetInterfaceList : operation to get a list of the interfaces name of
199 Gets the list of names of interfaces of the component
200 \return a list of interfaces of the component
202 ListOfInterfaces GetInterfaceList() ;
204 // GetInterface : operation to get one interface of a component
207 Gets a definite interface of the component
208 \note <BR>If the specified interface doesn't exist, Notfound exception is thrown
209 \param interfacename Name of the interface
210 \return Required interface
212 DefinitionInterface GetInterface(in string interfacename) raises(NotFound);
214 // GetServiceList : operation to get a list of the services name of
215 // an interface of a component
217 Gets the list of names of services of a definite interface belonging to the component.
218 \note <BR>If the specified interface doesn't exist, Notfound exception is thrown.
219 \param interfacename Name of the interface
220 \return List of services of the required interface
222 ListOfServices GetServiceList(in string interfacename) raises(NotFound);
225 // GetService : operation to get one service of an interface of a component
228 Gets a definite service of an interface of the component.
229 \note <BR>If the required service or the specified interface don't exist, Notfound exception is thrown.
230 \param interfacename Name of the interface
231 \param servicename Name of the service
232 \return Required service
235 Service GetService(in string interfacename,
236 in string servicename) raises(NotFound);
238 // GetDefaultService : operation to get the default service
239 // of an interface of a component
241 Gets the default service of an interface of the component.
242 \note <BR>If the required service or the specified interface don't exist, Notfound exception is thrown.
243 \param interfacename Name of the interface
244 \return Required service
247 Service GetDefaultService(in string interfacename) raises(NotFound);
249 // GetPathPrefix : operation to get the PathPrefix of a computer
251 Gets the prefix path of the computer containing the %component.
252 \note <BR>If the required computer doesn't exist, Notfound exception is thrown
253 \param machinename Name of the machine
257 string GetPathPrefix(in string machinename) raises(NotFound);
260 Get the constraint affected to the component
261 (to be resolved by LifeCycle for the computer choice)
263 readonly attribute string constraint ;
266 Get the name of the component
268 readonly attribute string componentname;
271 Get the user name of the component
273 readonly attribute string componentusername;
276 Ask whether the component is multistudy or not
278 readonly attribute boolean multistudy;
281 Ask the type of the component
283 readonly attribute ComponentType component_type ;
286 Gets the icone of the component (for IAPP)
288 readonly attribute string component_icone;
291 Gets the implementation type of the component : C++ or Python (for IAPP)
293 readonly attribute boolean implementation_type;
296 /*! \brief %Module catalog interface
298 This interface is used for creation of the module catalog in %SALOME application.
300 interface ModuleCatalog
305 Gets a list of names of computers of the catalog
307 ListOfComputers GetComputerList();
310 Gets the %PathPrefix of a computer
312 string GetPathPrefix(in string machinename) raises(NotFound);
314 Gets a list of names of components of the catalog
316 ListOfComponents GetComponentList();
318 Gets a list of pair GUI elements (component name, component icone)
319 used for representation of the module in %IAPP component.
322 ListOfIAPP_Affich GetComponentIconeList();
324 Gets a list of names of components of a particular type, which belong to this catalog.
326 // GetComponentList : operation to get a list of the components name of
327 // a particular type of the catalog
328 ListOfComponents GetTypedComponentList(in ComponentType _component_type);
331 Gets one component of the catalog.
333 Acomponent GetComponent(in string componentname) raises(NotFound);
336 Gets the description of a component of the catalog.
338 Component GetComponentInfo(in string componentName) raises(NotFound);
341 Reads a xml file and imports new components from this file.
342 New components replace existing components with the same name.
344 void ImportXmlCatalogFile(in string filename) raises(NotFound);