1 // Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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, or (at your option) any later version.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : SALOME_Session.idl
23 // Author : Paul RASCLE, EDF
25 #include "SALOME_Component.idl"
26 #include "SALOME_GenericObj.idl"
28 /*! \file SALOME_Session.idl \brief file that contains interface of the session
33 /*! \brief State of the session
35 This enumeration contains values defining the state of the session
38 enum SessionState {asleep, /*!< Session is inactive */
39 running, /*!< Session is running */
40 shutdown /*!< Session is shutting down */
43 /*! \brief %Session State and Statistics
45 This struct contains a field list with general information about the session
50 /*! \brief State of the session
53 -# asleep : no running study
54 -# running : one or more running studies
57 //! Number of running studies
58 short runningStudies ;
59 //! It is True if GUI is active in the session
63 /*! \brief Interface of the session
65 The %session Server launches and stops GUI (Graphical User Interface).
66 The %session can be active without GUI (It can contain one or more running studies)
71 //! This exception is raised when trying to stop the %session with active GUI
72 exception GUIActive {} ;
73 //! This exception is raised when trying to stop the %session with a number of running studies.
74 exception RunningStudies {} ;
76 //! Launches GUI in the session
79 //! Returns a standalone component
80 Engines::EngineComponent GetComponent(in string theLibraryName);
82 //! Stops the %Session (It must be idle)
83 void StopSession() raises(GUIActive, RunningStudies) ;
85 //! Gets Session State
86 StatSession GetStatSession() ;
88 //! Shutdowns Session server
91 //! Determines whether the server has already been loaded or not.
93 //! Returns the PID of the server
97 //! Get Active study ID
98 long GetActiveStudyId();
99 //! Restores a state of the study at theSavePoint
100 boolean restoreVisualState(in long theSavePoint);
102 //! Get list of selected entities
103 StringSeq getSelection();
105 //! Send a message to the session GUI desktop that will emit a qt signal
107 This method can be used to send a message to the GUI from the standalone
109 Caution: this method can block the Session and the calling container
110 if it is called when container processes some request from the GUI
111 (mutual lock takes place).
112 In such a case it is recommended to use oneway method.
114 void emitMessage(in string theMessage);
116 //! same as emitMessage but in a non blocking way
118 Emit a qt signal from the session GUI desktop window.
119 This method can be used to send a message to the GUI from the standalone
121 This method never blocks the Session and the calling container.
123 oneway void emitMessageOneWay(in string theMessage);