idl/SALOME_Session.idl

   1 //=============================================================================
   2 // File      : SALOME_Session.idl
   3 // Created   : mar jun 19 09:15:07 CEST 2001
   4 // Author    : Paul RASCLE, EDF
   5 // Project   : SALOME
   6 // Copyright : EDF 2001
   7 // $Header$
   8 //=============================================================================
   9
  10 //! module SALOME regroups all idl definitions for SALOME Kernel
  11 #include "VISU_Gen.idl"
  12 module SALOME
  13 {
  14   enum SessionState {asleep, running } ;
  15
  16   //! Session State and Statistics
  17   /*!
  18    *  Field list
  19    *   - state
  20    *     -# asleep  : no running study
  21    *     -# running : one or more running studies
  22    *   - number of running studies
  23    *   - active GUI : true/false
  24    */
  25
  26   struct StatSession
  27   {
  28     SessionState state ;
  29     short        runningStudies ;
  30     boolean      activeGUI ;
  31   } ;
  32
  33   /*!
  34    * Session Server launches and stops GUI (Graphical User Interface)
  35    * Session can be active without GUI (one or more running studies)
  36    */
  37
  38   interface Session
  39   {
  40     exception GUIActive {} ;
  41     exception RunningStudies {} ;
  42
  43     //! Launches GUI
  44     oneway void GetInterface() ;
  45     VISU::VISU_Gen GetVisuGen();
  46
  47     //! Stops Session (must be idle)
  48     void StopSession() raises(GUIActive, RunningStudies) ;
  49
  50     //! Gets Session State
  51     StatSession GetStatSession() ;
  52
  53     void ping();
  54   } ;
  55
  56 } ;