General KERNEL Documentation     End User KERNEL Services  


idl/SALOME_Session.idl

Go to the documentation of this file.
00001 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
00002 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
00003 // 
00004 //  This library is free software; you can redistribute it and/or 
00005 //  modify it under the terms of the GNU Lesser General Public 
00006 //  License as published by the Free Software Foundation; either 
00007 //  version 2.1 of the License. 
00008 // 
00009 //  This library is distributed in the hope that it will be useful, 
00010 //  but WITHOUT ANY WARRANTY; without even the implied warranty of 
00011 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
00012 //  Lesser General Public License for more details. 
00013 // 
00014 //  You should have received a copy of the GNU Lesser General Public 
00015 //  License along with this library; if not, write to the Free Software 
00016 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
00017 // 
00018 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
00019 //
00020 //
00021 //
00022 //  File   : SALOME_Session.idl
00023 //  Author : Paul RASCLE, EDF
00024 //  $Header: /home/server/cvs/KERNEL/KERNEL_SRC/idl/SALOME_Session.idl,v 1.11 2006/06/01 11:15:15 jfa Exp $
00025 
00026 #include "SALOME_Component.idl"
00027 
00031 module SALOME
00032 {
00038   enum SessionState {asleep, 
00039                running 
00040   } ;
00041 
00048   struct StatSession
00049   {
00056     SessionState state ; 
00059     short        runningStudies ;
00062     boolean      activeGUI ;
00063   } ;
00070   interface Session
00071   {
00075     exception GUIActive {} ;
00079     exception RunningStudies {} ;  
00080 
00084     void GetInterface(); 
00085 
00089     Engines::Component GetComponent(in string theLibraryName);
00090 
00094     void StopSession() raises(GUIActive, RunningStudies) ;
00095 
00099     StatSession GetStatSession() ;
00103     void ping();
00107     long GetActiveStudyId();
00111     boolean restoreVisualState(in long theSavePoint);
00112   } ;
00113 } ;