1 // Copyright (C) 2007-2016 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
22 // File : SALOME_Component.idl
23 // Author : Paul RASCLE, EDF
25 #ifndef _SALOME_COMPONENT_IDL_
26 #define _SALOME_COMPONENT_IDL_
28 #include "SALOME_GenericObj.idl"
29 #include "SALOMEDS.idl"
30 #include "SALOME_Exception.idl"
31 #include "SALOME_PyNode.idl"
33 /*! \file SALOME_Component.idl \brief interfaces for EngineComponent and Container
37 This is a package of interfaces used for connecting new components to %SALOME
38 application. It also contains a set of interfaces used for management of %MED
39 component in %SALOME application.
44 A byte stream which is used for binary data transfer between different
47 typedef sequence<octet> TMPFile;
49 //! General Key Value Structure to set or get properties, for component
56 //! Structure data type to hold reference on data
62 typedef sequence<KeyValuePair> FieldsDict;
64 interface EngineComponent ;
66 interface fileTransfer ;
67 interface Salome_file;
69 /*! \brief Interface of the %Container.
70 This interface defines the process of loading and registration
71 of new components in %SALOME application
77 /*! \brief Loads a new component class (dynamic library).
79 \param componentName like COMPONENT, (Python or C++ implementation)
80 try to make a Python import of COMPONENT,
81 then a lib open of libCOMPONENTEngine.so
82 \param reason in case of error (return false) a string explaining the error
83 \return true if load successful or already done, false otherwise
85 boolean load_component_Library(in string componentName, out string reason);
87 //! Create a new servant instance of a component.
89 Component library must be loaded.
90 \param componentName Name of the component which will be registered
91 in Registry and Name Service,
92 (instance number suffix added to the registered name)
93 \return a loaded component
95 Engines::EngineComponent create_component_instance(in string componentName);
97 //! Create a new Python servant instance of a generic service.
99 This simply loads the service in the current container by importing the
100 corresponding Python module.
101 Warning: no internal registration is done, so it is up to the caller to
102 manage the various instantiation.
103 \param serviceName Name of the service
104 \param reason in case of error (return void string) a string explaining the error
105 \return the IOR of the loaded service.
107 string create_python_service_instance(in string serviceName,
110 //! Create a new servant instance of a component with environment variables specified.
112 Component library must be loaded.
113 \param componentName Name of the component which will be registered
114 in Registry and Name Service,
115 (instance number suffix added to the registered name)
116 \param env a dict of env variables
117 \param reason in case of error (return nil) a string explaining the error
118 \return a loaded component
120 Engines::EngineComponent create_component_instance_env(in string componentName,
123 //! Find a servant instance of a component
125 \param registeredName Name of the component in Registry or Name Service,
126 without instance suffix number
127 \return the first instance found
129 EngineComponent find_component_instance(in string registeredName);
131 //! Find a servant instance of a component, or create a new one.
133 Loads the component library if needed.
134 Only applicable to multiStudy components.
135 \param nameToRegister Name of the component which will be registered
136 in Registry (or Name Service)
137 \param componentName Name of the constructed library of the %component
138 (not used any more, give empty string)
139 \return a loaded component
141 EngineComponent load_impl(in string nameToRegister,
142 in string componentName);
144 //! Remove the component servant, and deletes all related objects
146 \param component_i Component to be removed
148 void remove_impl(in EngineComponent component_i);
150 //! Unload component libraries from the container.
151 void finalize_removal() ;
153 //! Determines whether the server has been loaded or not.
156 //! Name of the %container
157 readonly attribute string name ;
159 //! working directory of the %container
160 readonly attribute string workingdir ;
162 //! name of the %container log file (this has been set by the launcher)
163 attribute string logfilename ;
165 //! Shutdown the Container process.
168 //! Returns the hostname of the container
169 string getHostName();
171 //! Returns the PID of the container
174 //! Kill the container
176 Returns True if the %container has been killed.
177 Kept for Superv compilation but can't work, unless oneway...
180 boolean Kill_impl() ;
184 returns a fileRef object if origFileName exists and is readable
185 else returns null object. Only one fileRef is created for a given
186 file name, so, several calls with the same file name returns the
189 fileRef createFileRef(in string origFileName);
191 //! Create a Salome_file
193 returns a Salome_file object if origFileName exists and is readable
194 else returns null object.
196 \param origFileName name of the file to be managed (can contain the path).
198 \return Salome_file CORBA reference.
200 Salome_file createSalome_file(in string origFileName);
202 //! Create a fileTransfer
204 returns a fileTransfer object used to copy files from the container
205 machine to the clients machines. Only one fileTransfer instance is
206 created in a container.
208 fileTransfer getFileTransfer();
210 //! Copy a file from a remote host (container) to a local file
212 \param contai the remote container
213 \param remoteFile the file on the remote host to copy
214 \param localFile the local file to create by copy
216 void copyFile(in Container contai, in string remoteFile, in string localFile);
218 //! Create a PyNode in the container
220 \param nodeName the name of the PyNode
221 \param code python code as text to load in the node
223 PyNode createPyNode(in string nodeName, in string code) raises(SALOME::SALOME_Exception);
225 //! Retrieves the last created PyNode instance with createPyNode.
226 PyNode getDefaultPyNode(in string nodeName);
228 //! Create a PyScriptNode in the container
230 \param nodeName the name of the PyScriptNode
231 \param code python code as text to load in the node
233 PyScriptNode createPyScriptNode(in string nodeName, in string code) raises(SALOME::SALOME_Exception);
235 //! Retrieves the last created PyScriptNode instance with createPyScriptNode.
236 PyScriptNode getDefaultPyScriptNode(in string nodeName);
239 /*! \brief Interface of the %component.
240 This interface is used for interaction between the %container and the
241 %component and between the components inside the container.
243 interface EngineComponent
245 //! The name of the instance of the %Component
246 readonly attribute string instanceName ;
248 //! The name of the interface of the %Component
249 readonly attribute string interfaceName ;
251 //! Determines whether the server has already been loaded or not.
254 //! Remove component instance from container
256 Deactivates the %Component.
257 -- TO BE USED BY CONTAINER ONLY (Container housekeeping) --
258 use remove_impl from Container instead !
262 //! Returns the container that the %Component refers to.
263 Container GetContainerRef() ;
265 //! Set component instance properties
267 Gives a sequence of (key=string,value=any) to the component.
268 Base class component stores the sequence in a map.
269 The map is cleared before.
270 This map is for use by derived classes.
272 void setProperties(in FieldsDict dico);
274 //! Get component instance properties
276 returns a previously stored map (key=string,value=any) as a sequence.
277 See setProperties(in FieldsDict dico).
279 FieldsDict getProperties();
281 //! Set an option value
283 This method is to set an option specific to a certain EngineComponent.
285 void SetOption(in string optionName, in string value);
287 //! Return an option value
289 This method is to get value of an option specific to a certain EngineComponent.
291 string GetOption(in string optionName);
293 //! Set name of a node in a graph (for %SUPERVISOR use)
295 This method is used by the %SUPERVISOR component. It sets the names of
296 the graph and of the node.
297 \param aGraphName Name of graph
298 \param aNodeName Name of node
300 void Names( in string aGraphName , in string aNodeName ) ;
302 //! Kill the component (if you can)
304 Returns True if the %Component has been killed.
306 boolean Kill_impl() ;
308 //! Stop the component (if you can)
310 Returns True if the activity of the %Component has been stopped.
311 (It's action can't be resumed)
313 boolean Stop_impl() ;
315 //! Suspend the component
317 Returns True if the activity of the %Component has been suspended.
318 (It's action can be resumed)
320 boolean Suspend_impl() ;
322 //! Resume the component
324 Returns True if the activity of the %Component has been resumed.
326 boolean Resume_impl() ;
332 long CpuUsed_impl() ;
334 //! Get a python dump
336 Returns a python script, which is being played back reproduces
337 the data model of component
339 TMPFile DumpPython(in boolean isPublished,
340 in boolean isMultiFile,
341 out boolean isValidScript);
344 //! Returns a CORBA Ref of a input Salome_file managed by a service.
347 \param service_name service's name.
348 \param file_name name of the requested file.
350 \return CORBA Ref of the requested file.
352 \exception contains information of what if the component cannot
353 sends the file's reference.
355 Engines::Salome_file getInputFileToService(in string service_name,
356 in string Salome_file_name) raises(SALOME::SALOME_Exception);
358 //! Check service input files (transfer them if needed)
360 This method is used before the activation of the service. It calls
361 recvFiles() on all the input Salome_file files of the service.
363 Before each recvFiles(), it uses the callback method named configureSalome_file.
364 This method allows the user to configure the files managed by the Salome_file.
366 By default, there is no files managed when a Salome_file is created,
367 but the supervisor set some files managed by the Salome_file from the information contained
368 into the schema file.
370 \param service_name service's name.
372 \exception contains information about files that are not in a good state.
374 void checkInputFilesToService(in string service_name) raises(SALOME::SALOME_Exception);
376 //! This method adds a input Salome_file to a service of the component.
379 \param service_name service's name.
380 \param Salome_file_name name of the Salome_file
382 \return a reference of the Salome_file
384 \exception raises an exception if there is already
385 a Salome_file with this name for the service.
387 Engines::Salome_file setInputFileToService(in string service_name,
388 in string Salome_file_name) raises(SALOME::SALOME_Exception);
390 //! Returns a CORBA Ref of a output Salome_file managed by a service.
393 \param service_name service's name.
394 \param file_name name of the requested file.
396 \return CORBA Ref of the requested file.
398 \exception contains information of what if the component cannot
399 sends the file's reference.
401 Engines::Salome_file getOutputFileToService(in string service_name,
402 in string Salome_file_name) raises(SALOME::SALOME_Exception);
404 //! Check service output files (transfer them if needed)
406 This method is used at the end of the service. It calls
407 recvFiles() on all the output Salome_file files of the service.
409 Before each recvFiles(), it uses the callback method named configureSalome_file.
410 This method allows the user to configure the files managed by the Salome_file.
412 By default, there is no files managed when a Salome_file is created,
413 but the supervisor set some files managed by the Salome_file from the information contained
414 into the schema file.
416 \param service_name service's name.
418 \exception contains information about files that are not in a good state.
420 void checkOutputFilesToService(in string service_name) raises(SALOME::SALOME_Exception);
422 //! This method adds an output Salome_file to a service of the component.
425 \param service_name service's name.
426 \param Salome_file_name name of the Salome_file
428 \return a reference of the Salome_file
430 \exception raises an exception if there is already
431 a Salome_file with this name for the service.
433 Engines::Salome_file setOutputFileToService(in string service_name,
434 in string Salome_file_name) raises(SALOME::SALOME_Exception);
436 //! Indicate if the component instance provides custom information about its objects.
438 Returns true if the component provides custom information about its objects, false otherwise.
439 Should be redefined in the certain component to return true in case of this
440 component provides such information.
442 boolean hasObjectInfo();
444 //! Get custom information about the given object.
446 This method is used to get the custom information about the given object.
447 Should be redefined in the certain component in case of this
448 component provides such information.
449 It is worth using this method only if hasObjectInfo() method returns true.
451 \param entry object's entry.
453 \return an information about the given object.
455 string getObjectInfo(in string entry);
457 //! Get version of the component
459 This method is supposed to be implemented in all derived classes; default implementation
460 returns "unknown" string that means that no version information about the component is available.
461 \note The version of the component is stored to the study, as a part of general persistence
462 mechanism; once stored, version information in the study cannot be changed.
464 \return string containing component's version, e.g. "1.0"
470 \brief Base interface of the %component that supports exporting data.
472 interface ImportableComponent
474 /*! \brief Get a list of supported formats */
475 SALOME::StringSeq GetImportableFormats();
476 boolean ImportDataAs(in string format, in SALOME::GenericObj exporter);
479 //! A block of binary data used for file transfer. The maximum size of the block is defined on server side.
480 typedef sequence<octet> fileBlock;
482 /*! \brief Interface of fileTransfer.
483 The fileTransfer and fileRef interfaces provide a file transfer service
484 between different computers.
486 interface fileTransfer : SALOME::GenericObj
488 //! Open the file transfer
490 open method returns a key (fileId) that identifies the structure
491 (ex: C FILE), associated to the original file on the server.
492 The structure is created by a container for transfer of files availables
493 on the computer which runs the container.
494 Each open gives a unique fileId, to allow concurrent reads of the same
497 long open(in string fileName);
498 //! Open the file transfer in write mode for file fileName
500 \param fileName the file to copy into with putBlock
501 \return the id to use with putBlock
503 long openW(in string fileName);
505 //! Close the file transfer
507 when the file transfer is finished, close method releases structures
508 created by open method, identified by fileId.
510 void close(in long fileId);
512 //! Get a file data block
514 Get successive blocks of octets from the original file.
515 The last block is empty, and identifies the end of file.
517 fileBlock getBlock(in long fileId);
519 //! Put a file data block
521 \param fileId identification of the file obtained by openW
522 \param block a data block to copy into the file identified by fileId
524 void putBlock(in long fileId, in fileBlock block);
528 //! A file managed by a Salome_file.
535 string source_file_name;
536 //! status ("present" or "notpresent")
539 Engines::Container container;
542 //! A sequence of Engines::file.
543 typedef sequence<Engines::file> files;
546 //! The state of a Salome_file.
550 //! hdf5 file where the file can be saved
551 string hdf5_file_name;
552 //! number of files managed
553 long number_of_files;
554 //! information if all the files are received
559 /*! \brief Interface of a Salome_file managed
560 This file is independent of a Salome module. It can managed one or more
561 real files. It's useful for parallel files. Currently Salome_file cannot manage
562 two files that have the same name but not the same path.
564 interface Salome_file : Engines::fileTransfer
566 //! Load a Salome_file from a hdf5 file.
569 \param hdf5_file name (with path) of the hdf5_file.
571 \exception contains information of errors if the loading doesn't succeed.
573 void load(in string hdf5_file) raises (SALOME::SALOME_Exception);
575 //! Save a Salome_file into a hdf5_file.
578 \param hdf5_file name (with path) of the hdf5_file.
580 \exception contains information of errors if the save doesn't succeed.
583 void save(in string hdf5_file) raises (SALOME::SALOME_Exception);
585 //! Save a Salome_file into a hdf5_file.
587 All files that are managed are saved into the hdf5_file
589 \param hdf5_file name (with path) of the hdf5_file.
591 \exception contains information of errors if the save doesn't succeed.
594 void save_all(in string hdf5_file) raises (SALOME::SALOME_Exception);
598 //! Add a Local file to the Salome_file.
601 \param file_name name of the file with the path.
603 \exception raised if the file is already added into the Salome_file.
605 void setLocalFile(in string comp_file_name) raises (SALOME::SALOME_Exception);
607 //! Add a Distributed file to the Salome_file.
610 \param comp_file_name name of the file with the path.
612 \exception raised if the file is already added into the Salome_file.
614 void setDistributedFile(in string comp_file_name) raises (SALOME::SALOME_Exception);
616 //! Connect a Salome_file with another Salome_file.
618 It works only if the Salome_file managed only one file
620 \param source_Salome_file Salome_file that managed the distributed version of the file.
622 \exception raised if there is more or less than one file.
624 void connect(in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception);
626 //! Connect the managed file file_name to a Salome_file.
629 \param file_name name of the file without the path.
630 \param source_Salome_file Salome_file that managed the distributed version of the file.
632 \exception raised if the file doesn't exist.
634 void connectDistributedFile(in string file_name,
635 in Engines::Salome_file source_Salome_file) raises (SALOME::SALOME_Exception);
637 //! Connect the file_name with a Distributed file_name.
640 \param file_name name of the file without the path.
641 \param source_file_name It's the name of the file managed by the distributed source Salome_file.
643 \exception raised if the file doesn't exist.
645 void setDistributedSourceFile(in string file_name,
646 in string source_file_name) raises (SALOME::SALOME_Exception);
650 //! Get all the distributed files managed by the Salome_file and check all the local files.
653 \exception raised if some of the files are not ok.
655 void recvFiles() raises (SALOME::SALOME_Exception) ;
659 //! Remove a file of the Salome_file.
662 \param file_name name of the file.
664 \exception raised if the file doesn't exist.
666 void removeFile(in string file_name) raises (SALOME::SALOME_Exception);
668 //! Remove all the files of the Salome_file.
673 //! Get the list of the files managed by the Salome_file.
675 The list can be empty.
677 Engines::files getFilesInfos();
679 //! Get a file managed by the Salome_file.
682 \param file_name the name of the file.
684 \return CORBA file reference.
686 \exception raised if the file doesn't exist.
688 Engines::file getFileInfos(in string file_name) raises (SALOME::SALOME_Exception);
690 //! Return the state of the Salome_file.
691 Engines::SfState getSalome_fileState();
694 //! Set the container where files are.
697 \param container container CORBA's reference.
699 void setContainer(in Engines::Container container);
702 /*! \brief Interface of fileRef.
703 The fileTransfer and fileRef interfaces provide a file transfer service
704 between different computers.
706 A fileRef object is associated to an original file (origFileName) on a
707 machine (refMachine).
708 It is created by a container (factoryServer) on refMachine,
709 with createFileRef(in string origFileName) method.
710 The fileRef object maintains a list of (machine,filename) for copies.
711 If a copy exists on myMachine, getRef(myMachine) returns the file name
712 of the copy on myMachine, else returns empty string.
713 If there is no copy on myMachine, method getFileTransfer() from container
714 factoryServer on refMachine provides a fileTransfer object dedicated to
716 After the copy, addRef(myMachine, localFileNameOnMyMachine) registers
717 the file name of the copy on myMachine.
721 //! the original file
722 readonly attribute string origFileName;
723 //! the machine of the original file
724 readonly attribute string refMachine;
726 Container getContainer();
728 boolean addRef(in string machine,
731 string getRef(in string machine);