Back to index

salome-kernel  6.5.0
Classes | Public Member Functions
SALOME::Session Interface Reference

Interface of the session. More...

import "SALOME_Session.idl";

List of all members.

Classes

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.
Engines::EngineComponent GetComponent (in string theLibraryName)
 Returns a standalone component.
void StopSession () raises (GUIActive, RunningStudies)
 Stops the Session (It must be idle)
StatSession GetStatSession ()
 Gets Session State.
void Shutdown ()
 Shutdowns Session server.
void ping ()
 Determines whether the server has already been loaded or not.
long getPID ()
 Returns the PID of the server.
string getHostname ()
 Returns host name.
long GetActiveStudyId ()
 Get Active study ID.
boolean restoreVisualState (in long theSavePoint)
 Restores a state of the study at theSavePoint.
void emitMessage (in string theMessage)
 Send a message to the session GUI desktop that will emit a qt signal.
oneway void emitMessageOneWay (in string theMessage)
 same as emitMessage but in a non blocking way

Detailed Description

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)

Definition at line 68 of file SALOME_Session.idl.


Class Documentation

exception SALOME::Session::GUIActive

This exception is raised when trying to stop the session with active GUI.

Definition at line 71 of file SALOME_Session.idl.

exception SALOME::Session::RunningStudies

This exception is raised when trying to stop the session with a number of running studies.

Definition at line 73 of file SALOME_Session.idl.


Member Function Documentation

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.

Get Active study ID.

Returns a standalone component.

Returns host name.

Launches GUI in the session.

Returns the PID of the server.

Gets Session State.

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.

Shutdowns Session server.

Stops the Session (It must be idle)


The documentation for this interface was generated from the following file: