Version: 6.5.0
SALOME_ModuleCatalog.idl
Go to the documentation of this file.
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 : SALOME_ModuleCatalog.idl
24 // Author : Estelle Deville
25 // $Header: /home/server/cvs/KERNEL/KERNEL_SRC/idl/SALOME_ModuleCatalog.idl,v 1.11.2.1.22.2.12.1 2012-04-12 14:04:58 vsr Exp $
26 //
38 {
43  MESH,
44  Med,
46  DATA,
47  VISU,
50  } ;
53  {
54  string Parametertype;
55  string Parametername;
56  } ;
57 
63  } ;
64 
67  {
68  string Parametertype;
69  string Parametername;
71  } ;
72 
74  typedef sequence<ServicesParameter> ListOfServicesParameter;
76  typedef sequence<ServicesDataStreamParameter> ListOfServicesDataStreamParameter;
77 
79  typedef sequence<string> ListOfString;
80 
82  enum TypeKind
83  {
84  NONE ,
85  Dble ,
86  Int ,
87  Str ,
88  Bool ,
89  Objref ,
90  Seq ,
91  Array ,
93  };
94 
97  {
98  string name;
99  string type;
100  };
102  typedef sequence<MemberDefinition> ListOfMemberDefinition;
103 
106  {
107  string name;
109  string id;
110  string content;
111  ListOfString bases;
112  ListOfMemberDefinition members;
113  };
114 
116  typedef sequence<TypeDefinition> ListOfTypeDefinition;
117 
119  struct Service
120  {
121  string ServiceName;
122  ListOfServicesParameter ServiceinParameter;
123  ListOfServicesParameter ServiceoutParameter;
124  ListOfServicesDataStreamParameter ServiceinDataStreamParameter;
125  ListOfServicesDataStreamParameter ServiceoutDataStreamParameter;
127  boolean TypeOfNode;
128  } ;
130  typedef sequence<Service> ListOfInterfaceService;
132  typedef sequence<string> ListOfServices ;
135  {
136  string interfacename ;
137  ListOfInterfaceService interfaceservicelist ;
138  } ;
140  typedef sequence<DefinitionInterface> ListOfDefInterface ;
142  typedef sequence<string> ListOfInterfaces ;
143 
147  struct PathPrefix {
148  string machine;
149  string path;
150  };
151 
153  typedef sequence<PathPrefix> PathPrefixes;
154 
156  enum ImplType {
157  SO,
158  PY,
159  EXE,
161  } ;
162 
165  {
166  ComponentType type;
167  string name;
168  string username;
169  boolean multistudy;
170  ImplType implementationType;
171  string implname;
172  string icon;
173  string constraint;
174  ListOfDefInterface interfaces;
175  PathPrefixes paths;
176  };
177 
179  typedef sequence<string> ListOfComponents ;
181  typedef sequence<string> ListOfComputers ;
183  struct IAPP_Affich
184  {
185  string modulename;
186  string moduleusername;
187  string moduleicone;
188  string moduleversion;
189  string modulecomment;
190  };
195  typedef sequence<IAPP_Affich> ListOfIAPP_Affich ;
196 
198  exception NotFound
199  {
200  string what ;
201  } ;
202 
207  interface Acomponent
208  {
213  ListOfInterfaces GetInterfaceList() ;
214 
221  DefinitionInterface GetInterface(in string interfacename) raises(NotFound);
222 
229  ListOfServices GetServiceList(in string interfacename) raises(NotFound);
230 
231 
239  Service GetService(in string interfacename,
240  in string servicename) raises(NotFound);
241 
248  Service GetDefaultService(in string interfacename) raises(NotFound);
249 
256  string GetPathPrefix(in string machinename) raises(NotFound);
257 
262  readonly attribute string constraint ;
263 
266  readonly attribute string componentname;
267 
270  readonly attribute string componentusername;
271 
274  readonly attribute boolean multistudy;
275 
278  readonly attribute ComponentType component_type ;
279 
282  readonly attribute string component_icone;
283 
288  readonly attribute ImplType implementation_type;
294  readonly attribute string implementation_name;
295  } ;
296 
301  interface ModuleCatalog
302  {
305  void ping();
306 
309  long getPID();
310 
313  oneway void ShutdownWithExit();
314 
317  ListOfTypeDefinition GetTypes();
318 
321  ListOfComputers GetComputerList();
322 
324  string GetPathPrefix(in string machinename) raises(NotFound);
325 
327  ListOfComponents GetComponentList();
328 
332  ListOfIAPP_Affich GetComponentIconeList();
333 
336  ListOfComponents GetTypedComponentList(in ComponentType _component_type);
337 
340  Acomponent GetComponent(in string componentname) raises(NotFound);
341 
344  ComponentDef GetComponentInfo(in string componentName) raises(NotFound);
345 
350  void ImportXmlCatalogFile(in string filename) raises(NotFound);
351 
354  void shutdown();
355  } ;
356 };
This struct contains fields defining each service.
Definition: SALOME_ModuleCatalog.idl:119
sequence< Service > ListOfInterfaceService
List of services of the interface.
Definition: SALOME_ModuleCatalog.idl:130
Module catalog interface
Definition: SALOME_ModuleCatalog.idl:301
string Parametername
Definition: SALOME_ModuleCatalog.idl:55
This struct contains GUI elements used for representation of the module in IAPP component.
Definition: SALOME_ModuleCatalog.idl:183
readonly attribute ImplType implementation_type
Get the implementation type of the component.
Definition: SALOME_ModuleCatalog.idl:288
sequence< IAPP_Affich > ListOfIAPP_Affich
List of pair GUI elements (component name, component icone)
Definition: SALOME_ModuleCatalog.idl:195
string moduleicone
Definition: SALOME_ModuleCatalog.idl:187
ComponentType
This enumeration contains a current set of definitions of the components integrated into SALOME appli...
Definition: SALOME_ModuleCatalog.idl:42
ImplType
Component implementation type.
Definition: SALOME_ModuleCatalog.idl:156
ListOfServicesParameter ServiceinParameter
Definition: SALOME_ModuleCatalog.idl:122
Definition: SALOME_ModuleCatalog.idl:87
sequence< PathPrefix > PathPrefixes
List of path prefixes.
Definition: SALOME_ModuleCatalog.idl:153
Definition: SALOME_ModuleCatalog.idl:159
readonly attribute boolean multistudy
Get whether the component is multistudy or not.
Definition: SALOME_ModuleCatalog.idl:274
string ServiceName
Definition: SALOME_ModuleCatalog.idl:121
Definition: SALOME_ModuleCatalog.idl:90
sequence< string > ListOfString
a string list
Definition: SALOME_ModuleCatalog.idl:79
DataStreamDependency
enumeration to define datastream ports dependency
Definition: SALOME_ModuleCatalog.idl:59
string id
Definition: SALOME_ModuleCatalog.idl:109
string name
Definition: SALOME_ModuleCatalog.idl:98
This struct contains fields defining the parameter of the service.
Definition: SALOME_ModuleCatalog.idl:52
Definition: SALOME_ModuleCatalog.idl:88
Definition: SALOME_Session.idl:39
Struct to get the definition of types used in Salome catalogs.
Definition: SALOME_ModuleCatalog.idl:105
The main package of interfaces used for the module catalog in SALOME application. ...
Definition: SALOME_ModuleCatalog.idl:37
ListOfString bases
Definition: SALOME_ModuleCatalog.idl:111
Definition: SALOME_ModuleCatalog.idl:92
Definition: SALOME_ModuleCatalog.idl:44
Definition: SALOME_ModuleCatalog.idl:62
sequence< string > ListOfInterfaces
List of interface names.
Definition: SALOME_ModuleCatalog.idl:142
string moduleversion
Definition: SALOME_ModuleCatalog.idl:188
readonly attribute ComponentType component_type
Get the type of the component.
Definition: SALOME_ModuleCatalog.idl:278
string what
Definition: SALOME_ModuleCatalog.idl:200
sequence< DefinitionInterface > ListOfDefInterface
List of interface definitions.
Definition: SALOME_ModuleCatalog.idl:140
string name
Definition: SALOME_ModuleCatalog.idl:107
sequence< MemberDefinition > ListOfMemberDefinition
List of member definitions in a structure.
Definition: SALOME_ModuleCatalog.idl:102
struct to define members of a Struc TypeKind
Definition: SALOME_ModuleCatalog.idl:96
string Parametertype
Definition: SALOME_ModuleCatalog.idl:68
ListOfInterfaceService interfaceservicelist
Definition: SALOME_ModuleCatalog.idl:137
Definition: SALOME_ModuleCatalog.idl:45
Definition: SALOME_ModuleCatalog.idl:48
string modulecomment
Definition: SALOME_ModuleCatalog.idl:189
sequence< ServicesParameter > ListOfServicesParameter
The list of the parameters of service.
Definition: SALOME_ModuleCatalog.idl:74
Definition: SALOME_ModuleCatalog.idl:89
readonly attribute string component_icone
Get the icone of the component (for IAPP)
Definition: SALOME_ModuleCatalog.idl:282
sequence< TypeDefinition > ListOfTypeDefinition
list of type definitions
Definition: SALOME_ModuleCatalog.idl:116
sequence< string > ListOfServices
List of services.
Definition: SALOME_ModuleCatalog.idl:132
This struct contains fields defining each interface.
Definition: SALOME_ModuleCatalog.idl:134
sequence< string > ListOfComponents
List of component names.
Definition: SALOME_ModuleCatalog.idl:179
Definition: SALOME_ModuleCatalog.idl:158
string Parametername
Definition: SALOME_ModuleCatalog.idl:69
ListOfServicesDataStreamParameter ServiceinDataStreamParameter
Definition: SALOME_ModuleCatalog.idl:124
readonly attribute string constraint
Get the constraint affected to the component.
Definition: SALOME_ModuleCatalog.idl:262
Definition: SALOME_ModuleCatalog.idl:85
sequence< ServicesDataStreamParameter > ListOfServicesDataStreamParameter
The list of datastream parameters of service.
Definition: SALOME_ModuleCatalog.idl:76
ListOfServicesDataStreamParameter ServiceoutDataStreamParameter
Definition: SALOME_ModuleCatalog.idl:125
Definition: SALOME_ModuleCatalog.idl:160
TypeKind
enumeration to define data types used by services
Definition: SALOME_ModuleCatalog.idl:82
string interfacename
Definition: SALOME_ModuleCatalog.idl:136
Definition: SALOME_ModuleCatalog.idl:42
Definition: SALOME_ModuleCatalog.idl:86
TypeKind kind
Definition: SALOME_ModuleCatalog.idl:108
PathPrefix : association of a machine name and a path to a component.
Definition: SALOME_ModuleCatalog.idl:147
Definition: SALOME_ModuleCatalog.idl:46
sequence< string > ListOfComputers
List of computer names.
Definition: SALOME_ModuleCatalog.idl:181
string modulename
Definition: SALOME_ModuleCatalog.idl:185
ListOfMemberDefinition members
Definition: SALOME_ModuleCatalog.idl:112
Definition: SALOME_ModuleCatalog.idl:60
readonly attribute string componentusername
Get the user name of the component.
Definition: SALOME_ModuleCatalog.idl:270
Definition: SALOME_ModuleCatalog.idl:61
readonly attribute string componentname
Get the component name.
Definition: SALOME_ModuleCatalog.idl:266
boolean Servicebydefault
Definition: SALOME_ModuleCatalog.idl:126
struct to define datastream ports
Definition: SALOME_ModuleCatalog.idl:66
Definition: SALOME_ModuleCatalog.idl:43
Description of a component.
Definition: SALOME_ModuleCatalog.idl:164
Definition: SALOME_ModuleCatalog.idl:157
string Parametertype
Definition: SALOME_ModuleCatalog.idl:54
Definition: SALOME_ModuleCatalog.idl:47
string type
Definition: SALOME_ModuleCatalog.idl:99
string moduleusername
Definition: SALOME_ModuleCatalog.idl:186
Definition: SALOME_ModuleCatalog.idl:91
Definition: SALOME_ModuleCatalog.idl:49
DataStreamDependency Parameterdependency
Definition: SALOME_ModuleCatalog.idl:70
readonly attribute string implementation_name
Get the implementation name of the component.
Definition: SALOME_ModuleCatalog.idl:294
This interface provides the common functionality information of corresponding component.
Definition: SALOME_ModuleCatalog.idl:207
ListOfServicesParameter ServiceoutParameter
Definition: SALOME_ModuleCatalog.idl:123
string content
Definition: SALOME_ModuleCatalog.idl:110
boolean TypeOfNode
Definition: SALOME_ModuleCatalog.idl:127
This exception is raised when a component, a service or a pathPrefix is not found.
Definition: SALOME_ModuleCatalog.idl:198
Copyright © 2007-2012 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS