doc/KERNEL_Services.txt

   1 =================================================================
   2 KERNEL Services for end user (Python interface)
   3 =================================================================
   4
   5 *html version of this document is produced with docutils*::
   6
   7   rst2html < doc.txt > doc.html
   8
   9 This document corresponds to SALOME2 3.2.0 (beta version)
  10
  11 .. contents::
  12 .. sectnum::
  13
  14 +-------------------------------------------+
  15 | **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
  16 +-------------------------------------------+
  17
  18 -------------------------------------------------------------------------------
  19
  20 In a SALOME application, distributed components, servers and clients use
  21 the CORBA middleware for comunication. CORBA interfaces are defined via idl
  22 files. All the different CORBA interfaces are available for users in Python,
  23 see CORBA interfaces below.
  24
  25 For some general purpose services, CORBA interfaces have been encapsulated
  26 in order to provide a simple interface (encapsulation is generally done in
  27 C++ classes, and a Python SWIG interface is also generated from C++, to
  28 ensure a consistent behavior between C++ modules and Python modules or user
  29 script).
  30
  31 General purpose services
  32 ========================
  33
  34 Container and component instanciation
  35 -------------------------------------
  36
  37 See LifeCycleCORBA_ for the C++ interface (Python interface obtained with SWIG
  38 is very similar).
  39
  40 .. _LifeCycleCORBA: ./tui/KERNEL/classSALOME__LifeCycleCORBA.html
  41
  42 File transfer service
  43 ---------------------
  44
  45 See FileTransferCORBA_ for the C++ interface (Python interface obtained with
  46 SWIG is very similar).
  47
  48 .. _FileTransferCORBA: ./tui/KERNEL/classSALOME__FileTransferCORBA.html
  49
  50 CORBA Naming service access
  51 ---------------------------
  52
  53 See SALOME_NamingService_ for the C++ interface (Python interface obtained with
  54 SWIG is very similar).
  55
  56 .. _SALOME_NamingService: ./tui/KERNEL/classSALOME__NamingService.html
  57
  58
  59 IDL Interfaces
  60 ==============
  61
  62 +-----------------------------+-----------------------------------------------+
  63 | Engines_                    | Engines CORBA module                          |
  64 +=============================+===============================================+
  65 | Component_                  | Generic component interface                   |
  66 +-----------------------------+-----------------------------------------------+
  67 | Container_                  | Container interface                           |
  68 +-----------------------------+-----------------------------------------------+
  69 | FileTransfer_               |                                               |
  70 +-----------------------------+-----------------------------------------------+
  71 | FileRef_                    |                                               |
  72 +-----------------------------+-----------------------------------------------+
  73 | ContainerManager_           |                                               |
  74 +-----------------------------+-----------------------------------------------+
  75 | MPIContainer_               |                                               |
  76 +-----------------------------+-----------------------------------------------+
  77 | MPIObject_                  |                                               |
  78 +-----------------------------+-----------------------------------------------+
  79
  80 +-----------------------------+-----------------------------------------------+
  81 | SALOMEDS_                   | SALOMEDS CORBA module                         |
  82 +=============================+===============================================+
  83 | SALOMEDSidl_                |                                               |
  84 +-----------------------------+-----------------------------------------------+
  85 | SALOMEDS_Attributes_        |                                               |
  86 +-----------------------------+-----------------------------------------------+
  87
  88 +-----------------------------+-----------------------------------------------+
  89 | SALOME_                     | SALOME CORBA module                           |
  90 +=============================+===============================================+
  91 | SALOME_Comm_                |                                               |
  92 +-----------------------------+-----------------------------------------------+
  93 |SALOME_GenericObj_           |                                               |
  94 +-----------------------------+-----------------------------------------------+
  95 |SALOME_Exception_            |                                               |
  96 +-----------------------------+-----------------------------------------------+
  97 | SALOME_Session_             |                                               |
  98 +-----------------------------+-----------------------------------------------+
  99
 100 +-----------------------------+-----------------------------------------------+
 101 |                             | other CORBA modules                           |
 102 +=============================+===============================================+
 103 | SALOME_ModuleCatalog_       |                                               |
 104 +-----------------------------+-----------------------------------------------+
 105 | SALOME_RessourcesCatalog_   |                                               |
 106 +-----------------------------+-----------------------------------------------+
 107 | SALOME_Registry_            |                                               |
 108 +-----------------------------+-----------------------------------------------+
 109 | Logger_                     |                                               |
 110 +-----------------------------+-----------------------------------------------+
 111
 112 **Other idl for test purposes**
 113 nstest.idl
 114 SALOME_TestComponent.idl
 115 SALOME_TestModuleCatalog.idl
 116 SALOME_TestMPIComponent.idl
 117 TestNotif.idl
 118
 119 .. _Engines:           ./tui/KERNEL/namespaceEngines.html
 120 .. _Component:         ./tui/KERNEL/interfaceEngines_1_1Component.html
 121 .. _Container:         ./tui/KERNEL/interfaceEngines_1_1Container.html
 122 .. _fileTransfer:      ./tui/KERNEL/interfaceEngines_1_1fileTransfer.html
 123 .. _fileRef:           ./tui/KERNEL/interfaceEngines_1_1fileRef.html
 124 .. _ContainerManager:  ./tui/KERNEL/interfaceEngines_1_1ContainerManager.html
 125 .. _MPIContainer:      ./tui/KERNEL/interfaceEngines_1_1MPIContainer.html
 126 .. _MPIObject:         ./tui/KERNEL/interfaceEngines_1_1MPIObject.html
 127 .. _SALOME:                   ./tui/KERNEL/namespaceSALOME.html
 128 .. _SALOMEDS:                 ./tui/KERNEL/namespaceSALOMEDS.html
 129 .. _SALOME_Component:         ./tui/KERNEL/SALOME__Component_8idl.html
 130 .. _SALOME_ContainerManager:  ./tui/KERNEL/SALOME__ContainerManager_8idl.html
 131 .. _SALOMEDSidl:              ./tui/KERNEL/SALOMEDS_8idl.html
 132 .. _SALOMEDS_Attributes:      ./tui/KERNEL/SALOMEDS__Attributes_8idl.html
 133 .. _SALOME_ModuleCatalog:     ./tui/KERNEL/SALOME__ModuleCatalog_8idl.html
 134 .. _SALOME_RessourcesCatalog: ./tui/KERNEL/SALOME__RessourcesCatalog_8idl.html
 135 .. _SALOME_Registry:          ./tui/KERNEL/SALOME__Registry_8idl.html
 136 .. _Logger:                   ./tui/KERNEL/Logger_8idl.html
 137 .. _SALOME_Comm:              ./tui/KERNEL/SALOME__Comm_8idl.html
 138 .. _SALOME_GenericObj:        ./tui/KERNEL/SALOME__GenericObj_8idl.html
 139 .. _SALOME_Exception:         ./tui/KERNEL/SALOME__Exception_8idl.html
 140 .. _SALOME_Session:           ./tui/KERNEL/SALOME__Session_8idl.html
 141 .. _SALOME_MPIContainer:      ./tui/KERNEL/SALOME__MPIContainer_8idl.html
 142 .. _SALOME_MPIObject:         ./tui/KERNEL/SALOME__MPIObject_8idl.html
 143
 144
 145 -------------------------------------------------------------------------------
 146
 147 +----------------------------------+------------------------------------------+
 148 | `General KERNEL documentation`_  | `End User KERNEL Doxygen documentation`_ |
 149 +----------------------------------+------------------------------------------+
 150
 151 .. _`General KERNEL documentation`:           ./index.html
 152 .. _`End User KERNEL Doxygen documentation`:  ./tui/KERNEL/index.html