Interface of the session. More...
import "SALOME_Session.idl";
Data Structures | |
| exception | GUIActive |
| This exception is raised when trying to stop the session with active GUI. More... | |
| exception | RunningStudies |
| This exception is raised when trying to stop the session with a number of running studies. More... | |
Public Member Functions | |
| void | GetInterface () |
| Launches GUI in the session. More... | |
| Engines::EngineComponent | GetComponent (in string theLibraryName) |
| Returns a standalone component. More... | |
| void | StopSession () raises (GUIActive, RunningStudies) |
| Stops the Session (It must be idle) More... | |
| StatSession | GetStatSession () |
| Gets Session State. More... | |
| void | Shutdown () |
| Shutdowns Session server. More... | |
| void | ping () |
| Determines whether the server has already been loaded or not. More... | |
| long | getPID () |
| Returns the PID of the server. More... | |
| string | getHostname () |
| Returns host name. More... | |
| long | GetActiveStudyId () |
| Get Active study ID. More... | |
| boolean | restoreVisualState (in long theSavePoint) |
| Restores a state of the study at theSavePoint. More... | |
| StringSeq | getSelection () |
| Get list of selected entities. More... | |
| void | emitMessage (in string theMessage) |
| Send a message to the session GUI desktop that will emit a qt signal. More... | |
| oneway void | emitMessageOneWay (in string theMessage) |
| same as emitMessage but in a non blocking way More... | |
Interface of the session.
The session Server launches and stops GUI (Graphical User Interface). The session can be active without GUI (It can contain one or more running studies)
| void SALOME::Session::emitMessage | ( | in string | theMessage | ) |
Send a message to the session GUI desktop that will emit a qt signal.
This method can be used to send a message to the GUI from the standalone container. Caution: this method can block the Session and the calling container if it is called when container processes some request from the GUI (mutual lock takes place). In such a case it is recommended to use oneway method.
| oneway void SALOME::Session::emitMessageOneWay | ( | in string | theMessage | ) |
same as emitMessage but in a non blocking way
Emit a qt signal from the session GUI desktop window. This method can be used to send a message to the GUI from the standalone container. This method never blocks the Session and the calling container.
| long SALOME::Session::GetActiveStudyId | ( | ) |
Get Active study ID.
| Engines::EngineComponent SALOME::Session::GetComponent | ( | in string | theLibraryName | ) |
Returns a standalone component.
| string SALOME::Session::getHostname | ( | ) |
Returns host name.
| void SALOME::Session::GetInterface | ( | ) |
Launches GUI in the session.
| long SALOME::Session::getPID | ( | ) |
Returns the PID of the server.
| StringSeq SALOME::Session::getSelection | ( | ) |
Get list of selected entities.
| StatSession SALOME::Session::GetStatSession | ( | ) |
Gets Session State.
| void SALOME::Session::ping | ( | ) |
Determines whether the server has already been loaded or not.
| boolean SALOME::Session::restoreVisualState | ( | in long | theSavePoint | ) |
Restores a state of the study at theSavePoint.
| void SALOME::Session::Shutdown | ( | ) |
Shutdowns Session server.
| void SALOME::Session::StopSession | ( | ) | raises (GUIActive, RunningStudies) |
Stops the Session (It must be idle)