1 // Copyright (C) 2007-2024 CEA, EDF, 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"
33 #include "SALOME_Embedded_NamingService.idl"
34 #include "SALOME_Comm.idl"
36 /*! \file SALOME_Component.idl \brief interfaces for EngineComponent and Container
40 This is a package of interfaces used for connecting new components to %SALOME
41 application. It also contains a set of interfaces used for management of %FIELDS
42 component in %SALOME application.
47 A byte stream which is used for binary data transfer between different
50 typedef sequence<octet> TMPFile;
52 //! General Key Value Structure to set or get properties, for component
59 //! Structure data type to hold reference on data
65 typedef sequence<KeyValuePair> FieldsDict;
66 typedef sequence<double> vectorOfDouble;
67 typedef sequence<string> vectorOfString;
68 typedef sequence<vectorOfString> vectorOfVectorOfString;
70 interface EngineComponent ;
72 interface fileTransfer ;
73 interface Salome_file;
75 /*! \brief Interface of the %Container.
76 This interface defines the process of loading and registration
77 of new components in %SALOME application
83 void override_environment( in FieldsDict env );
85 void override_environment_python( in FieldsDict env );
87 FieldsDict get_os_environment();
89 void set_big_obj_on_disk_threshold(in long thresholdInByte);
91 void set_big_obj_on_disk_directory(in string directory);
93 void set_number_of_retry(in long nbRetry);
95 void addLogFileNameGroup(in vectorOfString groupOfLogFileNames);
97 vectorOfVectorOfString getAllLogFileNameGroups();
99 void execute_python_code( in string code ) raises(SALOME::SALOME_Exception);
101 /*! \brief Loads a new component class (dynamic library).
103 \param componentName like COMPONENT, (Python or C++ implementation)
104 try to make a Python import of COMPONENT,
105 then a lib open of libCOMPONENTEngine.so
106 \param reason in case of error (return false) a string explaining the error
107 \return true if load successful or already done, false otherwise
109 boolean load_component_Library(in string componentName, out string reason);
111 //! Create a new servant instance of a component.
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 \return a loaded component
119 Engines::EngineComponent create_component_instance(in string componentName);
121 //! Create a new Python servant instance of a generic service.
123 This simply loads the service in the current container by importing the
124 corresponding Python module.
125 Warning: no internal registration is done, so it is up to the caller to
126 manage the various instantiation.
127 \param serviceName Name of the service
128 \param reason in case of error (return void string) a string explaining the error
129 \return the IOR of the loaded service.
131 string create_python_service_instance(in string serviceName,
134 //! Create a new servant instance of a component with environment variables specified.
136 Component library must be loaded.
137 \param componentName Name of the component which will be registered
138 in Registry and Name Service,
139 (instance number suffix added to the registered name)
140 \param env a dict of env variables
141 \param reason in case of error (return nil) a string explaining the error
142 \return a loaded component
144 Engines::EngineComponent create_component_instance_env(in string componentName,
147 //! Find a servant instance of a component
149 \param registeredName Name of the component in Registry or Name Service,
150 without instance suffix number
151 \return the first instance found
153 EngineComponent find_component_instance(in string registeredName);
155 //! Find a servant instance of a component, or create a new one.
157 Loads the component library if needed.
158 Only applicable to multiStudy components.
159 \param nameToRegister Name of the component which will be registered
160 in Registry (or Name Service)
161 \param componentName Name of the constructed library of the %component
162 (not used any more, give empty string)
163 \return a loaded component
165 EngineComponent load_impl(in string nameToRegister,
166 in string componentName);
168 //! Remove the component servant, and deletes all related objects
170 \param component_i Component to be removed
172 void remove_impl(in EngineComponent component_i);
174 //! In case of SSL mode Returns entry to Embedded NS
175 EmbeddedNamingService get_embedded_NS_if_ssl();
177 boolean is_SSL_mode();
179 //! Unload component libraries from the container.
180 void finalize_removal() ;
182 //! Determines whether the server has been loaded or not.
185 //! Name of the %container
186 readonly attribute string name ;
188 //! working directory of the %container
189 readonly attribute string workingdir ;
191 //! name of the %container log file (this has been set by the launcher)
192 attribute string logfilename ;
194 //! name of the %container log file
195 attribute string locallogfilename ;
197 //! interval of time between two measures of CPU/time process container
198 attribute long monitoringtimeresms;
200 void verbosity(out boolean activated, out string level);
202 void setVerbosity(in boolean activated, in string level);
204 //! Shutdown the Container process. Shutdown is not immediate. It waits for all remaining invokation completion.
207 //! Shutdown the Container process. Shutdown is immediate for this method.
210 //! Returns the hostname of the container
211 string getHostName();
213 //! Returns the PID of the container
216 //! Kill the container
218 Returns True if the %container has been killed.
219 Kept for Superv compilation but can't work, unless oneway...
222 boolean Kill_impl() ;
226 returns a fileRef object if origFileName exists and is readable
227 else returns null object. Only one fileRef is created for a given
228 file name, so, several calls with the same file name returns the
231 fileRef createFileRef(in string origFileName);
233 //! Create a Salome_file
235 returns a Salome_file object if origFileName exists and is readable
236 else returns null object.
238 \param origFileName name of the file to be managed (can contain the path).
240 \return Salome_file CORBA reference.
242 Salome_file createSalome_file(in string origFileName);
244 //! Create a fileTransfer
246 returns a fileTransfer object used to copy files from the container
247 machine to the clients machines. Only one fileTransfer instance is
248 created in a container.
250 fileTransfer getFileTransfer();
252 //! Copy a file from a remote host (container) to a local file
254 \param contai the remote container
255 \param remoteFile the file on the remote host to copy
256 \param localFile the local file to create by copy
258 void copyFile(in Container contai, in string remoteFile, in string localFile);
260 //! Create a PyNode in the container
262 \param nodeName the name of the PyNode
263 \param code python code as text to load in the node
265 PyNode createPyNode(in string nodeName, in string code) raises(SALOME::SALOME_Exception);
267 //! Retrieves the last created PyNode instance with createPyNode.
268 PyNode getDefaultPyNode(in string nodeName);
270 //! Create a PyScriptNode in the container
272 \param nodeName the name of the PyScriptNode
273 \param code python code as text to load in the node
275 PyScriptNode createPyScriptNode(in string nodeName, in string code) raises(SALOME::SALOME_Exception);
277 void removePyScriptNode(in string nodeName) raises(SALOME::SALOME_Exception);
279 //! Retrieves the last created PyScriptNode instance with createPyScriptNode.
280 PyScriptNode getDefaultPyScriptNode(in string nodeName);
282 //! This method remove all refs of PyScriptNode servant objects stored in server.
284 * Previous scripts created on container may have been stored in a map. This method removes them. It then clean all the contexts dict attached to them.
286 void cleanAllPyScripts();
288 //! Return number of CPU cores in the calculation node.
289 long getNumberOfCPUCores();
291 //! Return a load of each CPU core.
292 vectorOfDouble loadOfCPUCores() raises(SALOME::SALOME_Exception);
294 //! Set custom script to calculate a load of each CPU core.
296 \param script Python script to execute
298 void setPyScriptForCPULoad(in string script);
300 //! Nullify custom script to calculate each CPU core's load.
301 void resetScriptForCPULoad();
303 //! Get total physical memory of calculation node, in megabytes.
304 long getTotalPhysicalMemory();
306 //! Get used physical memory of calculation node, in megabytes.
307 long getTotalPhysicalMemoryInUse();
309 //! Obtain physical memory, used by the current process, in megabytes.
310 long getTotalPhysicalMemoryInUseByMe();
313 /*! \brief Interface of the %component.
314 This interface is used for interaction between the %container and the
315 %component and between the components inside the container.
317 interface EngineComponent
319 //! The name of the instance of the %Component
320 readonly attribute string instanceName ;
322 //! The name of the interface of the %Component
323 readonly attribute string interfaceName ;
325 //! Determines whether the server has already been loaded or not.
328 boolean isSSLMode() raises(SALOME::SALOME_Exception);
329 //! Remove component instance from container
331 Deactivates the %Component.
332 -- TO BE USED BY CONTAINER ONLY (Container housekeeping) --
333 use remove_impl from Container instead !
337 //! Returns the container that the %Component refers to.
338 Container GetContainerRef() ;
340 //! Set component instance properties
342 Gives a sequence of (key=string,value=any) to the component.
343 Base class component stores the sequence in a map.
344 The map is cleared before.
345 This map is for use by derived classes.
347 void setProperties(in FieldsDict dico);
349 //! Get component instance properties
351 returns a previously stored map (key=string,value=any) as a sequence.
352 See setProperties(in FieldsDict dico).
354 FieldsDict getProperties();
356 //! Set an option value
358 This method is to set an option specific to a certain EngineComponent.
360 void SetOption(in string optionName, in string value);
362 //! Return an option value
364 This method is to get value of an option specific to a certain EngineComponent.
366 string GetOption(in string optionName);
368 //! Set name of a node in a graph (for %SUPERVISOR use)
370 This method is used by the %SUPERVISOR component. It sets the names of
371 the graph and of the node.
372 \param aGraphName Name of graph
373 \param aNodeName Name of node
375 void Names( in string aGraphName , in string aNodeName ) ;
377 //! Kill the component (if you can)
379 Returns True if the %Component has been killed.
381 boolean Kill_impl() ;
383 //! Stop the component (if you can)
385 Returns True if the activity of the %Component has been stopped.
386 (It's action can't be resumed)
388 boolean Stop_impl() ;
390 //! Suspend the component
392 Returns True if the activity of the %Component has been suspended.
393 (It's action can be resumed)
395 boolean Suspend_impl() ;
397 //! Resume the component
399 Returns True if the activity of the %Component has been resumed.
401 boolean Resume_impl() ;
407 long CpuUsed_impl() ;
409 //! Get a python dump
411 Returns a python script, which is being played back reproduces
412 the data model of component
414 TMPFile DumpPython(in boolean isPublished,
415 in boolean isMultiFile,
416 out boolean isValidScript);
419 //! Returns a CORBA Ref of a input Salome_file managed by a service.
422 \param service_name service's name.
423 \param file_name name of the requested file.
425 \return CORBA Ref of the requested file.
427 \exception contains information of what if the component cannot
428 sends the file's reference.
430 Engines::Salome_file getInputFileToService(in string service_name,
431 in string Salome_file_name) raises(SALOME::SALOME_Exception);
433 //! Check service input files (transfer them if needed)
435 This method is used before the activation of the service. It calls
436 recvFiles() on all the input Salome_file files of the service.
438 Before each recvFiles(), it uses the callback method named configureSalome_file.
439 This method allows the user to configure the files managed by the Salome_file.
441 By default, there is no files managed when a Salome_file is created,
442 but the supervisor set some files managed by the Salome_file from the information contained
443 into the schema file.
445 \param service_name service's name.
447 \exception contains information about files that are not in a good state.
449 void checkInputFilesToService(in string service_name) raises(SALOME::SALOME_Exception);
451 //! This method adds a input Salome_file to a service of the component.
454 \param service_name service's name.
455 \param Salome_file_name name of the Salome_file
457 \return a reference of the Salome_file
459 \exception raises an exception if there is already
460 a Salome_file with this name for the service.
462 Engines::Salome_file setInputFileToService(in string service_name,
463 in string Salome_file_name) raises(SALOME::SALOME_Exception);
465 //! Returns a CORBA Ref of a output Salome_file managed by a service.
468 \param service_name service's name.
469 \param file_name name of the requested file.
471 \return CORBA Ref of the requested file.
473 \exception contains information of what if the component cannot
474 sends the file's reference.
476 Engines::Salome_file getOutputFileToService(in string service_name,
477 in string Salome_file_name) raises(SALOME::SALOME_Exception);
479 //! Check service output files (transfer them if needed)
481 This method is used at the end of the service. It calls
482 recvFiles() on all the output Salome_file files of the service.
484 Before each recvFiles(), it uses the callback method named configureSalome_file.
485 This method allows the user to configure the files managed by the Salome_file.
487 By default, there is no files managed when a Salome_file is created,
488 but the supervisor set some files managed by the Salome_file from the information contained
489 into the schema file.
491 \param service_name service's name.
493 \exception contains information about files that are not in a good state.
495 void checkOutputFilesToService(in string service_name) raises(SALOME::SALOME_Exception);
497 //! This method adds an output Salome_file to a service of the component.
500 \param service_name service's name.
501 \param Salome_file_name name of the Salome_file
503 \return a reference of the Salome_file
505 \exception raises an exception if there is already
506 a Salome_file with this name for the service.
508 Engines::Salome_file setOutputFileToService(in string service_name,
509 in string Salome_file_name) raises(SALOME::SALOME_Exception);
511 //! Indicate if the component instance provides custom information about its objects.
513 Returns true if the component provides custom information about its objects, false otherwise.
514 Should be redefined in the certain component to return true in case of this
515 component provides such information.
517 boolean hasObjectInfo();
519 //! Get custom information about the given object.
521 This method is used to get the custom information about the given object.
522 Should be redefined in the certain component in case of this
523 component provides such information.
524 It is worth using this method only if hasObjectInfo() method returns true.
526 \param entry object's entry.
528 \return an information about the given object.
530 string getObjectInfo(in string entry);
532 //! Get version of the component
534 This method is supposed to be implemented in all derived classes; default implementation
535 returns "unknown" string that means that no version information about the component is available.
536 \note The version of the component is stored to the study, as a part of general persistence
537 mechanism; once stored, version information in the study cannot be changed.
539 \return string containing component's version, e.g. "1.0"
545 \brief Base interface of the %component that supports exporting data.
547 interface ImportableComponent
549 /*! \brief Get a list of supported formats */
550 SALOME::StringSeq GetImportableFormats();
551 boolean ImportDataAs(in string format, in SALOME::GenericObj exporter);
554 //! A block of binary data used for file transfer. The maximum size of the block is defined on server side.
555 typedef sequence<octet> fileBlock;
557 /*! \brief Interface of fileTransfer.
558 The fileTransfer and fileRef interfaces provide a file transfer service
559 between different computers.
561 interface fileTransfer : SALOME::GenericObj
563 //! Open the file transfer
565 open method returns a key (fileId) that identifies the structure
566 (ex: C FILE), associated to the original file on the server.
567 The structure is created by a container for transfer of files availables
568 on the computer which runs the container.
569 Each open gives a unique fileId, to allow concurrent reads of the same
572 long open(in string fileName);
573 //! Open the file transfer in write mode for file fileName
575 \param fileName the file to copy into with putBlock
576 \return the id to use with putBlock
578 long openW(in string fileName);
580 //! Close the file transfer
582 when the file transfer is finished, close method releases structures
583 created by open method, identified by fileId.
585 void close(in long fileId);
587 //! Get a file data block
589 Get successive blocks of octets from the original file.
590 The last block is empty, and identifies the end of file.
592 fileBlock getBlock(in long fileId);
594 //! Put a file data block
596 \param fileId identification of the file obtained by openW
597 \param block a data block to copy into the file identified by fileId
599 void putBlock(in long fileId, in fileBlock block);
603 //! A file managed by a Salome_file.
610 string source_file_name;
611 //! status ("present" or "notpresent")
614 Engines::Container container;
617 //! A sequence of Engines::file.
618 typedef sequence<Engines::file> files;
621 //! The state of a Salome_file.
625 //! hdf5 file where the file can be saved
626 string hdf5_file_name;
627 //! number of files managed
628 long number_of_files;
629 //! information if all the files are received
634 /*! \brief Interface of a Salome_file managed
635 This file is independent of a Salome module. It can managed one or more
636 real files. It's useful for parallel files. Currently Salome_file cannot manage
637 two files that have the same name but not the same path.
639 interface Salome_file : Engines::fileTransfer
641 //! Load a Salome_file from a hdf5 file.
644 \param hdf5_file name (with path) of the hdf5_file.
646 \exception contains information of errors if the loading doesn't succeed.
648 void load(in string hdf5_file) raises (SALOME::SALOME_Exception);
650 //! Save a Salome_file into a hdf5_file.
653 \param hdf5_file name (with path) of the hdf5_file.
655 \exception contains information of errors if the save doesn't succeed.
658 void save(in string hdf5_file) raises (SALOME::SALOME_Exception);
660 //! Save a Salome_file into a hdf5_file.
662 All files that are managed are saved into the hdf5_file
664 \param hdf5_file name (with path) of the hdf5_file.
666 \exception contains information of errors if the save doesn't succeed.
669 void save_all(in string hdf5_file) raises (SALOME::SALOME_Exception);
673 //! Add a Local file to the Salome_file.
676 \param file_name name of the file with the path.
678 \exception raised if the file is already added into the Salome_file.
680 void setLocalFile(in string comp_file_name) raises (SALOME::SALOME_Exception);
682 //! Add a Distributed file to the Salome_file.
685 \param comp_file_name name of the file with the path.
687 \exception raised if the file is already added into the Salome_file.
689 void setDistributedFile(in string comp_file_name) raises (SALOME::SALOME_Exception);
691 //! Connect a Salome_file with another Salome_file.
693 It works only if the Salome_file managed only one file
695 \param source_Salome_file Salome_file that managed the distributed version of the file.
697 \exception raised if there is more or less than one file.
699 void connect(in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception);
701 //! Connect the managed file file_name to a Salome_file.
704 \param file_name name of the file without the path.
705 \param source_Salome_file Salome_file that managed the distributed version of the file.
707 \exception raised if the file doesn't exist.
709 void connectDistributedFile(in string file_name,
710 in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception);
712 //! Connect the file_name with a Distributed file_name.
715 \param file_name name of the file without the path.
716 \param source_file_name It's the name of the file managed by the distributed source Salome_file.
718 \exception raised if the file doesn't exist.
720 void setDistributedSourceFile(in string file_name,
721 in string source_file_name) raises (SALOME::SALOME_Exception);
725 //! Get all the distributed files managed by the Salome_file and check all the local files.
728 \exception raised if some of the files are not ok.
730 void recvFiles() raises (SALOME::SALOME_Exception) ;
734 //! Remove a file of the Salome_file.
737 \param file_name name of the file.
739 \exception raised if the file doesn't exist.
741 void removeFile(in string file_name) raises (SALOME::SALOME_Exception);
743 //! Remove all the files of the Salome_file.
748 //! Get the list of the files managed by the Salome_file.
750 The list can be empty.
752 Engines::files getFilesInfos();
754 //! Get a file managed by the Salome_file.
757 \param file_name the name of the file.
759 \return CORBA file reference.
761 \exception raised if the file doesn't exist.
763 Engines::file getFileInfos(in string file_name) raises (SALOME::SALOME_Exception);
765 //! Return the state of the Salome_file.
766 Engines::SfState getSalome_fileState();
769 //! Set the container where files are.
772 \param container container CORBA's reference.
774 void setContainer(in Engines::Container container);
777 /*! \brief Interface of fileRef.
778 The fileTransfer and fileRef interfaces provide a file transfer service
779 between different computers.
781 A fileRef object is associated to an original file (origFileName) on a
782 machine (refMachine).
783 It is created by a container (factoryServer) on refMachine,
784 with createFileRef(in string origFileName) method.
785 The fileRef object maintains a list of (machine,filename) for copies.
786 If a copy exists on myMachine, getRef(myMachine) returns the file name
787 of the copy on myMachine, else returns empty string.
788 If there is no copy on myMachine, method getFileTransfer() from container
789 factoryServer on refMachine provides a fileTransfer object dedicated to
791 After the copy, addRef(myMachine, localFileNameOnMyMachine) registers
792 the file name of the copy on myMachine.
796 //! the original file
797 readonly attribute string origFileName;
798 //! the machine of the original file
799 readonly attribute string refMachine;
801 Container getContainer();
803 boolean addRef(in string machine,
806 string getRef(in string machine);