1 // Copyright (C) 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : SALOME_Component.idl
23 // Author : Paul RASCLE, EDF
26 #ifndef _SALOME_COMPONENT_IDL_
27 #define _SALOME_COMPONENT_IDL_
29 #include "SALOMEDS.idl"
30 #include "SALOME_Exception.idl"
32 /*! \file SALOME_Component.idl \brief interfaces for Component and Container
36 This is a package of interfaces used for connecting new components to %SALOME
37 application. It also contains a set of interfaces used for management of %MED
38 component in %SALOME application.
43 A byte stream which is used for binary data transfer between different
46 typedef sequence<octet> TMPFile;
48 //! General Key Value Structure to set or get properties, for component
55 //! Structure data type to hold reference on data
61 typedef sequence<KeyValuePair> FieldsDict;
65 interface fileTransfer ;
66 interface Salome_file;
68 /*! \brief Interface of the %Container.
69 This interface defines the process of loading and registration
70 of new components in %SALOME application
76 /*! \brief Loads a new component class (dynamic library).
78 \param componentName like COMPONENT, (Python or C++ implementation)
79 try to make a Python import of COMPONENT,
80 then a lib open of libCOMPONENTEngine.so
81 \return true if load successfull or already done, false otherwise
83 boolean load_component_Library(in string componentName);
85 //! Create a new servant instance of a component.
87 Component library must be loaded.
88 \param componentName Name of the component which will be registered
89 in Registry and Name Service,
90 (instance number suffix added to the registered name)
91 \param studyId 0 if instance is not associated to a study,
92 >0 otherwise (== study id)
93 \return a loaded component
95 Engines::Component create_component_instance(in string componentName,
98 //! Find a servant instance of a component
100 \param registeredName Name of the component in Registry or Name Service,
101 without instance suffix number
102 \param studyId 0 if instance is not associated to a study,
103 >0 otherwise (== study id)
104 \return the first instance found with same studyId
106 Component find_component_instance(in string registeredName,
109 //! Find a servant instance of a component, or create a new one.
111 Loads the component library if needed.
112 Only applicable to multiStudy components.
113 \param nameToRegister Name of the component which will be registered
114 in Registry (or Name Service)
115 \param componentName Name of the constructed library of the %component
116 (not used any more, give empty string)
117 \return a loaded component
119 Component load_impl(in string nameToRegister,
120 in string componentName);
122 //! Remove the component servant, and deletes all related objects
124 \param component_i Component to be removed
126 void remove_impl(in Component component_i);
128 //! Unload component libraries from the container.
129 void finalize_removal() ;
131 //! Determines whether the server has been loaded or not.
134 //! Name of the %container
135 readonly attribute string name ;
137 //! working directory of the %container
138 readonly attribute string workingdir ;
140 //! name of the %container log file (this has been set by the launcher)
141 attribute string logfilename ;
143 //! Shutdown the Container process.
146 //! Returns the hostname of the container
147 string getHostName();
149 //! Returns the PID of the container
152 //! Kill the container
154 Returns True if the %container has been killed.
155 Kept for Superv compilation but can't work, unless oneway...
158 boolean Kill_impl() ;
162 returns a fileRef object if origFileName exists and is readable
163 else returns null object. Only one fileRef is created for a given
164 file name, so, several calls with the same file name returns the
167 fileRef createFileRef(in string origFileName);
169 //! Create a Salome_file
171 returns a Salome_file object if origFileName exists and is readable
172 else returns null object.
174 \param origFileName name of the file to be managed (can contain the path).
176 \return Salome_file CORBA reference.
178 Salome_file createSalome_file(in string origFileName);
180 //! Create a fileTransfer
182 returns a fileTransfer object used to copy files from the container
183 machine to the clients machines. Only one fileTransfer instance is
184 created in a container.
186 fileTransfer getFileTransfer();
188 //! Copy a file from a remote host (container) to a local file
190 \param contai the remote container
191 \param remoteFile the file on the remote host to copy
192 \param localFile the local file to create by copy
194 void copyFile(in Container contai, in string remoteFile, in string localFile);
197 /*! \brief Interface of the %component.
198 This interface is used for interaction between the %container and the
199 %component and between the components inside the container.
203 //! The name of the instance of the %Component
204 readonly attribute string instanceName ;
206 //! The name of the interface of the %Component
207 readonly attribute string interfaceName ;
209 //! Determines whether the server has already been loaded or not.
212 //! Get study associated to component instance
214 get study associated to component instance
215 \return -1: not initialised (Internal Error)
216 0: multistudy component instance
217 >0: study id associated to this instance
221 //! Remove component instance from container
223 Deactivates the %Component.
224 -- TO BE USED BY CONTAINER ONLY (Container housekeeping) --
225 use remove_impl from Container instead !
229 //! Returns the container that the %Component refers to.
230 Container GetContainerRef() ;
232 //! Set component instance properties
234 Gives a sequence of (key=string,value=any) to the component.
235 Base class component stores the sequence in a map.
236 The map is cleared before.
237 This map is for use by derived classes.
239 void setProperties(in FieldsDict dico);
241 //! Get component instance properties
243 returns a previously stored map (key=string,value=any) as a sequence.
244 See setProperties(in FieldsDict dico).
246 FieldsDict getProperties();
248 //! Set name of a node in a graph (for %SUPERVISOR use)
250 This method is used by the %SUPERVISOR component. It sets the names of
251 the graph and of the node.
252 \param aGraphName Name of graph
253 \param aNodeName Name of node
255 void Names( in string aGraphName , in string aNodeName ) ;
257 //! Kill the component (if you can)
259 Returns True if the %Component has been killed.
261 boolean Kill_impl() ;
263 //! Stop the component (if you can)
265 Returns True if the activity of the %Component has been stopped.
266 (It's action can't be resumed)
268 boolean Stop_impl() ;
270 //! Suspend the component
272 Returns True if the activity of the %Component has been suspended.
273 (It's action can be resumed)
275 boolean Suspend_impl() ;
277 //! Resume the component
279 Returns True if the activity of the %Component has been resumed.
281 boolean Resume_impl() ;
287 long CpuUsed_impl() ;
289 //! Get a python dump
291 Returns a python script, which is being played back reproduces
292 the data model of component
294 TMPFile DumpPython(in Object theStudy,
295 in boolean isPublished,
296 out boolean isValidScript);
299 //! Returns a CORBA Ref of a input Salome_file managed by a service.
302 \param service_name service's name.
303 \param file_name name of the requested file.
305 \return CORBA Ref of the requested file.
307 \exception contains informations of what if the component cannot
308 sends the file's reference.
310 Engines::Salome_file getInputFileToService(in string service_name,
311 in string Salome_file_name) raises(SALOME::SALOME_Exception);
313 //! Check service input files (transfer them if needed)
315 This method is used before the activation of the service. It calls
316 recvFiles() on all the input Salome_file files of the service.
318 Before each recvFiles(), it uses the callback method named configureSalome_file.
319 This method allows the user to configure the files managed by the Salome_file.
321 By default, there is no files managed when a Salome_file is created,
322 but the supervisor set some files managed by the Salome_file from the information contained
323 into the schema file.
325 \param service_name service's name.
327 \exception contains informations about files that are not in a good state.
329 void checkInputFilesToService(in string service_name) raises(SALOME::SALOME_Exception);
331 //! This method adds a input Salome_file to a service of the component.
334 \param service_name service's name.
335 \param Salome_file_name name of the Salome_file
337 \return a reference of the Salome_file
339 \exception raises an exception if there is already
340 a Salome_file with this name for the service.
342 Engines::Salome_file setInputFileToService(in string service_name,
343 in string Salome_file_name) raises(SALOME::SALOME_Exception);
345 //! Returns a CORBA Ref of a output Salome_file managed by a service.
348 \param service_name service's name.
349 \param file_name name of the requested file.
351 \return CORBA Ref of the requested file.
353 \exception contains informations of what if the component cannot
354 sends the file's reference.
356 Engines::Salome_file getOutputFileToService(in string service_name,
357 in string Salome_file_name) raises(SALOME::SALOME_Exception);
359 //! Check service output files (transfer them if needed)
361 This method is used at the end of the service. It calls
362 recvFiles() on all the output Salome_file files of the service.
364 Before each recvFiles(), it uses the callback method named configureSalome_file.
365 This method allows the user to configure the files managed by the Salome_file.
367 By default, there is no files managed when a Salome_file is created,
368 but the supervisor set some files managed by the Salome_file from the information contained
369 into the schema file.
371 \param service_name service's name.
373 \exception contains informations about files that are not in a good state.
375 void checkOutputFilesToService(in string service_name) raises(SALOME::SALOME_Exception);
377 //! This method adds an output Salome_file to a service of the component.
380 \param service_name service's name.
381 \param Salome_file_name name of the Salome_file
383 \return a reference of the Salome_file
385 \exception raises an exception if there is already
386 a Salome_file with this name for the service.
388 Engines::Salome_file setOutputFileToService(in string service_name,
389 in string Salome_file_name) raises(SALOME::SALOME_Exception);
391 //! Indicate if the component instance provides custom information about its objects.
393 Returns true if the component provides custom information about its objects, false otherwise.
394 Should be redefined in the certain component to return true in case of this
395 component provides such information.
397 boolean hasObjectInfo();
399 //! Get custom information about the given object.
401 This method is used to get the custom information about the given object.
402 Should be redefined in the certain component in case of this
403 component provides such information.
404 It is worth using this method only if hasObjectInfo() method returns true.
406 \param entry object's entry.
407 \param studyId study id
409 \return an information about the given object.
411 string getObjectInfo(in long studyId, in string entry);
414 //! A block of binary data used for file transfer. The maximum size of the block is defined on server side.
415 typedef sequence<octet> fileBlock;
417 /*! \brief Interface of fileTransfer.
418 The fileTransfer and fileRef interfaces provide a file transfer service
419 between different computers.
421 interface fileTransfer
423 //! Open the file transfer
425 open method returns a key (fileId) that identifies the structure
426 (ex: C FILE), associated to the original file on the server.
427 The structure is created by a container for transfer of files availables
428 on the computer which runs the container.
429 Each open gives a unique fileId, to allow concurrent reads of the same
432 long open(in string fileName);
433 //! Open the file transfer in write mode for file fileName
435 \param fileName the file to copy into with putBlock
436 \return the id to use with putBlock
438 long openW(in string fileName);
440 //! Close the file transfer
442 when the file transfer is finished, close method releases structures
443 created by open method, identified by fileId.
445 void close(in long fileId);
447 //! Get a file data block
449 Get successive blocks of octets from the original file.
450 The last block is empty, and identifies the end of file.
452 fileBlock getBlock(in long fileId);
454 //! Put a file data block
456 \param fileId identification of the file obtained by openW
457 \param block a data block to copy into the file identified by fileId
459 void putBlock(in long fileId, in fileBlock block);
463 //! A file managed by a Salome_file.
470 string source_file_name;
471 //! status ("present" or "notpresent")
474 Engines::Container container;
477 //! A sequence of Engines::file.
478 typedef sequence<Engines::file> files;
481 //! The state of a Salome_file.
485 //! hdf5 file where the file can be saved
486 string hdf5_file_name;
487 //! number of files managed
488 long number_of_files;
489 //! information if all the files are received
494 /*! \brief Interface of a Salome_file managed
495 This file is independent of a Salome module. It can managed one or more
496 real files. It's useful for parallel files. Currently Salome_file cannot manage
497 two files that have the same name but not the same path.
499 interface Salome_file : Engines::fileTransfer
501 //! Load a Salome_file from a hdf5 file.
504 \param hdf5_file name (with path) of the hdf5_file.
506 \exception contains informations of errors if the loading doesn't succeed.
508 void load(in string hdf5_file) raises (SALOME::SALOME_Exception);
510 //! Save a Salome_file into a hdf5_file.
513 \param hdf5_file name (with path) of the hdf5_file.
515 \exception contains informations of errors if the save doesn't succeed.
518 void save(in string hdf5_file) raises (SALOME::SALOME_Exception);
520 //! Save a Salome_file into a hdf5_file.
522 All files that are managed are saved into the hdf5_file
524 \param hdf5_file name (with path) of the hdf5_file.
526 \exception contains informations of errors if the save doesn't succeed.
529 void save_all(in string hdf5_file) raises (SALOME::SALOME_Exception);
533 //! Add a Local file to the Salome_file.
536 \param file_name name of the file with the path.
538 \exception raised if the file is already added into the Salome_file.
540 void setLocalFile(in string comp_file_name) raises (SALOME::SALOME_Exception);
542 //! Add a Distributed file to the Salome_file.
545 \param comp_file_name name of the file with the path.
547 \exception raised if the file is already added into the Salome_file.
549 void setDistributedFile(in string comp_file_name) raises (SALOME::SALOME_Exception);
551 //! Connect a Salome_file with another Salome_file.
553 It works only if the Salome_file managed only one file
555 \param source_Salome_file Salome_file that managed the distributed version of the file.
557 \exception raised if there is more or less than one file.
559 void connect(in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception);
561 //! Connect the managed file file_name to a Salome_file.
564 \param file_name name of the file without the path.
565 \param source_Salome_file Salome_file that managed the distributed version of the file.
567 \exception raised if the file doesn't exist.
569 void connectDistributedFile(in string file_name,
570 in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception);
572 //! Connect the file_name with a Distributed file_name.
575 \param file_name name of the file without the path.
576 \param source_file_name It's the name of the file managed by the distributed source Salome_file.
578 \exception raised if the file doesn't exist.
580 void setDistributedSourceFile(in string file_name,
581 in string source_file_name) raises (SALOME::SALOME_Exception);
585 //! Get all the distributed files managed by the Salome_file and check all the local files.
588 \exception raised if some of the files are not ok.
590 void recvFiles() raises (SALOME::SALOME_Exception) ;
594 //! Remove a file of the Salome_file.
597 \param file_name name of the file.
599 \exception raised if the file doesn't exist.
601 void removeFile(in string file_name) raises (SALOME::SALOME_Exception);
603 //! Remove all the files of the Salome_file.
608 //! Get the list of the files managed by the Salome_file.
610 The list can be empty.
612 Engines::files getFilesInfos();
614 //! Get a file managed by the Salome_file.
617 \param file_name the name of the file.
619 \return CORBA file reference.
621 \exception raised if the file doesn't exist.
623 Engines::file getFileInfos(in string file_name) raises (SALOME::SALOME_Exception);
625 //! Return the state of the Salome_file.
626 Engines::SfState getSalome_fileState();
629 //! Set the container where files are.
632 \param container container CORBA's reference.
634 void setContainer(in Engines::Container container);
637 /*! \brief Interface of fileRef.
638 The fileTransfer and fileRef interfaces provide a file transfer service
639 between different computers.
641 A fileRef object is associated to an original file (origFileName) on a
642 machine (refMachine).
643 It is created by a container (factoryServer) on refMachine,
644 with createFileRef(in string origFileName) method.
645 The fileRef object maintains a list of (machine,filename) for copies.
646 If a copy exists on myMachine, getRef(myMachine) returns the file name
647 of the copy on myMachine, else returns empy string.
648 If there is no copy on myMachine, method getFileTransfer() from container
649 factoryServer on refMachine provides a fileTransfer object dedicated to
651 After the copy, addRef(myMachine, localFileNameOnMyMachine) registers
652 the file name of the copy on myMachine.
656 //! the original file
657 readonly attribute string origFileName;
658 //! the machine of the original file
659 readonly attribute string refMachine;
661 Container getContainer();
663 boolean addRef(in string machine,
666 string getRef(in string machine);