Version: 6.5.0
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
SALOME_Session.idl
Go to the documentation of this file.
1 // Copyright (C) 2007-2012 CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22 // File : SALOME_Session.idl
23 // Author : Paul RASCLE, EDF
24 
25 #include "SALOME_Component.idl"
26 
30 module SALOME
31 {
40  } ;
41 
47  struct StatSession
48  {
59  boolean activeGUI ;
60  } ;
61 
68  interface Session
69  {
71  exception GUIActive {} ;
73  exception RunningStudies {} ;
74 
76  void GetInterface();
77 
79  Engines::EngineComponent GetComponent(in string theLibraryName);
80 
82  void StopSession() raises(GUIActive, RunningStudies) ;
83 
85  StatSession GetStatSession() ;
86 
88  void Shutdown();
89 
91  void ping();
93  long getPID();
95  string getHostname();
97  long GetActiveStudyId();
99  boolean restoreVisualState(in long theSavePoint);
100 
102 
110  void emitMessage(in string theMessage);
111 
113 
119  oneway void emitMessageOneWay(in string theMessage);
120  } ;
121 } ;
Interface of the component. This interface is used for interaction between the container and the comp...
Definition: SALOME_Component.idl:232
Definition: SALOME_Session.idl:39
boolean activeGUI
It is True if GUI is active in the session.
Definition: SALOME_Session.idl:59
interfaces for EngineComponent and Container
SessionState
State of the session.
Definition: SALOME_Session.idl:37
Interface of the session.
Definition: SALOME_Session.idl:68
short runningStudies
Number of running studies.
Definition: SALOME_Session.idl:57
Module SALOME contains all base interfaces of SALOME Kernel.
Definition: SALOME_Comm.idl:33
Session State and Statistics
Definition: SALOME_Session.idl:47
SessionState state
State of the session.
Definition: SALOME_Session.idl:55
Definition: SALOME_Session.idl:38
This exception is raised when trying to stop the session with active GUI.
Definition: SALOME_Session.idl:71
This exception is raised when trying to stop the session with a number of running studies...
Definition: SALOME_Session.idl:73
Definition: SALOME_Session.idl:37
Copyright © 2007-2012 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS