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 typedef sequence<KeyValuePair> FieldsDict;
59 interface fileTransfer ;
60 interface Salome_file;
62 /*! \brief Interface of the %Container.
63 This interface defines the process of loading and registration
64 of new components in %SALOME application
70 /*! \brief Loads a new component class (dynamic library).
72 \param componentName like COMPONENT, (Python or C++ implementation)
73 try to make a Python import of COMPONENT,
74 then a lib open of libCOMPONENTEngine.so
75 \return true if load successfull or already done, false otherwise
77 boolean load_component_Library(in string componentName);
79 //! Create a new servant instance of a component.
81 Component library must be loaded.
82 \param componentName Name of the component which will be registered
83 in Registry and Name Service,
84 (instance number suffix added to the registered name)
85 \param studyId 0 if instance is not associated to a study,
86 >0 otherwise (== study id)
87 \return a loaded component
89 Engines::Component create_component_instance(in string componentName,
92 //! Find a servant instance of a component
94 \param registeredName Name of the component in Registry or Name Service,
95 without instance suffix number
96 \param studyId 0 if instance is not associated to a study,
97 >0 otherwise (== study id)
98 \return the first instance found with same studyId
100 Component find_component_instance(in string registeredName,
103 //! Find a servant instance of a component, or create a new one.
105 Loads the component library if needed.
106 Only applicable to multiStudy components.
107 \param nameToRegister Name of the component which will be registered
108 in Registry (or Name Service)
109 \param componentName Name of the constructed library of the %component
110 (not used any more, give empty string)
111 \return a loaded component
113 Component load_impl(in string nameToRegister,
114 in string componentName);
116 //! Remove the component servant, and deletes all related objects
118 \param component_i Component to be removed
120 void remove_impl(in Component component_i);
122 //! Unload component libraries from the container.
123 void finalize_removal() ;
125 //! Determines whether the server has been loaded or not.
128 //! Name of the %container
129 readonly attribute string name ;
131 //! working directory of the %container
132 readonly attribute string workingdir ;
134 //! name of the %container log file (this has been set by the launcher)
135 attribute string logfilename ;
137 //! Shutdown the Container process.
140 //! Returns the hostname of the container
141 string getHostName();
143 //! Returns the PID of the container
146 //! Kill the container
148 Returns True if the %container has been killed.
149 Kept for Superv compilation but can't work, unless oneway...
152 boolean Kill_impl() ;
156 returns a fileRef object if origFileName exists and is readable
157 else returns null object. Only one fileRef is created for a given
158 file name, so, several calls with the same file name returns the
161 fileRef createFileRef(in string origFileName);
163 //! Create a Salome_file
165 returns a Salome_file object if origFileName exists and is readable
166 else returns null object.
168 \param origFileName name of the file to be managed (can contain the path).
170 \return Salome_file CORBA reference.
172 Salome_file createSalome_file(in string origFileName);
174 //! Create a fileTransfer
176 returns a fileTransfer object used to copy files from the container
177 machine to the clients machines. Only one fileTransfer instance is
178 created in a container.
180 fileTransfer getFileTransfer();
182 //! Copy a file from a remote host (container) to a local file
184 \param contai the remote container
185 \param remoteFile the file on the remote host to copy
186 \param localFile the local file to create by copy
188 void copyFile(in Container contai, in string remoteFile, in string localFile);
191 /*! \brief Interface of the %component.
192 This interface is used for interaction between the %container and the
193 %component and between the components inside the container.
197 //! The name of the instance of the %Component
198 readonly attribute string instanceName ;
200 //! The name of the interface of the %Component
201 readonly attribute string interfaceName ;
203 //! Determines whether the server has already been loaded or not.
207 // Set study associated to component instance
209 // (=0: multistudy component instance,
210 // >0: study id associated to this instance
211 // \return false if already set with a different value (change not possible)
213 // boolean setStudyId(in long studyId);
215 //! Get study associated to component instance
217 get study associated to component instance
218 \return -1: not initialised (Internal Error)
219 0: multistudy component instance
220 >0: study id associated to this instance
224 //! Remove component instance from container
226 Deactivates the %Component.
227 -- TO BE USED BY CONTAINER ONLY (Container housekeeping) --
228 use remove_impl from Container instead !
232 //! Returns the container that the %Component refers to.
233 Container GetContainerRef() ;
235 //! Set component instance properties
237 Gives a sequence of (key=string,value=any) to the component.
238 Base class component stores the sequence in a map.
239 The map is cleared before.
240 This map is for use by derived classes.
242 void setProperties(in FieldsDict dico);
244 //! Get component instance properties
246 returns a previously stored map (key=string,value=any) as a sequence.
247 See setProperties(in FieldsDict dico).
249 FieldsDict getProperties();
251 //! Set name of a node in a graph (for %SUPERVISOR use)
253 This method is used by the %SUPERVISOR component. It sets the names of
254 the graph and of the node.
255 \param aGraphName Name of graph
256 \param aNodeName Name of node
258 void Names( in string aGraphName , in string aNodeName ) ;
260 //! Kill the component (if you can)
262 Returns True if the %Component has been killed.
264 boolean Kill_impl() ;
266 //! Stop the component (if you can)
268 Returns True if the activity of the %Component has been stopped.
269 (It's action can't be resumed)
271 boolean Stop_impl() ;
273 //! Suspend the component
275 Returns True if the activity of the %Component has been suspended.
276 (It's action can be resumed)
278 boolean Suspend_impl() ;
280 //! Resume the component
282 Returns True if the activity of the %Component has been resumed.
284 boolean Resume_impl() ;
290 long CpuUsed_impl() ;
292 //! Get a python dump
294 Returns a python script, which is being played back reproduces
295 the data model of component
297 TMPFile DumpPython(in Object theStudy,
298 in boolean isPublished,
299 out boolean isValidScript);
302 //! Returns a CORBA Ref of a input Salome_file managed by a service.
305 \param service_name service's name.
306 \param file_name name of the requested file.
308 \return CORBA Ref of the requested file.
310 \exception contains informations of what if the component cannot
311 sends the file's reference.
313 Engines::Salome_file getInputFileToService(in string service_name,
314 in string Salome_file_name) raises(SALOME::SALOME_Exception);
316 //! Check service input files (transfer them if needed)
318 This method is used before the activation of the service. It calls
319 recvFiles() on all the input Salome_file files of the service.
321 Before each recvFiles(), it uses the callback method named configureSalome_file.
322 This method allows the user to configure the files managed by the Salome_file.
324 By default, there is no files managed when a Salome_file is created,
325 but the supervisor set some files managed by the Salome_file from the information contained
326 into the schema file.
328 \param service_name service's name.
330 \exception contains informations about files that are not in a good state.
332 void checkInputFilesToService(in string service_name) raises(SALOME::SALOME_Exception);
334 //! This method adds a input Salome_file to a service of the component.
337 \param service_name service's name.
338 \param Salome_file_name name of the Salome_file
340 \return a reference of the Salome_file
342 \exception raises an exception if there is already
343 a Salome_file with this name for the service.
345 Engines::Salome_file setInputFileToService(in string service_name,
346 in string Salome_file_name) raises(SALOME::SALOME_Exception);
348 //! Returns a CORBA Ref of a output Salome_file managed by a service.
351 \param service_name service's name.
352 \param file_name name of the requested file.
354 \return CORBA Ref of the requested file.
356 \exception contains informations of what if the component cannot
357 sends the file's reference.
359 Engines::Salome_file getOutputFileToService(in string service_name,
360 in string Salome_file_name) raises(SALOME::SALOME_Exception);
362 //! Check service output files (transfer them if needed)
364 This method is used at the end of the service. It calls
365 recvFiles() on all the output Salome_file files of the service.
367 Before each recvFiles(), it uses the callback method named configureSalome_file.
368 This method allows the user to configure the files managed by the Salome_file.
370 By default, there is no files managed when a Salome_file is created,
371 but the supervisor set some files managed by the Salome_file from the information contained
372 into the schema file.
374 \param service_name service's name.
376 \exception contains informations about files that are not in a good state.
378 void checkOutputFilesToService(in string service_name) raises(SALOME::SALOME_Exception);
380 //! This method adds an output Salome_file to a service of the component.
383 \param service_name service's name.
384 \param Salome_file_name name of the Salome_file
386 \return a reference of the Salome_file
388 \exception raises an exception if there is already
389 a Salome_file with this name for the service.
391 Engines::Salome_file setOutputFileToService(in string service_name,
392 in string Salome_file_name) raises(SALOME::SALOME_Exception);
394 //! Indicate if the component instance provides custom information about its objects.
396 Returns true if the component provides custom information about its objects, false otherwise.
397 Should be redefined in the certain component to return true in case of this
398 component provides such information.
400 boolean hasObjectInfo();
402 //! Get custom information about the given object.
404 This method is used to get the custom information about the given object.
405 Should be redefined in the certain component in case of this
406 component provides such information.
407 It is worth using this method only if hasObjectInfo() method returns true.
409 \param entry object's entry.
410 \param studyId study id
412 \return an information about the given object.
414 string getObjectInfo(in long studyId, in string entry);
417 //! A block of binary data used for file transfer. The maximum size of the block is defined on server side.
418 typedef sequence<octet> fileBlock;
420 /*! \brief Interface of fileTransfer.
421 The fileTransfer and fileRef interfaces provide a file transfer service
422 between different computers.
424 interface fileTransfer
426 //! Open the file transfer
428 open method returns a key (fileId) that identifies the structure
429 (ex: C FILE), associated to the original file on the server.
430 The structure is created by a container for transfer of files availables
431 on the computer which runs the container.
432 Each open gives a unique fileId, to allow concurrent reads of the same
435 long open(in string fileName);
436 //! Open the file transfer in write mode for file fileName
438 \param fileName the file to copy into with putBlock
439 \return the id to use with putBlock
441 long openW(in string fileName);
443 //! Close the file transfer
445 when the file transfer is finished, close method releases structures
446 created by open method, identified by fileId.
448 void close(in long fileId);
450 //! Get a file data block
452 Get successive blocks of octets from the original file.
453 The last block is empty, and identifies the end of file.
455 fileBlock getBlock(in long fileId);
457 //! Put a file data block
459 \param fileId identification of the file obtained by openW
460 \param block a data block to copy into the file identified by fileId
462 void putBlock(in long fileId, in fileBlock block);
466 //! A file managed by a Salome_file.
473 string source_file_name;
474 //! status ("present" or "notpresent")
477 Engines::Container container;
480 //! A sequence of Engines::file.
481 typedef sequence<Engines::file> files;
484 //! The state of a Salome_file.
488 //! hdf5 file where the file can be saved
489 string hdf5_file_name;
490 //! number of files managed
491 long number_of_files;
492 //! information if all the files are received
497 /*! \brief Interface of a Salome_file managed
498 This file is independent of a Salome module. It can managed one or more
499 real files. It's useful for parallel files. Currently Salome_file cannot manage
500 two files that have the same name but not the same path.
502 interface Salome_file : Engines::fileTransfer
504 //! Load a Salome_file from a hdf5 file.
507 \param hdf5_file name (with path) of the hdf5_file.
509 \exception contains informations of errors if the loading doesn't succeed.
511 void load(in string hdf5_file) raises (SALOME::SALOME_Exception);
513 //! Save a Salome_file into a hdf5_file.
516 \param hdf5_file name (with path) of the hdf5_file.
518 \exception contains informations of errors if the save doesn't succeed.
521 void save(in string hdf5_file) raises (SALOME::SALOME_Exception);
523 //! Save a Salome_file into a hdf5_file.
525 All files that are managed are saved into the hdf5_file
527 \param hdf5_file name (with path) of the hdf5_file.
529 \exception contains informations of errors if the save doesn't succeed.
532 void save_all(in string hdf5_file) raises (SALOME::SALOME_Exception);
536 //! Add a Local file to the Salome_file.
539 \param file_name name of the file with the path.
541 \exception raised if the file is already added into the Salome_file.
543 void setLocalFile(in string comp_file_name) raises (SALOME::SALOME_Exception);
545 //! Add a Distributed file to the Salome_file.
548 \param comp_file_name name of the file with the path.
550 \exception raised if the file is already added into the Salome_file.
552 void setDistributedFile(in string comp_file_name) raises (SALOME::SALOME_Exception);
554 //! Connect a Salome_file with another Salome_file.
556 It works only if the Salome_file managed only one file
558 \param source_Salome_file Salome_file that managed the distributed version of the file.
560 \exception raised if there is more or less than one file.
562 void connect(in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception);
564 //! Connect the managed file file_name to a Salome_file.
567 \param file_name name of the file without the path.
568 \param source_Salome_file Salome_file that managed the distributed version of the file.
570 \exception raised if the file doesn't exist.
572 void connectDistributedFile(in string file_name,
573 in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception);
575 //! Connect the file_name with a Distributed file_name.
578 \param file_name name of the file without the path.
579 \param source_file_name It's the name of the file managed by the distributed source Salome_file.
581 \exception raised if the file doesn't exist.
583 void setDistributedSourceFile(in string file_name,
584 in string source_file_name) raises (SALOME::SALOME_Exception);
588 //! Get all the distributed files managed by the Salome_file and check all the local files.
591 \exception raised if some of the files are not ok.
593 void recvFiles() raises (SALOME::SALOME_Exception) ;
597 //! Remove a file of the Salome_file.
600 \param file_name name of the file.
602 \exception raised if the file doesn't exist.
604 void removeFile(in string file_name) raises (SALOME::SALOME_Exception);
606 //! Remove all the files of the Salome_file.
611 //! Get the list of the files managed by the Salome_file.
613 The list can be empty.
615 Engines::files getFilesInfos();
617 //! Get a file managed by the Salome_file.
620 \param file_name the name of the file.
622 \return CORBA file reference.
624 \exception raised if the file doesn't exist.
626 Engines::file getFileInfos(in string file_name) raises (SALOME::SALOME_Exception);
628 //! Return the state of the Salome_file.
629 Engines::SfState getSalome_fileState();
632 //! Set the container where files are.
635 \param container container CORBA's reference.
637 void setContainer(in Engines::Container container);
640 /*! \brief Interface of fileRef.
641 The fileTransfer and fileRef interfaces provide a file transfer service
642 between different computers.
644 A fileRef object is associated to an original file (origFileName) on a
645 machine (refMachine).
646 It is created by a container (factoryServer) on refMachine,
647 with createFileRef(in string origFileName) method.
648 The fileRef object maintains a list of (machine,filename) for copies.
649 If a copy exists on myMachine, getRef(myMachine) returns the file name
650 of the copy on myMachine, else returns empy string.
651 If there is no copy on myMachine, method getFileTransfer() from container
652 factoryServer on refMachine provides a fileTransfer object dedicated to
654 After the copy, addRef(myMachine, localFileNameOnMyMachine) registers
655 the file name of the copy on myMachine.
659 //! the original file
660 readonly attribute string origFileName;
661 //! the machine of the original file
662 readonly attribute string refMachine;
664 Container getContainer();
666 boolean addRef(in string machine,
669 string getRef(in string machine);