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 set_startup_code(in string codeAtStartUp);
97 string get_startup_code();
99 void addLogFileNameGroup(in vectorOfString groupOfLogFileNames);
101 vectorOfVectorOfString getAllLogFileNameGroups();
103 void execute_python_code( in string code ) raises(SALOME::SALOME_Exception);
105 /*! \brief Loads a new component class (dynamic library).
107 \param componentName like COMPONENT, (Python or C++ implementation)
108 try to make a Python import of COMPONENT,
109 then a lib open of libCOMPONENTEngine.so
110 \param reason in case of error (return false) a string explaining the error
111 \return true if load successful or already done, false otherwise
113 boolean load_component_Library(in string componentName, out string reason);
115 //! Create a new servant instance of a component.
117 Component library must be loaded.
118 \param componentName Name of the component which will be registered
119 in Registry and Name Service,
120 (instance number suffix added to the registered name)
121 \return a loaded component
123 Engines::EngineComponent create_component_instance(in string componentName);
125 //! Create a new Python servant instance of a generic service.
127 This simply loads the service in the current container by importing the
128 corresponding Python module.
129 Warning: no internal registration is done, so it is up to the caller to
130 manage the various instantiation.
131 \param serviceName Name of the service
132 \param reason in case of error (return void string) a string explaining the error
133 \return the IOR of the loaded service.
135 string create_python_service_instance(in string serviceName,
138 //! Create a new servant instance of a component with environment variables specified.
140 Component library must be loaded.
141 \param componentName Name of the component which will be registered
142 in Registry and Name Service,
143 (instance number suffix added to the registered name)
144 \param env a dict of env variables
145 \param reason in case of error (return nil) a string explaining the error
146 \return a loaded component
148 Engines::EngineComponent create_component_instance_env(in string componentName,
151 //! Find a servant instance of a component
153 \param registeredName Name of the component in Registry or Name Service,
154 without instance suffix number
155 \return the first instance found
157 EngineComponent find_component_instance(in string registeredName);
159 //! Find a servant instance of a component, or create a new one.
161 Loads the component library if needed.
162 Only applicable to multiStudy components.
163 \param nameToRegister Name of the component which will be registered
164 in Registry (or Name Service)
165 \param componentName Name of the constructed library of the %component
166 (not used any more, give empty string)
167 \return a loaded component
169 EngineComponent load_impl(in string nameToRegister,
170 in string componentName);
172 //! Remove the component servant, and deletes all related objects
174 \param component_i Component to be removed
176 void remove_impl(in EngineComponent component_i);
178 //! In case of SSL mode Returns entry to Embedded NS
179 EmbeddedNamingService get_embedded_NS_if_ssl();
181 boolean is_SSL_mode();
183 //! Unload component libraries from the container.
184 void finalize_removal() ;
186 //! Determines whether the server has been loaded or not.
189 //! Name of the %container
190 readonly attribute string name ;
192 //! working directory of the %container
193 readonly attribute string workingdir ;
195 //! name of the %container log file (this has been set by the launcher)
196 attribute string logfilename ;
198 //! name of the %container log file
199 attribute string locallogfilename ;
201 //! interval of time between two measures of CPU/time process container
202 attribute long monitoringtimeresms;
204 void verbosity(out boolean activated, out string level);
206 void setVerbosity(in boolean activated, in string level);
208 //! Shutdown the Container process. Shutdown is not immediate. It waits for all remaining invokation completion.
211 //! Shutdown the Container process. Shutdown is immediate for this method.
214 //! Returns the hostname of the container
215 string getHostName();
217 //! Returns the PID of the container
220 //! Kill the container
222 Returns True if the %container has been killed.
223 Kept for Superv compilation but can't work, unless oneway...
226 boolean Kill_impl() ;
230 returns a fileRef object if origFileName exists and is readable
231 else returns null object. Only one fileRef is created for a given
232 file name, so, several calls with the same file name returns the
235 fileRef createFileRef(in string origFileName);
237 //! Create a Salome_file
239 returns a Salome_file object if origFileName exists and is readable
240 else returns null object.
242 \param origFileName name of the file to be managed (can contain the path).
244 \return Salome_file CORBA reference.
246 Salome_file createSalome_file(in string origFileName);
248 //! Create a fileTransfer
250 returns a fileTransfer object used to copy files from the container
251 machine to the clients machines. Only one fileTransfer instance is
252 created in a container.
254 fileTransfer getFileTransfer();
256 //! Copy a file from a remote host (container) to a local file
258 \param contai the remote container
259 \param remoteFile the file on the remote host to copy
260 \param localFile the local file to create by copy
262 void copyFile(in Container contai, in string remoteFile, in string localFile);
264 //! Create a PyNode in the container
266 \param nodeName the name of the PyNode
267 \param code python code as text to load in the node
269 PyNode createPyNode(in string nodeName, in string code) raises(SALOME::SALOME_Exception);
271 //! Retrieves the last created PyNode instance with createPyNode.
272 PyNode getDefaultPyNode(in string nodeName);
274 //! Create a PyScriptNode in the container
276 \param nodeName the name of the PyScriptNode
277 \param code python code as text to load in the node
279 PyScriptNode createPyScriptNode(in string nodeName, in string code) raises(SALOME::SALOME_Exception);
281 void removePyScriptNode(in string nodeName) raises(SALOME::SALOME_Exception);
283 //! Retrieves the last created PyScriptNode instance with createPyScriptNode.
284 PyScriptNode getDefaultPyScriptNode(in string nodeName);
286 //! This method remove all refs of PyScriptNode servant objects stored in server.
288 * 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.
290 void cleanAllPyScripts();
292 //! Return number of CPU cores in the calculation node.
293 long getNumberOfCPUCores();
295 //! Return a load of each CPU core.
296 vectorOfDouble loadOfCPUCores() raises(SALOME::SALOME_Exception);
298 //! Set custom script to calculate a load of each CPU core.
300 \param script Python script to execute
302 void setPyScriptForCPULoad(in string script);
304 //! Nullify custom script to calculate each CPU core's load.
305 void resetScriptForCPULoad();
307 //! Get total physical memory of calculation node, in megabytes.
308 long getTotalPhysicalMemory();
310 //! Get used physical memory of calculation node, in megabytes.
311 long getTotalPhysicalMemoryInUse();
313 //! Obtain physical memory, used by the current process, in megabytes.
314 long getTotalPhysicalMemoryInUseByMe();
317 /*! \brief Interface of the %component.
318 This interface is used for interaction between the %container and the
319 %component and between the components inside the container.
321 interface EngineComponent
323 //! The name of the instance of the %Component
324 readonly attribute string instanceName ;
326 //! The name of the interface of the %Component
327 readonly attribute string interfaceName ;
329 //! Determines whether the server has already been loaded or not.
332 boolean isSSLMode() raises(SALOME::SALOME_Exception);
333 //! Remove component instance from container
335 Deactivates the %Component.
336 -- TO BE USED BY CONTAINER ONLY (Container housekeeping) --
337 use remove_impl from Container instead !
341 //! Returns the container that the %Component refers to.
342 Container GetContainerRef() ;
344 //! Set component instance properties
346 Gives a sequence of (key=string,value=any) to the component.
347 Base class component stores the sequence in a map.
348 The map is cleared before.
349 This map is for use by derived classes.
351 void setProperties(in FieldsDict dico);
353 //! Get component instance properties
355 returns a previously stored map (key=string,value=any) as a sequence.
356 See setProperties(in FieldsDict dico).
358 FieldsDict getProperties();
360 //! Set an option value
362 This method is to set an option specific to a certain EngineComponent.
364 void SetOption(in string optionName, in string value);
366 //! Return an option value
368 This method is to get value of an option specific to a certain EngineComponent.
370 string GetOption(in string optionName);
372 //! Set name of a node in a graph (for %SUPERVISOR use)
374 This method is used by the %SUPERVISOR component. It sets the names of
375 the graph and of the node.
376 \param aGraphName Name of graph
377 \param aNodeName Name of node
379 void Names( in string aGraphName , in string aNodeName ) ;
381 //! Kill the component (if you can)
383 Returns True if the %Component has been killed.
385 boolean Kill_impl() ;
387 //! Stop the component (if you can)
389 Returns True if the activity of the %Component has been stopped.
390 (It's action can't be resumed)
392 boolean Stop_impl() ;
394 //! Suspend the component
396 Returns True if the activity of the %Component has been suspended.
397 (It's action can be resumed)
399 boolean Suspend_impl() ;
401 //! Resume the component
403 Returns True if the activity of the %Component has been resumed.
405 boolean Resume_impl() ;
411 long CpuUsed_impl() ;
413 //! Get a python dump
415 Returns a python script, which is being played back reproduces
416 the data model of component
418 TMPFile DumpPython(in boolean isPublished,
419 in boolean isMultiFile,
420 out boolean isValidScript);
423 //! Returns a CORBA Ref of a input Salome_file managed by a service.
426 \param service_name service's name.
427 \param file_name name of the requested file.
429 \return CORBA Ref of the requested file.
431 \exception contains information of what if the component cannot
432 sends the file's reference.
434 Engines::Salome_file getInputFileToService(in string service_name,
435 in string Salome_file_name) raises(SALOME::SALOME_Exception);
437 //! Check service input files (transfer them if needed)
439 This method is used before the activation of the service. It calls
440 recvFiles() on all the input Salome_file files of the service.
442 Before each recvFiles(), it uses the callback method named configureSalome_file.
443 This method allows the user to configure the files managed by the Salome_file.
445 By default, there is no files managed when a Salome_file is created,
446 but the supervisor set some files managed by the Salome_file from the information contained
447 into the schema file.
449 \param service_name service's name.
451 \exception contains information about files that are not in a good state.
453 void checkInputFilesToService(in string service_name) raises(SALOME::SALOME_Exception);
455 //! This method adds a input Salome_file to a service of the component.
458 \param service_name service's name.
459 \param Salome_file_name name of the Salome_file
461 \return a reference of the Salome_file
463 \exception raises an exception if there is already
464 a Salome_file with this name for the service.
466 Engines::Salome_file setInputFileToService(in string service_name,
467 in string Salome_file_name) raises(SALOME::SALOME_Exception);
469 //! Returns a CORBA Ref of a output Salome_file managed by a service.
472 \param service_name service's name.
473 \param file_name name of the requested file.
475 \return CORBA Ref of the requested file.
477 \exception contains information of what if the component cannot
478 sends the file's reference.
480 Engines::Salome_file getOutputFileToService(in string service_name,
481 in string Salome_file_name) raises(SALOME::SALOME_Exception);
483 //! Check service output files (transfer them if needed)
485 This method is used at the end of the service. It calls
486 recvFiles() on all the output Salome_file files of the service.
488 Before each recvFiles(), it uses the callback method named configureSalome_file.
489 This method allows the user to configure the files managed by the Salome_file.
491 By default, there is no files managed when a Salome_file is created,
492 but the supervisor set some files managed by the Salome_file from the information contained
493 into the schema file.
495 \param service_name service's name.
497 \exception contains information about files that are not in a good state.
499 void checkOutputFilesToService(in string service_name) raises(SALOME::SALOME_Exception);
501 //! This method adds an output Salome_file to a service of the component.
504 \param service_name service's name.
505 \param Salome_file_name name of the Salome_file
507 \return a reference of the Salome_file
509 \exception raises an exception if there is already
510 a Salome_file with this name for the service.
512 Engines::Salome_file setOutputFileToService(in string service_name,
513 in string Salome_file_name) raises(SALOME::SALOME_Exception);
515 //! Indicate if the component instance provides custom information about its objects.
517 Returns true if the component provides custom information about its objects, false otherwise.
518 Should be redefined in the certain component to return true in case of this
519 component provides such information.
521 boolean hasObjectInfo();
523 //! Get custom information about the given object.
525 This method is used to get the custom information about the given object.
526 Should be redefined in the certain component in case of this
527 component provides such information.
528 It is worth using this method only if hasObjectInfo() method returns true.
530 \param entry object's entry.
532 \return an information about the given object.
534 string getObjectInfo(in string entry);
536 //! Get version of the component
538 This method is supposed to be implemented in all derived classes; default implementation
539 returns "unknown" string that means that no version information about the component is available.
540 \note The version of the component is stored to the study, as a part of general persistence
541 mechanism; once stored, version information in the study cannot be changed.
543 \return string containing component's version, e.g. "1.0"
549 \brief Base interface of the %component that supports exporting data.
551 interface ImportableComponent
553 /*! \brief Get a list of supported formats */
554 SALOME::StringSeq GetImportableFormats();
555 boolean ImportDataAs(in string format, in SALOME::GenericObj exporter);
558 //! A block of binary data used for file transfer. The maximum size of the block is defined on server side.
559 typedef sequence<octet> fileBlock;
561 /*! \brief Interface of fileTransfer.
562 The fileTransfer and fileRef interfaces provide a file transfer service
563 between different computers.
565 interface fileTransfer : SALOME::GenericObj
567 //! Open the file transfer
569 open method returns a key (fileId) that identifies the structure
570 (ex: C FILE), associated to the original file on the server.
571 The structure is created by a container for transfer of files availables
572 on the computer which runs the container.
573 Each open gives a unique fileId, to allow concurrent reads of the same
576 long open(in string fileName);
577 //! Open the file transfer in write mode for file fileName
579 \param fileName the file to copy into with putBlock
580 \return the id to use with putBlock
582 long openW(in string fileName);
584 //! Close the file transfer
586 when the file transfer is finished, close method releases structures
587 created by open method, identified by fileId.
589 void close(in long fileId);
591 //! Get a file data block
593 Get successive blocks of octets from the original file.
594 The last block is empty, and identifies the end of file.
596 fileBlock getBlock(in long fileId);
598 //! Put a file data block
600 \param fileId identification of the file obtained by openW
601 \param block a data block to copy into the file identified by fileId
603 void putBlock(in long fileId, in fileBlock block);
607 //! A file managed by a Salome_file.
614 string source_file_name;
615 //! status ("present" or "notpresent")
618 Engines::Container container;
621 //! A sequence of Engines::file.
622 typedef sequence<Engines::file> files;
625 //! The state of a Salome_file.
629 //! hdf5 file where the file can be saved
630 string hdf5_file_name;
631 //! number of files managed
632 long number_of_files;
633 //! information if all the files are received
638 /*! \brief Interface of a Salome_file managed
639 This file is independent of a Salome module. It can managed one or more
640 real files. It's useful for parallel files. Currently Salome_file cannot manage
641 two files that have the same name but not the same path.
643 interface Salome_file : Engines::fileTransfer
645 //! Load a Salome_file from a hdf5 file.
648 \param hdf5_file name (with path) of the hdf5_file.
650 \exception contains information of errors if the loading doesn't succeed.
652 void load(in string hdf5_file) raises (SALOME::SALOME_Exception);
654 //! Save a Salome_file into a hdf5_file.
657 \param hdf5_file name (with path) of the hdf5_file.
659 \exception contains information of errors if the save doesn't succeed.
662 void save(in string hdf5_file) raises (SALOME::SALOME_Exception);
664 //! Save a Salome_file into a hdf5_file.
666 All files that are managed are saved into the hdf5_file
668 \param hdf5_file name (with path) of the hdf5_file.
670 \exception contains information of errors if the save doesn't succeed.
673 void save_all(in string hdf5_file) raises (SALOME::SALOME_Exception);
677 //! Add a Local file to the Salome_file.
680 \param file_name name of the file with the path.
682 \exception raised if the file is already added into the Salome_file.
684 void setLocalFile(in string comp_file_name) raises (SALOME::SALOME_Exception);
686 //! Add a Distributed file to the Salome_file.
689 \param comp_file_name name of the file with the path.
691 \exception raised if the file is already added into the Salome_file.
693 void setDistributedFile(in string comp_file_name) raises (SALOME::SALOME_Exception);
695 //! Connect a Salome_file with another Salome_file.
697 It works only if the Salome_file managed only one file
699 \param source_Salome_file Salome_file that managed the distributed version of the file.
701 \exception raised if there is more or less than one file.
703 void connect(in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception);
705 //! Connect the managed file file_name to a Salome_file.
708 \param file_name name of the file without the path.
709 \param source_Salome_file Salome_file that managed the distributed version of the file.
711 \exception raised if the file doesn't exist.
713 void connectDistributedFile(in string file_name,
714 in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception);
716 //! Connect the file_name with a Distributed file_name.
719 \param file_name name of the file without the path.
720 \param source_file_name It's the name of the file managed by the distributed source Salome_file.
722 \exception raised if the file doesn't exist.
724 void setDistributedSourceFile(in string file_name,
725 in string source_file_name) raises (SALOME::SALOME_Exception);
729 //! Get all the distributed files managed by the Salome_file and check all the local files.
732 \exception raised if some of the files are not ok.
734 void recvFiles() raises (SALOME::SALOME_Exception) ;
738 //! Remove a file of the Salome_file.
741 \param file_name name of the file.
743 \exception raised if the file doesn't exist.
745 void removeFile(in string file_name) raises (SALOME::SALOME_Exception);
747 //! Remove all the files of the Salome_file.
752 //! Get the list of the files managed by the Salome_file.
754 The list can be empty.
756 Engines::files getFilesInfos();
758 //! Get a file managed by the Salome_file.
761 \param file_name the name of the file.
763 \return CORBA file reference.
765 \exception raised if the file doesn't exist.
767 Engines::file getFileInfos(in string file_name) raises (SALOME::SALOME_Exception);
769 //! Return the state of the Salome_file.
770 Engines::SfState getSalome_fileState();
773 //! Set the container where files are.
776 \param container container CORBA's reference.
778 void setContainer(in Engines::Container container);
781 /*! \brief Interface of fileRef.
782 The fileTransfer and fileRef interfaces provide a file transfer service
783 between different computers.
785 A fileRef object is associated to an original file (origFileName) on a
786 machine (refMachine).
787 It is created by a container (factoryServer) on refMachine,
788 with createFileRef(in string origFileName) method.
789 The fileRef object maintains a list of (machine,filename) for copies.
790 If a copy exists on myMachine, getRef(myMachine) returns the file name
791 of the copy on myMachine, else returns empty string.
792 If there is no copy on myMachine, method getFileTransfer() from container
793 factoryServer on refMachine provides a fileTransfer object dedicated to
795 After the copy, addRef(myMachine, localFileNameOnMyMachine) registers
796 the file name of the copy on myMachine.
800 //! the original file
801 readonly attribute string origFileName;
802 //! the machine of the original file
803 readonly attribute string refMachine;
805 Container getContainer();
807 boolean addRef(in string machine,
810 string getRef(in string machine);