Container and component instanciation
-------------------------------------
-See LifeCycleCORBA_
+See LifeCycleCORBA_ for the C++ interface (Python interface obtained with SWIG
+is very similar).
.. _LifeCycleCORBA: ./tui/KERNEL/classSALOME__LifeCycleCORBA.html
+File transfer service
+---------------------
+
+See FileTransferCORBA_ for the C++ interface (Python interface obtained with
+SWIG is very similar).
+
+.. _FileTransferCORBA: ./tui/KERNEL/classSALOME__FileTransferCORBA.html
+
CORBA Naming service access
---------------------------
-See SALOME_NamingService_
+See SALOME_NamingService_ for the C++ interface (Python interface obtained with
+SWIG is very similar).
.. _SALOME_NamingService: ./tui/KERNEL/classSALOME__NamingService.html
==============
+-----------------------------+-----------------------------------------------+
-| SALOME_Component_ | Container and Generic component interface, |
-| | File transfer service |
+| Engines_ | Engines CORBA module |
++=============================+===============================================+
+| Component_ | Generic component interface |
+-----------------------------+-----------------------------------------------+
-| SALOME_ContainerManager_ | |
+| Container_ | Container interface |
+-----------------------------+-----------------------------------------------+
-| SALOMEDS_ | |
+| FileTransfer_ | |
+-----------------------------+-----------------------------------------------+
-| SALOMEDS_Attributes_ | |
+| FileRef_ | |
+-----------------------------+-----------------------------------------------+
-| SALOME_ModuleCatalog_ | |
+| ContainerManager_ | |
+-----------------------------+-----------------------------------------------+
-| SALOME_RessourcesCatalog_ | |
+| MPIContainer_ | |
+-----------------------------+-----------------------------------------------+
-| SALOME_Registry_ | |
+| MPIObject_ | |
+-----------------------------+-----------------------------------------------+
-| Logger_ | |
+
++-----------------------------+-----------------------------------------------+
+| SALOMEDS_ | SALOMEDS CORBA module |
++=============================+===============================================+
+| SALOMEDSidl_ | |
++-----------------------------+-----------------------------------------------+
+| SALOMEDS_Attributes_ | |
++-----------------------------+-----------------------------------------------+
+
+-----------------------------+-----------------------------------------------+
+| SALOME_ | SALOME CORBA module |
++=============================+===============================================+
| SALOME_Comm_ | |
+-----------------------------+-----------------------------------------------+
|SALOME_GenericObj_ | |
+-----------------------------+-----------------------------------------------+
| SALOME_Session_ | |
+-----------------------------+-----------------------------------------------+
-| SALOME_MPIContainer_ | |
+
++-----------------------------+-----------------------------------------------+
+| | other CORBA modules |
++=============================+===============================================+
+| SALOME_ModuleCatalog_ | |
+-----------------------------+-----------------------------------------------+
-| SALOME_MPIObject_ | |
+| SALOME_RessourcesCatalog_ | |
++-----------------------------+-----------------------------------------------+
+| SALOME_Registry_ | |
++-----------------------------+-----------------------------------------------+
+| Logger_ | |
+-----------------------------+-----------------------------------------------+
**Other idl for test purposes**
SALOME_TestMPIComponent.idl
TestNotif.idl
+.. _Engines: ./tui/KERNEL/namespaceEngines.html
+.. _Component: ./tui/KERNEL/interfaceEngines_1_1Component.html
+.. _Container: ./tui/KERNEL/interfaceEngines_1_1Container.html
+.. _fileTransfer: ./tui/KERNEL/interfaceEngines_1_1fileTransfer.html
+.. _fileRef: ./tui/KERNEL/interfaceEngines_1_1fileRef.html
+.. _ContainerManager: ./tui/KERNEL/interfaceEngines_1_1ContainerManager.html
+.. _MPIContainer: ./tui/KERNEL/interfaceEngines_1_1MPIContainer.html
+.. _MPIObject: ./tui/KERNEL/interfaceEngines_1_1MPIObject.html
+.. _SALOME: ./tui/KERNEL/namespaceSALOME.html
+.. _SALOMEDS: ./tui/KERNEL/namespaceSALOMEDS.html
.. _SALOME_Component: ./tui/KERNEL/SALOME__Component_8idl.html
.. _SALOME_ContainerManager: ./tui/KERNEL/SALOME__ContainerManager_8idl.html
-.. _SALOMEDS: ./tui/KERNEL/SALOMEDS_8idl.html
+.. _SALOMEDSidl: ./tui/KERNEL/SALOMEDS_8idl.html
.. _SALOMEDS_Attributes: ./tui/KERNEL/SALOMEDS__Attributes_8idl.html
.. _SALOME_ModuleCatalog: ./tui/KERNEL/SALOME__ModuleCatalog_8idl.html
.. _SALOME_RessourcesCatalog: ./tui/KERNEL/SALOME__RessourcesCatalog_8idl.html
#ifndef _SALOME_COMPONENT_IDL_
#define _SALOME_COMPONENT_IDL_
-/*!
+/*! \brief
This is a package of interfaces used for connecting new components to %SALOME
application. It also contains a set of interfaces used for management of %MED
component in %SALOME application.
interface fileRef ;
interface fileTransfer ;
- /*! \brief Interface of the %Container
+ /*! \brief Interface of the %Container.
This interface defines the process of loading and registration
of new components in %SALOME application
*/
- /*! \brief Interface of the %component
+ /*! \brief Interface of the %component.
This interface is used for interaction between the %container and the
%component and between the components inside the container.
*/
} ;
+ /*!
+ A block of binary data used for file transfer. The maximum size of the
+ block is defined on server side.
+ */
typedef sequence<octet> fileBlock;
- /*!
- file transfer object. open method returns a key (fileId) that identifies
- the structure (ex: C FILE) on the server, created for transfer.
- */
+ /*! \brief Interface of fileTransfer.
+ The fileTransfer and fileRef interfaces provide a file transfer service
+ between different computers.
+ */
interface fileTransfer
{
+ /*!
+ open method returns a key (fileId) that identifies the structure
+ (ex: C FILE), associated to the original file on the server.
+ The structure is created by a container for transfer of files availables
+ on the computer which runs the container.
+ Each open gives a unique fileId, to allow concurrent reads of the same
+ File.
+ */
long open(in string fileName);
+ /*!
+ when the file transfer is finished, close method releases structures
+ created by open method, identified by fileId.
+ */
void close(in long fileId);
+ /*!
+ Get successive blocks of octets from the original file.
+ The last block is empty, and identifies the end of file.
+ */
fileBlock getBlock(in long fileId);
};
- /*!
+ /*! \brief Interface of fileTransfer.
+ The fileTransfer and fileRef interfaces provide a file transfer service
+ between different computers.
+
A fileRef object is associated to an original file (origFileName) on a
machine (refMachine).
It is created by a container (factoryServer) on refMachine,
with createFileRef(in string origFileName) method.
- fileRef object maintains a list of (machine,filename) for copies.
+ The fileRef object maintains a list of (machine,filename) for copies.
If a copy exists on myMachine, getRef(myMachine) returns the file name
of the copy on myMachine, else returns empy string.
If there is no copy on myMachine, method getFileTransfer() from container
CORBA file copy.
After the copy, addRef(myMachine, localFileNameOnMyMachine) registers
the file name of the copy on myMachine.
- */
+ */
interface fileRef
{
readonly attribute string origFileName;
//=============================================================================
/*!
- * Default constructor, not for use
+ * Default constructor, not for use.
*/
//=============================================================================
//=============================================================================
/*!
- * Constructor to use when we get a fileRef CORBA object from a component
+ * Constructor to use when we get a fileRef CORBA object from a component.
* \param aFileRef file reference CORBA object
*/
//=============================================================================
//=============================================================================
/*!
- * Constructor to use we the file name and machine from which to copy, plus
- * an optional Container name on the machine
+ * Constructor to use when we have the file name and machine from which to
+ * copy, plus an optional Container name on the machine.
* \param refMachine the machine on which is the file to transfer
* \param origFileName abolute file path on refMachine
* \param containerName default container name used (FactoryServer) if empty
//=============================================================================
/*!
- * CORBA method: get a local copy of the reference file
- * \param localFile optional absolute path to store the copt
+ * CORBA method: get a local copy of the reference file.
+ * \param localFile optional absolute path to store the copy
* \return the file name (absolute path) of the copy, may be different from
* localFile parameter if the copy was already done before the call
*/
