From fa09c0b2d0cf5edee22882cfe17df589a0bc4729 Mon Sep 17 00:00:00 2001 From: prascle Date: Wed, 24 May 2006 18:00:57 +0000 Subject: [PATCH] PR: doc improvement (in progress) --- doc/KERNEL_Services.txt | 67 +++++++++++++++---- idl/SALOME_Component.idl | 43 +++++++++--- .../SALOME_FileTransferCORBA.cxx | 12 ++-- 3 files changed, 92 insertions(+), 30 deletions(-) diff --git a/doc/KERNEL_Services.txt b/doc/KERNEL_Services.txt index 3a7b1cfe2..801b5a008 100644 --- a/doc/KERNEL_Services.txt +++ b/doc/KERNEL_Services.txt @@ -34,14 +34,24 @@ General purpose services 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 @@ -50,23 +60,34 @@ IDL Interfaces ============== +-----------------------------+-----------------------------------------------+ -| 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_ | | @@ -75,9 +96,17 @@ IDL Interfaces +-----------------------------+-----------------------------------------------+ | SALOME_Session_ | | +-----------------------------+-----------------------------------------------+ -| SALOME_MPIContainer_ | | + ++-----------------------------+-----------------------------------------------+ +| | other CORBA modules | ++=============================+===============================================+ +| SALOME_ModuleCatalog_ | | +-----------------------------+-----------------------------------------------+ -| SALOME_MPIObject_ | | +| SALOME_RessourcesCatalog_ | | ++-----------------------------+-----------------------------------------------+ +| SALOME_Registry_ | | ++-----------------------------+-----------------------------------------------+ +| Logger_ | | +-----------------------------+-----------------------------------------------+ **Other idl for test purposes** @@ -87,9 +116,19 @@ SALOME_TestModuleCatalog.idl 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 diff --git a/idl/SALOME_Component.idl b/idl/SALOME_Component.idl index 7e0ad5c80..8c02d5c56 100644 --- a/idl/SALOME_Component.idl +++ b/idl/SALOME_Component.idl @@ -26,7 +26,7 @@ #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. @@ -54,7 +54,7 @@ module Engines 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 */ @@ -170,7 +170,7 @@ module Engines - /*! \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. */ @@ -279,27 +279,50 @@ module Engines } ; + /*! + A block of binary data used for file transfer. The maximum size of the + block is defined on server side. + */ typedef sequence 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 @@ -307,7 +330,7 @@ module Engines CORBA file copy. After the copy, addRef(myMachine, localFileNameOnMyMachine) registers the file name of the copy on myMachine. - */ + */ interface fileRef { readonly attribute string origFileName; diff --git a/src/LifeCycleCORBA/SALOME_FileTransferCORBA.cxx b/src/LifeCycleCORBA/SALOME_FileTransferCORBA.cxx index 4b005a5bc..d43645926 100644 --- a/src/LifeCycleCORBA/SALOME_FileTransferCORBA.cxx +++ b/src/LifeCycleCORBA/SALOME_FileTransferCORBA.cxx @@ -32,7 +32,7 @@ using namespace std; //============================================================================= /*! - * Default constructor, not for use + * Default constructor, not for use. */ //============================================================================= @@ -43,7 +43,7 @@ SALOME_FileTransferCORBA::SALOME_FileTransferCORBA() //============================================================================= /*! - * 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 */ //============================================================================= @@ -57,8 +57,8 @@ SALOME_FileTransferCORBA::SALOME_FileTransferCORBA(Engines::fileRef_ptr //============================================================================= /*! - * 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 @@ -93,8 +93,8 @@ SALOME_FileTransferCORBA::~SALOME_FileTransferCORBA() //============================================================================= /*! - * 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 */ -- 2.39.2