SALOME documentation central

idl/SALOME_Session.idl

Go to the documentation of this file.
00001 //  Copyright (C) 2007-2008  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 //  $Header$
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 ; 
00058     short        runningStudies ;
00060     boolean      activeGUI ;
00061   } ;
00062 
00069   interface Session
00070   {
00072     exception GUIActive {} ;
00074     exception RunningStudies {} ;  
00075 
00077     void GetInterface(); 
00078 
00080     Engines::Component GetComponent(in string theLibraryName);
00081 
00083     void StopSession() raises(GUIActive, RunningStudies) ;
00084 
00086     StatSession GetStatSession() ;
00087 
00089     void ping();
00091     long getPID();
00093     long GetActiveStudyId();
00095     boolean restoreVisualState(in long theSavePoint);
00096 
00098 
00106     void emitMessage(in string theMessage);
00107 
00109 
00115     oneway void emitMessageOneWay(in string theMessage);
00116   } ;
00117 } ;