General KERNEL Documentation     End User KERNEL Services  


SALOME::Session Interface Reference

Interface of the session. More...

import "SALOME_Session.idl";


Public Member Functions

void GetInterface ()
Engines::Component GetComponent (in string theLibraryName)
void StopSession () raises (GUIActive, RunningStudies)
StatSession GetStatSession ()
void ping ()
long GetActiveStudyId ()
boolean restoreVisualState (in long theSavePoint)

Data Structures

exception  RunningStudies
exception  GUIActive


Detailed Description

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)


Member Function Documentation

void SALOME::Session::GetInterface  ) 
 

Launches GUI in the session

Engines::Component SALOME::Session::GetComponent in string  theLibraryName  ) 
 

Returns a standalone component

void SALOME::Session::StopSession  )  raises (GUIActive, RunningStudies)
 

Stops the Session (It must be idle)

StatSession SALOME::Session::GetStatSession  ) 
 

Gets Session State

void SALOME::Session::ping  ) 
 

Determines whether the server has already been loaded or not.

long SALOME::Session::GetActiveStudyId  ) 
 

Get Active study ID

boolean SALOME::Session::restoreVisualState in long  theSavePoint  ) 
 

Restores a state of the study at theSavePoint