Version: 8.3.0
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
SALOMEDS::StudyManager Interface Reference

Study Manager interface More...

Public Member Functions

void ping ()
 
void Shutdown ()
 
long getPID ()
 
oneway void ShutdownWithExit ()
 
Study NewStudy (in string study_name) raises (SALOME::SALOME_Exception)
 Creation of a new study. More...
 
Study Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception)
 Open a study. More...
 
void Close (in Study aStudy)
 Closing the study. More...
 
boolean Save (in Study aStudy, in boolean theMultiFile)
 Saving the study in a HDF file (or files). More...
 
boolean SaveASCII (in Study aStudy, in boolean theMultiFile)
 Saving a study in a ASCII file (or files). More...
 
boolean SaveAs (in URL aUrl, in Study aStudy, in boolean theMultiFile)
 Saving the study in a specified HDF file (or files). More...
 
boolean SaveAsASCII (in URL aUrl, in Study aStudy, in boolean theMultiFile)
 Saving the study in a specified ASCII file (or files). More...
 
ListOfOpenStudies GetOpenStudies ()
 List of open studies. More...
 
Study GetStudyByName (in string aStudyName)
 Getting a particular Study picked by name. More...
 
Study GetStudyByID (in short aStudyID)
 Getting a particular Study picked by ID. More...
 
boolean CanCopy (in SObject theObject)
 
boolean Copy (in SObject theObject)
 
boolean CanPaste (in SObject theObject)
 
SObject Paste (in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection)
 
string ConvertObjectToIOR (in Object theObject)
 Object conversion. More...
 
Object ConvertIORToObject (in string theIOR)
 Object conversion. More...
 
long long GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal)
 

Detailed Description

Study Manager interface

The purpose of the Manager is to manipulate the Studies. You will find in this interface the methods to create, open, close, and save a Study. Since a SALOME session is multi-document, you will also find the methods allowing to navigate through the collection of studies present in a session.

Member Function Documentation

void SALOMEDS::StudyManager::ping ( )

Determines whether the server has already been loaded or not.

long SALOMEDS::StudyManager::getPID ( )

Returns the PID of the server

oneway void SALOMEDS::StudyManager::ShutdownWithExit ( )

Shutdown the StudyManager process.

Study SALOMEDS::StudyManager::NewStudy ( in string  study_name) raises (SALOME::SALOME_Exception)

Creation of a new study.

 Creates a new study with a definite name.
Parameters
study_nameString parameter defining the name of the study

See example17 for an example of this method usage in batchmode of SALOME application.

Study SALOMEDS::StudyManager::Open ( in URL  aStudyUrl) raises (SALOME::SALOME_Exception)

Open a study.

 Reads and activates the structure of the study %Objects.
Parameters
aStudyUrlThe path to the study
Warning
This method doesn't activate the corba objects. Only a component can do it.

See example1 for an example of this method usage in batchmode of SALOME application.

void SALOMEDS::StudyManager::Close ( in Study  aStudy)

Closing the study.

Closes a study.

boolean SALOMEDS::StudyManager::Save ( in Study  aStudy,
in boolean  theMultiFile 
)

Saving the study in a HDF file (or files).

Saves a study.
Parameters
theMultiFileIf this parameter is True the study will be saved in several files.

See example19 for an example of this method usage in batchmode of SALOME application.

boolean SALOMEDS::StudyManager::SaveASCII ( in Study  aStudy,
in boolean  theMultiFile 
)

Saving a study in a ASCII file (or files).

Saves a study in an ASCII format file (or files).

Parameters
theMultiFileIf this parameter is True the study will be saved in several files.
boolean SALOMEDS::StudyManager::SaveAs ( in URL  aUrl,
in Study  aStudy,
in boolean  theMultiFile 
)

Saving the study in a specified HDF file (or files).

Saves the study in a specified file (or files).
Parameters
aUrlThe path to the definite file in whcih the study will be saved
aStudyThe study which will be saved
theMultiFileIf this parameter is True the study will be saved in several files.

See example1 for an example of this method usage in batchmode of SALOME application.

boolean SALOMEDS::StudyManager::SaveAsASCII ( in URL  aUrl,
in Study  aStudy,
in boolean  theMultiFile 
)

Saving the study in a specified ASCII file (or files).

Saves the study in a specified ASCII file (or files).

Parameters
aUrlThe path to the definite file in whcih the study will be saved
aStudyThe study which will be saved
theMultiFileIf this parameter is True the study will be saved in several files.
ListOfOpenStudies SALOMEDS::StudyManager::GetOpenStudies ( )

List of open studies.

Gets the list of open studies

Returns
A list of open studies in the current session.
Study SALOMEDS::StudyManager::GetStudyByName ( in string  aStudyName)

Getting a particular Study picked by name.

Activates a particular Study among the session collection picking it by name.

Parameters
aStudyNameThe name of the study
Study SALOMEDS::StudyManager::GetStudyByID ( in short  aStudyID)

Getting a particular Study picked by ID.

Activates a particular Study among the session collection picking it by ID.

Parameters
aStudyIDThe ID of the study
boolean SALOMEDS::StudyManager::CanCopy ( in SObject  theObject)

Returns True, if the given SObject can be copied to the clipboard.

boolean SALOMEDS::StudyManager::Copy ( in SObject  theObject)

Returns True, if the given SObject is copied to the clipboard.

Parameters
theObjectThe SObject which will be copied
boolean SALOMEDS::StudyManager::CanPaste ( in SObject  theObject)

Returns True, if the object from the clipboard can be pasted to the given SObject.

Parameters
theObjectThe SObject stored in the clipboard.
SObject SALOMEDS::StudyManager::Paste ( in SObject  theObject) raises (SALOMEDS::StudyBuilder::LockProtection)

Returns the SObject in which the object from the clipboard was pasted to.

Parameters
theObjectThe SObject which will be pasted
Exceptions
SALOMEDS::StudyBuilder::LockProtectionThis exception is raised, when trying to paste an object into a study, which is protected for modifications.
string SALOMEDS::StudyManager::ConvertObjectToIOR ( in Object  theObject)

Object conversion.

Converts an object into IOR.

Returns
IOR
Object SALOMEDS::StudyManager::ConvertIORToObject ( in string  theIOR)

Object conversion.

Converts IOR into an object.

Returns
An object
long long SALOMEDS::StudyManager::GetLocalImpl ( in string  theHostname,
in long  thePID,
out boolean  isLocal 
)

Private method, returns an implementation of this StudyManager.

Parameters
theHostnameis a hostname of the caller
thePIDis a process ID of the caller
isLocalis set True if the StudyManager is launched locally with the caller