SALOMEDS::StudyManager Interface Reference

Study Manager interface More...

import "SALOMEDS.idl";

Public Member Functions

void ping ()

Study NewStudy (in string study_name)

Creation of a new study.

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

Open a study.

void Close (in Study aStudy)

Closing the study.

boolean Save (in Study aStudy, in boolean theMultiFile)

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

boolean SaveASCII (in Study aStudy, in boolean theMultiFile)

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

boolean SaveAs (in URL aUrl, in Study aStudy, in boolean theMultiFile)

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

boolean SaveAsASCII (in URL aUrl, in Study aStudy, in boolean theMultiFile)

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

ListOfOpenStudies GetOpenStudies ()

List of open studies.

Study GetStudyByName (in string aStudyName)

Getting a particular Study picked by name.

Study GetStudyByID (in short aStudyID)

Getting a particular Study picked by ID.

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.

Object ConvertIORToObject (in string theIOR)

Object conversion.

long GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal)

Detailed Description

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.

Study SALOMEDS::StudyManager::NewStudy ( in string study_name )

Creates a new study with a definite name.

Parameters:

study_name String parameter defining the name of the study

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

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

Reads and activates the structure of the study Objects.
Parameters:

aStudyUrl The path to the study

Warning:
This method doesn't activate the corba objects. Only a component can do it.

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

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

Closes a study.

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

in boolean theMultiFile

)

Saves a study.

Parameters:

theMultiFile If this parameter is True the study will be saved in several files.

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

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

in boolean theMultiFile

)

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

theMultiFile If 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

)

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

aUrl The path to the definite file in whcih the study will be saved

aStudy The study which will be saved

theMultiFile If this parameter is True the study will be saved in several files.

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

boolean SALOMEDS::StudyManager::SaveAsASCII ( in URL aUrl,

in Study aStudy,

in boolean theMultiFile

)

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

Parameters:

aUrl The path to the definite file in whcih the study will be saved

aStudy The study which will be saved

theMultiFile If this parameter is True the study will be saved in several files.

ListOfOpenStudies SALOMEDS::StudyManager::GetOpenStudies ( )

Gets the list of open studies

Returns:
A list of open studies in the current session.

Study SALOMEDS::StudyManager::GetStudyByName ( in string aStudyName )

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

aStudyName The name of the study

Study SALOMEDS::StudyManager::GetStudyByID ( in short aStudyID )

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

aStudyID The 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:

theObject The 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:

theObject The 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:

theObject The SObject which will be pasted

Exceptions:

SALOMEDS::StudyBuilder::LockProtection This exception is raised, when trying to paste an object into a study, which is protected for modifications.

string SALOMEDS::StudyManager::ConvertObjectToIOR ( in Object theObject )

Converts an object into IOR.
Returns:
IOR

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

Converts IOR into an object.
Returns:
An object

long SALOMEDS::StudyManager::GetLocalImpl ( in string theHostname,

in long thePID,

out boolean isLocal

)

Private method, returns an implementation of this StudyManager.
Parameters:

theHostname is a hostname of the caller

thePID is a process ID of the caller

isLocal is set True if the StudyManager is launched locally with the caller


Public Member Functions
void	ping ()
Study	NewStudy (in string study_name)
	Creation of a new study.
Study	Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception)
	Open a study.
void	Close (in Study aStudy)
	Closing the study.
boolean	Save (in Study aStudy, in boolean theMultiFile)
	Saving the study in a HDF file (or files).
boolean	SaveASCII (in Study aStudy, in boolean theMultiFile)
	Saving a study in a ASCII file (or files).
boolean	SaveAs (in URL aUrl, in Study aStudy, in boolean theMultiFile)
	Saving the study in a specified HDF file (or files).
boolean	SaveAsASCII (in URL aUrl, in Study aStudy, in boolean theMultiFile)
	Saving the study in a specified ASCII file (or files).
ListOfOpenStudies	GetOpenStudies ()
	List of open studies.
Study	GetStudyByName (in string aStudyName)
	Getting a particular Study picked by name.
Study	GetStudyByID (in short aStudyID)
	Getting a particular Study picked by ID.
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.
Object	ConvertIORToObject (in string theIOR)
	Object conversion.
long	GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal)