Back to index

salome-kernel  6.5.0
SALOME_Session.idl
Go to the documentation of this file.
00001 // Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
00002 //
00003 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
00004 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
00005 //
00006 // This library is free software; you can redistribute it and/or
00007 // modify it under the terms of the GNU Lesser General Public
00008 // License as published by the Free Software Foundation; either
00009 // version 2.1 of the License.
00010 //
00011 // This library is distributed in the hope that it will be useful,
00012 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014 // Lesser General Public License for more details.
00015 //
00016 // You should have received a copy of the GNU Lesser General Public
00017 // License along with this library; if not, write to the Free Software
00018 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
00019 //
00020 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
00021 //
00022 //  File   : SALOME_Session.idl
00023 //  Author : Paul RASCLE, EDF
00024 
00025 #include "SALOME_Component.idl"
00026 
00030 module SALOME
00031 {
00037   enum SessionState {asleep,   
00038                      running,  
00039                      shutdown  
00040   } ;
00041 
00047   struct StatSession
00048   {
00055     SessionState state ;
00057     short        runningStudies ;
00059     boolean      activeGUI ;
00060   } ;
00061 
00068   interface Session
00069   {
00071     exception GUIActive {} ;
00073     exception RunningStudies {} ;
00074 
00076     void GetInterface();
00077 
00079     Engines::EngineComponent GetComponent(in string theLibraryName);
00080 
00082     void StopSession() raises(GUIActive, RunningStudies) ;
00083 
00085     StatSession GetStatSession() ;
00086 
00088     void Shutdown();
00089 
00091     void ping();
00093     long getPID();
00095     string getHostname();
00097     long GetActiveStudyId();
00099     boolean restoreVisualState(in long theSavePoint);
00100 
00102 
00110     void emitMessage(in string theMessage);
00111 
00113 
00119     oneway void emitMessageOneWay(in string theMessage);
00120   } ;
00121 } ;