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
  11 //***//#include "VISU_Gen.idl"
  12 /*! \defgroup Kernel SALOME KERNEL module
  13 */
  14
  15 /*!  \ingroup Kernel
  16
  17   This package contains interfaces used for management of the session in %SALOME application.
  18 */
  19 module SALOME
  20 {
  21 /*! \brief State of the session
  22
  23    This enumeration contains values defining the state of the session
  24
  25 */
  26   enum SessionState {asleep, running} ;
  27
  28 /*! \brief %Session State and Statistics
  29
  30
  31     This struct contains a field list with general information about the session
  32 */
  33
  34   struct StatSession
  35   {
  36 /*! \brief State of the session
  37
  38    It can be:
  39    *     -# asleep  : no running study
  40    *     -# running : one or more running studies
  41 */
  42     SessionState state ;
  43 /*! Number of running studies
  44 */
  45     short        runningStudies ;
  46 /*! It is True if GUI is active in the session
  47 */
  48     boolean      activeGUI ;
  49   } ;
  50 /*! \brief Interface of the session
  51
  52     The %session Server launches and stops GUI (Graphical User Interface).
  53     The %session can be active without GUI (It can contain one or more running studies)
  54 */
  55
  56   interface Session
  57   {
  58 /*!
  59    This exception is raised when trying to stop the %session with active GUI
  60 */
  61     exception GUIActive {} ;
  62 /*!
  63    This exception is raised when trying to stop the %session with a number of running studies.
  64 */
  65     exception RunningStudies {} ;
  66
  67 /*!
  68    Launches GUI in the session
  69 */
  70     void GetInterface();
  71     //***//    VISU::VISU_Gen GetVisuGen();
  72
  73 /*!
  74   Stops the %Session (It must be idle)
  75 */
  76     void StopSession() raises(GUIActive, RunningStudies) ;
  77
  78 /*!
  79   Gets Session State
  80 */
  81     StatSession GetStatSession() ;
  82 /*!
  83     Determines whether the server has already been loaded or not.
  84 */
  85     void ping();
  86   } ;
  87
  88 } ;