1 // Copyright (C) 2007-2019 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, or (at your option) any later version.
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
23 // File : SALOME_Component.idl
24 // Author : Paul RASCLE, EDF
26 #ifndef _SALOME_COMPONENT_IDL_
27 #define _SALOME_COMPONENT_IDL_
29 #include "SALOME_GenericObj.idl"
30 #include "SALOMEDS.idl"
31 #include "SALOME_Exception.idl"
32 #include "SALOME_PyNode.idl"
34 /*! \file SALOME_Component.idl \brief interfaces for EngineComponent and Container
38 This is a package of interfaces used for connecting new components to %SALOME
39 application. It also contains a set of interfaces used for management of %FIELDS
40 component in %SALOME application.
45 A byte stream which is used for binary data transfer between different
48 typedef sequence<octet> TMPFile;
50 //! General Key Value Structure to set or get properties, for component
57 //! Structure data type to hold reference on data
63 typedef sequence<KeyValuePair> FieldsDict;
65 interface EngineComponent ;
67 interface fileTransfer ;
68 interface Salome_file;
70 /*! \brief Interface of the %Container.
71 This interface defines the process of loading and registration
72 of new components in %SALOME application
78 /*! \brief Loads a new component class (dynamic library).
80 \param componentName like COMPONENT, (Python or C++ implementation)
81 try to make a Python import of COMPONENT,
82 then a lib open of libCOMPONENTEngine.so
83 \param reason in case of error (return false) a string explaining the error
84 \return true if load successful or already done, false otherwise
86 boolean load_component_Library(in string componentName, out string reason);
88 //! Create a new servant instance of a component.
90 Component library must be loaded.
91 \param componentName Name of the component which will be registered
92 in Registry and Name Service,
93 (instance number suffix added to the registered name)
94 \return a loaded component
96 Engines::EngineComponent create_component_instance(in string componentName);
98 //! Create a new Python servant instance of a generic service.
100 This simply loads the service in the current container by importing the
101 corresponding Python module.
102 Warning: no internal registration is done, so it is up to the caller to
103 manage the various instantiation.
104 \param serviceName Name of the service
105 \param reason in case of error (return void string) a string explaining the error
106 \return the IOR of the loaded service.
108 string create_python_service_instance(in string serviceName,
111 //! Create a new servant instance of a component with environment variables specified.
113 Component library must be loaded.
114 \param componentName Name of the component which will be registered
115 in Registry and Name Service,
116 (instance number suffix added to the registered name)
117 \param env a dict of env variables
118 \param reason in case of error (return nil) a string explaining the error
119 \return a loaded component
121 Engines::EngineComponent create_component_instance_env(in string componentName,
124 //! Find a servant instance of a component
126 \param registeredName Name of the component in Registry or Name Service,
127 without instance suffix number
128 \return the first instance found
130 EngineComponent find_component_instance(in string registeredName);
132 //! Find a servant instance of a component, or create a new one.
134 Loads the component library if needed.
135 Only applicable to multiStudy components.
136 \param nameToRegister Name of the component which will be registered
137 in Registry (or Name Service)
138 \param componentName Name of the constructed library of the %component
139 (not used any more, give empty string)
140 \return a loaded component
142 EngineComponent load_impl(in string nameToRegister,
143 in string componentName);
145 //! Remove the component servant, and deletes all related objects
147 \param component_i Component to be removed
149 void remove_impl(in EngineComponent component_i);
151 //! Unload component libraries from the container.
152 void finalize_removal() ;
154 //! Determines whether the server has been loaded or not.
157 //! Name of the %container
158 readonly attribute string name ;
160 //! working directory of the %container
161 readonly attribute string workingdir ;
163 //! name of the %container log file (this has been set by the launcher)
164 attribute string logfilename ;
166 //! Shutdown the Container process.
169 //! Returns the hostname of the container
170 string getHostName();
172 //! Returns the PID of the container
175 //! Kill the container
177 Returns True if the %container has been killed.
178 Kept for Superv compilation but can't work, unless oneway...
181 boolean Kill_impl() ;
185 returns a fileRef object if origFileName exists and is readable
186 else returns null object. Only one fileRef is created for a given
187 file name, so, several calls with the same file name returns the
190 fileRef createFileRef(in string origFileName);
192 //! Create a Salome_file
194 returns a Salome_file object if origFileName exists and is readable
195 else returns null object.
197 \param origFileName name of the file to be managed (can contain the path).
199 \return Salome_file CORBA reference.
201 Salome_file createSalome_file(in string origFileName);
203 //! Create a fileTransfer
205 returns a fileTransfer object used to copy files from the container
206 machine to the clients machines. Only one fileTransfer instance is
207 created in a container.
209 fileTransfer getFileTransfer();
211 //! Copy a file from a remote host (container) to a local file
213 \param contai the remote container
214 \param remoteFile the file on the remote host to copy
215 \param localFile the local file to create by copy
217 void copyFile(in Container contai, in string remoteFile, in string localFile);
219 //! Create a PyNode in the container
221 \param nodeName the name of the PyNode
222 \param code python code as text to load in the node
224 PyNode createPyNode(in string nodeName, in string code) raises(SALOME::SALOME_Exception);
226 //! Retrieves the last created PyNode instance with createPyNode.
227 PyNode getDefaultPyNode(in string nodeName);
229 //! Create a PyScriptNode in the container
231 \param nodeName the name of the PyScriptNode
232 \param code python code as text to load in the node
234 PyScriptNode createPyScriptNode(in string nodeName, in string code) raises(SALOME::SALOME_Exception);
236 //! Retrieves the last created PyScriptNode instance with createPyScriptNode.
237 PyScriptNode getDefaultPyScriptNode(in string nodeName);
240 /*! \brief Interface of the %component.
241 This interface is used for interaction between the %container and the
242 %component and between the components inside the container.
244 interface EngineComponent
246 //! The name of the instance of the %Component
247 readonly attribute string instanceName ;
249 //! The name of the interface of the %Component
250 readonly attribute string interfaceName ;
252 //! Determines whether the server has already been loaded or not.
255 //! Remove component instance from container
257 Deactivates the %Component.
258 -- TO BE USED BY CONTAINER ONLY (Container housekeeping) --
259 use remove_impl from Container instead !
263 //! Returns the container that the %Component refers to.
264 Container GetContainerRef() ;
266 //! Set component instance properties
268 Gives a sequence of (key=string,value=any) to the component.
269 Base class component stores the sequence in a map.
270 The map is cleared before.
271 This map is for use by derived classes.
273 void setProperties(in FieldsDict dico);
275 //! Get component instance properties
277 returns a previously stored map (key=string,value=any) as a sequence.
278 See setProperties(in FieldsDict dico).
280 FieldsDict getProperties();
282 //! Set an option value
284 This method is to set an option specific to a certain EngineComponent.
286 void SetOption(in string optionName, in string value);
288 //! Return an option value
290 This method is to get value of an option specific to a certain EngineComponent.
292 string GetOption(in string optionName);
294 //! Set name of a node in a graph (for %SUPERVISOR use)
296 This method is used by the %SUPERVISOR component. It sets the names of
297 the graph and of the node.
298 \param aGraphName Name of graph
299 \param aNodeName Name of node
301 void Names( in string aGraphName , in string aNodeName ) ;
303 //! Kill the component (if you can)
305 Returns True if the %Component has been killed.
307 boolean Kill_impl() ;
309 //! Stop the component (if you can)
311 Returns True if the activity of the %Component has been stopped.
312 (It's action can't be resumed)
314 boolean Stop_impl() ;
316 //! Suspend the component
318 Returns True if the activity of the %Component has been suspended.
319 (It's action can be resumed)
321 boolean Suspend_impl() ;
323 //! Resume the component
325 Returns True if the activity of the %Component has been resumed.
327 boolean Resume_impl() ;
333 long CpuUsed_impl() ;
335 //! Get a python dump
337 Returns a python script, which is being played back reproduces
338 the data model of component
340 TMPFile DumpPython(in boolean isPublished,
341 in boolean isMultiFile,
342 out boolean isValidScript);
345 //! Returns a CORBA Ref of a input 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 information of what if the component cannot
354 sends the file's reference.
356 Engines::Salome_file getInputFileToService(in string service_name,
357 in string Salome_file_name) raises(SALOME::SALOME_Exception);
359 //! Check service input files (transfer them if needed)
361 This method is used before the activation of the service. It calls
362 recvFiles() on all the input 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 information about files that are not in a good state.
375 void checkInputFilesToService(in string service_name) raises(SALOME::SALOME_Exception);
377 //! This method adds a input 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 setInputFileToService(in string service_name,
389 in string Salome_file_name) raises(SALOME::SALOME_Exception);
391 //! Returns a CORBA Ref of a output Salome_file managed by a service.
394 \param service_name service's name.
395 \param file_name name of the requested file.
397 \return CORBA Ref of the requested file.
399 \exception contains information of what if the component cannot
400 sends the file's reference.
402 Engines::Salome_file getOutputFileToService(in string service_name,
403 in string Salome_file_name) raises(SALOME::SALOME_Exception);
405 //! Check service output files (transfer them if needed)
407 This method is used at the end of the service. It calls
408 recvFiles() on all the output Salome_file files of the service.
410 Before each recvFiles(), it uses the callback method named configureSalome_file.
411 This method allows the user to configure the files managed by the Salome_file.
413 By default, there is no files managed when a Salome_file is created,
414 but the supervisor set some files managed by the Salome_file from the information contained
415 into the schema file.
417 \param service_name service's name.
419 \exception contains information about files that are not in a good state.
421 void checkOutputFilesToService(in string service_name) raises(SALOME::SALOME_Exception);
423 //! This method adds an output Salome_file to a service of the component.
426 \param service_name service's name.
427 \param Salome_file_name name of the Salome_file
429 \return a reference of the Salome_file
431 \exception raises an exception if there is already
432 a Salome_file with this name for the service.
434 Engines::Salome_file setOutputFileToService(in string service_name,
435 in string Salome_file_name) raises(SALOME::SALOME_Exception);
437 //! Indicate if the component instance provides custom information about its objects.
439 Returns true if the component provides custom information about its objects, false otherwise.
440 Should be redefined in the certain component to return true in case of this
441 component provides such information.
443 boolean hasObjectInfo();
445 //! Get custom information about the given object.
447 This method is used to get the custom information about the given object.
448 Should be redefined in the certain component in case of this
449 component provides such information.
450 It is worth using this method only if hasObjectInfo() method returns true.
452 \param entry object's entry.
454 \return an information about the given object.
456 string getObjectInfo(in string entry);
458 //! Get version of the component
460 This method is supposed to be implemented in all derived classes; default implementation
461 returns "unknown" string that means that no version information about the component is available.
462 \note The version of the component is stored to the study, as a part of general persistence
463 mechanism; once stored, version information in the study cannot be changed.
465 \return string containing component's version, e.g. "1.0"
471 \brief Base interface of the %component that supports exporting data.
473 interface ImportableComponent
475 /*! \brief Get a list of supported formats */
476 SALOME::StringSeq GetImportableFormats();
477 boolean ImportDataAs(in string format, in SALOME::GenericObj exporter);
480 //! A block of binary data used for file transfer. The maximum size of the block is defined on server side.
481 typedef sequence<octet> fileBlock;
483 /*! \brief Interface of fileTransfer.
484 The fileTransfer and fileRef interfaces provide a file transfer service
485 between different computers.
487 interface fileTransfer : SALOME::GenericObj
489 //! Open the file transfer
491 open method returns a key (fileId) that identifies the structure
492 (ex: C FILE), associated to the original file on the server.
493 The structure is created by a container for transfer of files availables
494 on the computer which runs the container.
495 Each open gives a unique fileId, to allow concurrent reads of the same
498 long open(in string fileName);
499 //! Open the file transfer in write mode for file fileName
501 \param fileName the file to copy into with putBlock
502 \return the id to use with putBlock
504 long openW(in string fileName);
506 //! Close the file transfer
508 when the file transfer is finished, close method releases structures
509 created by open method, identified by fileId.
511 void close(in long fileId);
513 //! Get a file data block
515 Get successive blocks of octets from the original file.
516 The last block is empty, and identifies the end of file.
518 fileBlock getBlock(in long fileId);
520 //! Put a file data block
522 \param fileId identification of the file obtained by openW
523 \param block a data block to copy into the file identified by fileId
525 void putBlock(in long fileId, in fileBlock block);
529 //! A file managed by a Salome_file.
536 string source_file_name;
537 //! status ("present" or "notpresent")
540 Engines::Container container;
543 //! A sequence of Engines::file.
544 typedef sequence<Engines::file> files;
547 //! The state of a Salome_file.
551 //! hdf5 file where the file can be saved
552 string hdf5_file_name;
553 //! number of files managed
554 long number_of_files;
555 //! information if all the files are received
560 /*! \brief Interface of a Salome_file managed
561 This file is independent of a Salome module. It can managed one or more
562 real files. It's useful for parallel files. Currently Salome_file cannot manage
563 two files that have the same name but not the same path.
565 interface Salome_file : Engines::fileTransfer
567 //! Load a Salome_file from a hdf5 file.
570 \param hdf5_file name (with path) of the hdf5_file.
572 \exception contains information of errors if the loading doesn't succeed.
574 void load(in string hdf5_file) raises (SALOME::SALOME_Exception);
576 //! Save a Salome_file into a hdf5_file.
579 \param hdf5_file name (with path) of the hdf5_file.
581 \exception contains information of errors if the save doesn't succeed.
584 void save(in string hdf5_file) raises (SALOME::SALOME_Exception);
586 //! Save a Salome_file into a hdf5_file.
588 All files that are managed are saved into the hdf5_file
590 \param hdf5_file name (with path) of the hdf5_file.
592 \exception contains information of errors if the save doesn't succeed.
595 void save_all(in string hdf5_file) raises (SALOME::SALOME_Exception);
599 //! Add a Local file to the Salome_file.
602 \param file_name name of the file with the path.
604 \exception raised if the file is already added into the Salome_file.
606 void setLocalFile(in string comp_file_name) raises (SALOME::SALOME_Exception);
608 //! Add a Distributed file to the Salome_file.
611 \param comp_file_name name of the file with the path.
613 \exception raised if the file is already added into the Salome_file.
615 void setDistributedFile(in string comp_file_name) raises (SALOME::SALOME_Exception);
617 //! Connect a Salome_file with another Salome_file.
619 It works only if the Salome_file managed only one file
621 \param source_Salome_file Salome_file that managed the distributed version of the file.
623 \exception raised if there is more or less than one file.
625 void connect(in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception);
627 //! Connect the managed file file_name to a Salome_file.
630 \param file_name name of the file without the path.
631 \param source_Salome_file Salome_file that managed the distributed version of the file.
633 \exception raised if the file doesn't exist.
635 void connectDistributedFile(in string file_name,
636 in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception);
638 //! Connect the file_name with a Distributed file_name.
641 \param file_name name of the file without the path.
642 \param source_file_name It's the name of the file managed by the distributed source Salome_file.
644 \exception raised if the file doesn't exist.
646 void setDistributedSourceFile(in string file_name,
647 in string source_file_name) raises (SALOME::SALOME_Exception);
651 //! Get all the distributed files managed by the Salome_file and check all the local files.
654 \exception raised if some of the files are not ok.
656 void recvFiles() raises (SALOME::SALOME_Exception) ;
660 //! Remove a file of the Salome_file.
663 \param file_name name of the file.
665 \exception raised if the file doesn't exist.
667 void removeFile(in string file_name) raises (SALOME::SALOME_Exception);
669 //! Remove all the files of the Salome_file.
674 //! Get the list of the files managed by the Salome_file.
676 The list can be empty.
678 Engines::files getFilesInfos();
680 //! Get a file managed by the Salome_file.
683 \param file_name the name of the file.
685 \return CORBA file reference.
687 \exception raised if the file doesn't exist.
689 Engines::file getFileInfos(in string file_name) raises (SALOME::SALOME_Exception);
691 //! Return the state of the Salome_file.
692 Engines::SfState getSalome_fileState();
695 //! Set the container where files are.
698 \param container container CORBA's reference.
700 void setContainer(in Engines::Container container);
703 /*! \brief Interface of fileRef.
704 The fileTransfer and fileRef interfaces provide a file transfer service
705 between different computers.
707 A fileRef object is associated to an original file (origFileName) on a
708 machine (refMachine).
709 It is created by a container (factoryServer) on refMachine,
710 with createFileRef(in string origFileName) method.
711 The fileRef object maintains a list of (machine,filename) for copies.
712 If a copy exists on myMachine, getRef(myMachine) returns the file name
713 of the copy on myMachine, else returns empty string.
714 If there is no copy on myMachine, method getFileTransfer() from container
715 factoryServer on refMachine provides a fileTransfer object dedicated to
717 After the copy, addRef(myMachine, localFileNameOnMyMachine) registers
718 the file name of the copy on myMachine.
722 //! the original file
723 readonly attribute string origFileName;
724 //! the machine of the original file
725 readonly attribute string refMachine;
727 Container getContainer();
729 boolean addRef(in string machine,
732 string getRef(in string machine);