Salome HOME
Adding Datastream and DSC_User, not compile for now
[modules/kernel.git] / doc / KERNEL_Services.txt
index 2db19fcab42b479f41792cc81aef784106436da8..b348fcad3c5037eace6a4b8971a7e7e20d659e6f 100644 (file)
@@ -6,7 +6,7 @@ KERNEL Services for end user (Python interface)
 
   rst2html < doc.txt > doc.html
 
-This document corresponds to SALOME2 3.2.0 (beta version)
+This document corresponds to SALOME2 3.2.0
 
 .. contents::
 .. sectnum::
@@ -36,7 +36,7 @@ SALOME services access from a Python shell
 See SALOME_Application_ for detailed instructions to launch a Python
 interpreter with full acces to the SALOME environment and services.
 
-.. _SALOME_Application: ./SALOME_Application.txt
+.. _SALOME_Application: ./SALOME_Application.html
 
 You can use the embedded Python interpreter in Grahic User Interface, or an
 external interpreter, with::
@@ -160,13 +160,30 @@ SWIG is very similar).
 
 .. _FileTransferCORBA: ./tui/KERNEL/classSALOME__FileTransferCORBA.html
 
+The following example shows how to transfer a file from a remote host to the
+client computer. Remote hostname is 'cli76cc', we would like to copy
+'tkcvs_8_0_3.tar.gz' from remote to local computer. A full pathname is
+required. A container is created on remote computer if it does not exist,
+to handle the file transfer::
+
+   import salome
+   salome.salome_init()
+
+   import LifeCycleCORBA
+   remotefile="/home/prascle/tkcvs_8_0_3.tar.gz"
+   aFileTransfer=LifeCycleCORBA.SALOME_FileTransferCORBA('cli76cc',remotefile)
+   localFile=aFileTransfer.getLocalFile()
+
+
 CORBA Naming service access
 ---------------------------
 
-See SALOME_NamingService_ for the C++ interface (Python interface obtained with
-SWIG is very similar).
+See SALOME_NamingService_ for the C++ interface. The Python interface
+SALOME_NamingServicePy_ is not yet derived from the C++ interface and offers
+only the most useful functions.
 
 .. _SALOME_NamingService: ./tui/KERNEL/classSALOME__NamingService.html
+.. _SALOME_NamingServicePy: ./tui/KERNEL/classSALOME__NamingServicePy_1_1SALOME__NamingServicePy__i.html
 
 Batch services
 --------------
@@ -178,10 +195,11 @@ See Batch_ documentation (in french only).
 All IDL Interfaces
 ==================
 
+Containers and component life cycle, File transfer service
+----------------------------------------------------------
+
 +-----------------------------+-----------------------------------------------+
 | Engines_                    | Engines CORBA module.                         |
-|                             | Containers and component life cycle,          |
-|                             | File transfer service                         |
 +=============================+===============================================+
 | Component_                  | Generic component interface.                  |
 |                             | All SALOME components inherit this interface  |
@@ -204,6 +222,9 @@ All IDL Interfaces
 | MPIObject_                  |                                               |
 +-----------------------------+-----------------------------------------------+
 
+Study management
+----------------
+
 +-----------------------------+-----------------------------------------------+
 | SALOMEDS_                   | SALOMEDS CORBA module                         |
 +=============================+===============================================+
@@ -212,18 +233,23 @@ All IDL Interfaces
 | SALOMEDS_Attributes_        |                                               |
 +-----------------------------+-----------------------------------------------+
 
+High speed transfer, object life cycle, exceptions, GUI interface...
+--------------------------------------------------------------------
+
 +-----------------------------+-----------------------------------------------+
 | SALOME_                     | SALOME CORBA module                           |
 +=============================+===============================================+
 | SALOME_Comm_                |                                               |
 +-----------------------------+-----------------------------------------------+
-|SALOME_GenericObj_           |                                               |
+| SALOME_GenericObj_          |                                               |
 +-----------------------------+-----------------------------------------------+
-|SALOME_Exception_            |                                               |
+| SALOME_Exception_           |                                               |
 +-----------------------------+-----------------------------------------------+
 | SALOME_Session_             |                                               |
 +-----------------------------+-----------------------------------------------+
 
+Miscelleanous
+-------------
 +-----------------------------+-----------------------------------------------+
 |                             | other CORBA modules                           |
 +=============================+===============================================+