Study Interface More...

import"SALOMEDS.idl";

Data Structures
exception	StudyCommentError
	Invalid study comment. More...

exception	StudyInvalidComponent
	Invalid study component. More...

exception	StudyInvalidDirectory
	Invalid directory of the study exception. More...

exception	StudyInvalidReference
	Invalid study reference. More...

exception	StudyNameAlreadyUsed
	Exception pointing that this name of the study has already been used. More...

exception	StudyNameError
	Invalid name of the study exception. More...

exception	StudyObjectAlreadyExists
	study object already exists More...

Public Types
typedef sequence< SObject >	ListOfSObject
	Indicate the file where the study has been saved. More...

Public Member Functions
void	ping ()
	Determines whether the server has already been loaded or not. More...

void	Shutdown ()

long	getPID ()
	Returns the PID of the server. More...

oneway void	ShutdownWithExit ()
	Shutdown the Study process. More...

PersistentReference	GetPersistentReference () raises (StudyInvalidReference)
	Get the persistent reference to the Study. More...

boolean	IsEmpty () raises (StudyInvalidReference)
	indicate whether the Study is empty More...

SComponent	FindComponent (in string aComponentName) raises (StudyInvalidReference)
	Find a SComponent by its name. More...

SComponent	FindComponentID (in ID aComponentID) raises (StudyInvalidReference)
	Find a SComponent by ID of the according SObject. More...

SObject	FindObject (in string anObjectName) raises (StudyInvalidReference)
	Find a SObject by the Name Attribute of this SObject. More...

SObject	FindObjectID (in ID aObjectID) raises (StudyInvalidReference)
	Find a SObject by its ID. More...

SObject	CreateObjectID (in ID aObjectID) raises (StudyInvalidReference)
	Create a SObject by its ID. More...

SObject	FindObjectIOR (in ID aObjectIOR) raises (StudyInvalidReference)
	Find a SObject by IOR of the object belonging to this SObject. More...

ListOfSObject	FindObjectByName (in string anObjectName, in string aComponentName) raises (StudyInvalidReference)
	Find in the study all SObjects produced by a given Component. More...

SObject	FindObjectByPath (in string thePath) raises (StudyInvalidReference)
	Find a SObject by the path to it. More...

string	GetObjectPath (in Object theObject) raises (StudyInvalidReference)
	Get the path to the SObject. More...

ChildIterator	NewChildIterator (in SObject aSO) raises (StudyInvalidReference)
	Create a new iterator of child levels of the given SObject. More...

SComponentIterator	NewComponentIterator () raises (StudyInvalidReference)
	Create a new iterator of the SComponents. More...

StudyBuilder	NewBuilder () raises (StudyInvalidReference)
	Create a new StudyBuilder to add or modify an object in the study. More...

void	UpdateIORLabelMap (in string anIOR, in string anEntry) raises (StudyInvalidReference)
	Labels dependency. More...

AttributeStudyProperties	GetProperties () raises (StudyInvalidReference)
	Getting properties of the study. More...

boolean	IsModified () raises (StudyInvalidReference)
	Indicate whether the study has been modified and not saved. More...

void	Modified () raises (StudyInvalidReference)
	Mark the study as being modified and not saved. More...

ListOfSObject	FindDependances (in SObject anObject) raises (StudyInvalidReference)
	List of SObjects. More...

string	GetLastModificationDate () raises (StudyInvalidReference)
	The date of the last saving of the study. More...

ListOfDates	GetModificationsDate () raises (StudyInvalidReference)
	The list of modification dates of the study. More...

string	ConvertObjectToIOR (in Object theObject)
	Object conversion. More...

Object	ConvertIORToObject (in string theIOR)
	Object conversion. More...

UseCaseBuilder	GetUseCaseBuilder () raises (StudyInvalidReference)
	Get a new UseCaseBuilder. More...

void	Clear () raises (StudyInvalidReference)
	Clear a study object. More...

void	Init () raises (StudyInvalidReference)
	Initialization a study object. More...

boolean	Open (in URLPath aStudyUrl) raises (SALOME::SALOME_Exception)
	Open a study by url. More...

boolean	CanOpen (in URLPath aStudyUrl)
	Check if study can be opened. More...

boolean	Save (in boolean theMultiFile, in boolean theASCII) raises (StudyInvalidReference)
	Saving the study in a file (or files). More...

boolean	SaveAs (in URLPath aUrl, in boolean theMultiFile, in boolean theASCII) raises (StudyInvalidReference)
	Saving the study in a specified file (or files). More...

boolean	CanCopy (in SObject theObject) raises (StudyInvalidReference)
	Returns True, if the given SObject can be copied to the clipboard. More...

boolean	Copy (in SObject theObject) raises (StudyInvalidReference)
	Returns True, if the given SObject is copied to the clipboard. More...

boolean	CanPaste (in SObject theObject) raises (StudyInvalidReference)
	Returns True, if the object from the clipboard can be pasted to the given SObject. More...

SObject	Paste (in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection)
	Returns the SObject in which the object from the clipboard was pasted to. More...

void	EnableUseCaseAutoFilling (in boolean isEnabled) raises (StudyInvalidReference)
	Enable (if isEnabled = True)/disable automatic addition of new SObjects to the use case. More...

void	AddPostponed (in string theIOR) raises (StudyInvalidReference)
	Functions for internal usage only. More...

void	AddCreatedPostponed (in string theIOR) raises (StudyInvalidReference)

void	RemovePostponed (in long theUndoLimit) raises (StudyInvalidReference)

void	UndoPostponed (in long theWay) raises (StudyInvalidReference)

boolean	DumpStudy (in string thePath, in string theBaseName, in boolean isPublished, in boolean isMultiFile) raises (StudyInvalidReference)

string	GetDumpPath ()
	Returns the folder of the python script which is currently dumped. More...

AttributeParameter	GetCommonParameters (in string theID, in long theSavePoint) raises (StudyInvalidReference)
	Get an AttributeParameter used to store common parameters for given theSavePoint. More...

AttributeParameter	GetModuleParameters (in string theID, in string theModuleName, in long theSavePoint) raises (StudyInvalidReference)
	Get an AttributeParameter used to store parameters for given theModuleName. More...

string	GetDefaultScript (in string theModuleName, in string indent) raises (StudyInvalidReference)
	Get a default Python script to restore visual parameters for given theModuleName. More...

long long	GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal)
	Private method, returns an implementation of this Study. More...

void	SetStudyLock (in string theLockerID) raises (StudyInvalidReference)
	Mark this Study as being locked by the given locker. More...

boolean	IsStudyLocked () raises (StudyInvalidReference)
	Indicate if the Study is locked. More...

void	UnLockStudy (in string theLockerID) raises (StudyInvalidReference)
	Mark this Study as being unlocked by the given locker. More...

ListOfStrings	GetLockerID () raises (StudyInvalidReference)
	Get the list of IDs of the Study's lockers. More...

void	SetReal (in string theVarName, in double theValue) raises (StudyInvalidReference)
	Create real variable with Name theVarName and value theValue. More...

void	SetInteger (in string theVarName, in long theValue) raises (StudyInvalidReference)
	Create integer variable with Name theVarName and value theValue. More...

void	SetBoolean (in string theVarName, in boolean theValue) raises (StudyInvalidReference)
	Create boolean variable with Name theVarName and value theValue. More...

void	SetString (in string theVarName, in string theValue) raises (StudyInvalidReference)
	Create string variable with Name theVarName and value theValue. More...

void	SetStringAsDouble (in string theVarName, in double theValue) raises (StudyInvalidReference)
	Set current value as double for string variable. More...

double	GetReal (in string theVarName) raises (StudyInvalidReference)
	Get value of a real variable. More...

long	GetInteger (in string theVarName) raises (StudyInvalidReference)
	Get value of an integer variable. More...

boolean	GetBoolean (in string theVarName) raises (StudyInvalidReference)
	Get value of a boolean variable. More...

string	GetString (in string theVarName) raises (StudyInvalidReference)
	Get value of a string variable. More...

boolean	IsReal (in string theVarName) raises (StudyInvalidReference)
	Indicate if a variable is real. More...

boolean	IsInteger (in string theVarName) raises (StudyInvalidReference)
	Indicate if a variable is integer. More...

boolean	IsBoolean (in string theVarName) raises (StudyInvalidReference)
	Indicate if a variable is boolean. More...

boolean	IsString (in string theVarName) raises (StudyInvalidReference)
	Indicate if a variable is string. More...

boolean	IsVariable (in string theVarName) raises (StudyInvalidReference)
	Indicate if a variable exists in the study. More...

ListOfStrings	GetVariableNames () raises (StudyInvalidReference)
	Get names of all variables from the study. More...

boolean	RemoveVariable (in string theVarName) raises (StudyInvalidReference)
	Remove a variable. More...

boolean	RenameVariable (in string theVarName, in string theNewVarName) raises (StudyInvalidReference)
	Rename a variable. More...

boolean	IsVariableUsed (in string theVarName) raises (StudyInvalidReference)
	Indicate whether variable is used. More...

ListOfListOfStrings	ParseVariables (in string theVars) raises (StudyInvalidReference)
	Parse variables used for object creation. More...

void	attach (in SALOMEDS::Observer theObserver, in boolean modify)
	Attach an observer to the Study. More...

void	detach (in SALOMEDS::Observer theObserver)
	Detach an observer from the Study. More...

Data Fields
attribute wstring	Name
	The name of the Study. More...

attribute boolean	IsSaved
	Indicate whether the study has been saved. More...

attribute wstring	URL
	Indicate the file where the study has been saved. More...

Detailed Description

Study Interface

The purpose of the Study is to manage the data produced by various components of SALOME platform. Most of the Study operations are handled by the StudyBuilder. What is left in the Study interface are elementary inquiries. (Incidentally, we recall that a CORBA attribute is implemented as a pair of get and set methods.) A Study is explored by a set of tools, mainly iterators , which are described further. Nevertheless, the Study interface allows the search of an object by name or by ID.

Note: The Path of an object in SALOME application is much alike a standard path of a file. In general it's a string of names of directories divided by a slash '/'.
The Context is the current directory of an object.

Member Typedef Documentation

◆ ListOfSObject

typedef sequence<SObject> SALOMEDS::Study::ListOfSObject

Indicate the file where the study has been saved.

Sequence containing SObjects

Member Function Documentation

◆ AddCreatedPostponed()

void SALOMEDS::Study::AddCreatedPostponed	(	in string	theIOR	)
raises	(	StudyInvalidReference
	)

◆ AddPostponed()

void SALOMEDS::Study::AddPostponed	(	in string	theIOR	)
raises	(	StudyInvalidReference
	)

Functions for internal usage only.

◆ attach()

void SALOMEDS::Study::attach	(	in SALOMEDS::Observer	theObserver,
		in boolean	modify
	)

Attach an observer to the Study.

Parameters

theObserver	observer being attached
modify	when `true`, observer receives any object's modification events; otherwise observer receives object's creation events only

◆ CanCopy()

boolean SALOMEDS::Study::CanCopy	(	in SObject	theObject	)
raises	(	StudyInvalidReference
	)

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

◆ CanOpen()

boolean SALOMEDS::Study::CanOpen ( in URLPath aStudyUrl )

Check if study can be opened.

Tries to open and read given url.

Parameters

aStudyUrl The path to the study

◆ CanPaste()

boolean SALOMEDS::Study::CanPaste	(	in SObject	theObject	)
raises	(	StudyInvalidReference
	)

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

Parameters

theObject The SObject stored in the clipboard.

◆ Clear()

void SALOMEDS::Study::Clear	(		)
raises	(	StudyInvalidReference
	)

Clear a study object.

◆ ConvertIORToObject()

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

Object conversion.

Converts IOR into an object.

Returns: An object

◆ ConvertObjectToIOR()

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

Object conversion.

Converts an object into IOR.

Returns: IOR

◆ Copy()

boolean SALOMEDS::Study::Copy	(	in SObject	theObject	)
raises	(	StudyInvalidReference
	)

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

Parameters

theObject The SObject which will be copied

◆ CreateObjectID()

SObject SALOMEDS::Study::CreateObjectID	(	in ID	aObjectID	)
raises	(	StudyInvalidReference
	)

Create a SObject by its ID.

Parameters

aObjectID This parameter defines the ID of the required object

Returns: The created SObject

◆ detach()

void SALOMEDS::Study::detach ( in SALOMEDS::Observer theObserver )

Detach an observer from the Study.

Parameters

theObserver observer to be detached

◆ DumpStudy()

boolean SALOMEDS::Study::DumpStudy	(	in string	thePath,
		in string	theBaseName,
		in boolean	isPublished,
		in boolean	isMultiFile
	)
raises	(	StudyInvalidReference
	)

◆ EnableUseCaseAutoFilling()

void SALOMEDS::Study::EnableUseCaseAutoFilling	(	in boolean	isEnabled	)
raises	(	StudyInvalidReference
	)

Enable (if isEnabled = True)/disable automatic addition of new SObjects to the use case.

◆ FindComponent()

SComponent SALOMEDS::Study::FindComponent	(	in string	aComponentName	)
raises	(	StudyInvalidReference
	)

Find a SComponent by its name.

Parameters

aComponentName It's a string value in the Comment Attribute of the Component, which is looked for, defining the data type of this Component.

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

◆ FindComponentID()

SComponent SALOMEDS::Study::FindComponentID	(	in ID	aComponentID	)
raises	(	StudyInvalidReference
	)

Find a SComponent by ID of the according SObject.

◆ FindDependances()

ListOfSObject SALOMEDS::Study::FindDependances	(	in SObject	anObject	)
raises	(	StudyInvalidReference
	)

List of SObjects.

Returns the list of SObjects which refers to anObject.

◆ FindObject()

SObject SALOMEDS::Study::FindObject	(	in string	anObjectName	)
raises	(	StudyInvalidReference
	)

Find a SObject by the Name Attribute of this SObject.

Parameters

anObjectName String parameter defining the name of the object

Returns: The obtained SObject

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

◆ FindObjectByName()

ListOfSObject SALOMEDS::Study::FindObjectByName	(	in string	anObjectName,
		in string	aComponentName
	)
raises	(	StudyInvalidReference
	)

Find in the study all SObjects produced by a given Component.

Parameters

anObjectName	The Name Attribute of the searched SObjects should correspond to anObjectName.
aComponentName	The name of the component, which objects are searched for.

◆ FindObjectByPath()

SObject SALOMEDS::Study::FindObjectByPath	(	in string	thePath	)
raises	(	StudyInvalidReference
	)

Find a SObject by the path to it.

Parameters

thePath The path to the required SObject.

Returns: The obtained SObject.

◆ FindObjectID()

SObject SALOMEDS::Study::FindObjectID	(	in ID	aObjectID	)
raises	(	StudyInvalidReference
	)

Find a SObject by its ID.

Parameters

aObjectID This parameter defines the ID of the required object

Returns: The obtained SObject

◆ FindObjectIOR()

SObject SALOMEDS::Study::FindObjectIOR	(	in ID	aObjectIOR	)
raises	(	StudyInvalidReference
	)

Find a SObject by IOR of the object belonging to this SObject.

Parameters

anObjectName This parameter defines the IOR of the object

Returns: The obtained SObject

◆ GetBoolean()

boolean SALOMEDS::Study::GetBoolean	(	in string	theVarName	)
raises	(	StudyInvalidReference
	)

Get value of a boolean variable.

Parameters

theVarName is a name of the variable.

◆ GetCommonParameters()

AttributeParameter SALOMEDS::Study::GetCommonParameters	(	in string	theID,
		in long	theSavePoint
	)
raises	(	StudyInvalidReference
	)

Get an AttributeParameter used to store common parameters for given theSavePoint.

Parameters

theID	identifies a common parameters set (Example: "Interface Applicative")
theSavePoint	is number of a set of parameters as there can be several sets

◆ GetDefaultScript()

string SALOMEDS::Study::GetDefaultScript	(	in string	theModuleName,
		in string	indent
	)
raises	(	StudyInvalidReference
	)

Get a default Python script to restore visual parameters for given theModuleName.

Parameters

theModuleName	is a name of the module (Example: "Geometry")
indent	is a string to use for script indentation

◆ GetDumpPath()

string SALOMEDS::Study::GetDumpPath ( )

Returns the folder of the python script which is currently dumped.

◆ GetInteger()

long SALOMEDS::Study::GetInteger	(	in string	theVarName	)
raises	(	StudyInvalidReference
	)

Get value of an integer variable.

Parameters

theVarName is a name of the variable.

◆ GetLastModificationDate()

string SALOMEDS::Study::GetLastModificationDate	(		)
raises	(	StudyInvalidReference
	)

The date of the last saving of the study.

Returns the date of the last saving of study with format: "DD/MM/YYYY HH:MM"

◆ GetLocalImpl()

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

Private method, returns an implementation of this Study.

Parameters

theHostname	is a hostname of the caller
thePID	is a process ID of the caller
isLocal	is set True if the Study is launched locally with the caller

◆ GetLockerID()

ListOfStrings SALOMEDS::Study::GetLockerID	(		)
raises	(	StudyInvalidReference
	)

Get the list of IDs of the Study's lockers.

◆ GetModificationsDate()

ListOfDates SALOMEDS::Study::GetModificationsDate	(		)
raises	(	StudyInvalidReference
	)

The list of modification dates of the study.

Returns the list of modification dates (without creation date) with format "DD/MM/YYYY HH:MM". Note : the first modification begins the list.

◆ GetModuleParameters()

AttributeParameter SALOMEDS::Study::GetModuleParameters	(	in string	theID,
		in string	theModuleName,
		in long	theSavePoint
	)
raises	(	StudyInvalidReference
	)

Get an AttributeParameter used to store parameters for given theModuleName.

Parameters

theID	identifies a common parameters set (Example: "Interface Applicative")
theModuleName	is a name of the module (Example: "Geometry")
theSavePoint	is number of a set of parameters as there can be several sets

◆ GetObjectPath()

string SALOMEDS::Study::GetObjectPath	(	in Object	theObject	)
raises	(	StudyInvalidReference
	)

Get the path to the SObject.

◆ GetPersistentReference()

PersistentReference SALOMEDS::Study::GetPersistentReference	(		)
raises	(	StudyInvalidReference
	)

Get the persistent reference to the Study.

◆ getPID()

long SALOMEDS::Study::getPID ( )

Returns the PID of the server.

◆ GetProperties()

AttributeStudyProperties SALOMEDS::Study::GetProperties	(		)
raises	(	StudyInvalidReference
	)

Getting properties of the study.

Returns the attribute, which contains the properties of this study.

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

◆ GetReal()

double SALOMEDS::Study::GetReal	(	in string	theVarName	)
raises	(	StudyInvalidReference
	)

Get value of a real variable.

Parameters

theVarName is a name of the variable.

◆ GetString()

string SALOMEDS::Study::GetString	(	in string	theVarName	)
raises	(	StudyInvalidReference
	)

Get value of a string variable.

Parameters

theVarName is a name of the variable.

◆ GetUseCaseBuilder()

UseCaseBuilder SALOMEDS::Study::GetUseCaseBuilder	(		)
raises	(	StudyInvalidReference
	)

Get a new UseCaseBuilder.

◆ GetVariableNames()

ListOfStrings SALOMEDS::Study::GetVariableNames	(		)
raises	(	StudyInvalidReference
	)

Get names of all variables from the study.

◆ Init()

void SALOMEDS::Study::Init	(		)
raises	(	StudyInvalidReference
	)

Initialization a study object.

◆ IsBoolean()

boolean SALOMEDS::Study::IsBoolean	(	in string	theVarName	)
raises	(	StudyInvalidReference
	)

Indicate if a variable is boolean.

Return true if variable is boolean otherwise return false.

Parameters

theVarName is a name of the variable.

◆ IsEmpty()

boolean SALOMEDS::Study::IsEmpty	(		)
raises	(	StudyInvalidReference
	)

indicate whether the Study is empty

Returns: True if the Study is empty

◆ IsInteger()

boolean SALOMEDS::Study::IsInteger	(	in string	theVarName	)
raises	(	StudyInvalidReference
	)

Indicate if a variable is integer.

Return true if variable is integer otherwise return false.

Parameters

theVarName is a name of the variable.

◆ IsModified()

boolean SALOMEDS::Study::IsModified	(		)
raises	(	StudyInvalidReference
	)

Indicate whether the study has been modified and not saved.

Returns True if the study has been modified and not saved.

◆ IsReal()

boolean SALOMEDS::Study::IsReal	(	in string	theVarName	)
raises	(	StudyInvalidReference
	)

Indicate if a variable is real.

Return true if variable is real otherwise return false.

Parameters

theVarName is a name of the variable.

Referenced by KERNEL_PY.salome_notebook.PseudoStudyForNoteBook::IsString().

◆ IsString()

boolean SALOMEDS::Study::IsString	(	in string	theVarName	)
raises	(	StudyInvalidReference
	)

Indicate if a variable is string.

Return true if variable is string otherwise return false.

Parameters

theVarName is a name of the variable.

◆ IsStudyLocked()

boolean SALOMEDS::Study::IsStudyLocked	(		)
raises	(	StudyInvalidReference
	)

Indicate if the Study is locked.

Returns True if the Study was marked locked.

◆ IsVariable()

boolean SALOMEDS::Study::IsVariable	(	in string	theVarName	)
raises	(	StudyInvalidReference
	)

Indicate if a variable exists in the study.

Return true if variable exists in the study, otherwise return false.

Parameters

theVarName is a name of the variable.

◆ IsVariableUsed()

boolean SALOMEDS::Study::IsVariableUsed	(	in string	theVarName	)
raises	(	StudyInvalidReference
	)

Indicate whether variable is used.

Check that variable is used in the study.

Parameters

theVarName Name of the variable.

Returns: Variable usage.

◆ Modified()

void SALOMEDS::Study::Modified	(		)
raises	(	StudyInvalidReference
	)

Mark the study as being modified and not saved.

◆ NewBuilder()

StudyBuilder SALOMEDS::Study::NewBuilder	(		)
raises	(	StudyInvalidReference
	)

Create a new StudyBuilder to add or modify an object in the study.

Returns: A new StudyBuilder.

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

◆ NewChildIterator()

ChildIterator SALOMEDS::Study::NewChildIterator	(	in SObject	aSO	)
raises	(	StudyInvalidReference
	)

Create a new iterator of child levels of the given SObject.

Parameters

aSO	The given SObject

Returns: A new iterator of child levels of the given SObject.

◆ NewComponentIterator()

SComponentIterator SALOMEDS::Study::NewComponentIterator	(		)
raises	(	StudyInvalidReference
	)

Create a new iterator of the SComponents.

Returns: A new iterator of the SComponents.

◆ Open()

boolean SALOMEDS::Study::Open	(	in URLPath	aStudyUrl	)
raises	(	SALOME::SALOME_Exception
	)

Open a study by url.

Reads and activates the structure of the study Objects.

Parameters

aStudyUrl The path to the study

◆ ParseVariables()

ListOfListOfStrings SALOMEDS::Study::ParseVariables	(	in string	theVars	)
raises	(	StudyInvalidReference
	)

Parse variables used for object creation.

Parameters

string with variables, separated by special symbol.

Returns: Variables list.

◆ Paste()

SObject SALOMEDS::Study::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.

◆ ping()

void SALOMEDS::Study::ping ( )

Determines whether the server has already been loaded or not.

◆ RemovePostponed()

void SALOMEDS::Study::RemovePostponed	(	in long	theUndoLimit	)
raises	(	StudyInvalidReference
	)

◆ RemoveVariable()

boolean SALOMEDS::Study::RemoveVariable	(	in string	theVarName	)
raises	(	StudyInvalidReference
	)

Remove a variable.

Remove variable with the specified name from the study with substitution of its value.

Parameters

theVarName Name of the variable.

Returns: Status of operation.

◆ RenameVariable()

boolean SALOMEDS::Study::RenameVariable	(	in string	theVarName,
		in string	theNewVarName
	)
raises	(	StudyInvalidReference
	)

Rename a variable.

Rename variable with the specified name within the study.

Parameters

theVarName	Name of the variable.
theNewVarName	New name for the variable.

Returns: Status of operation.

◆ Save()

boolean SALOMEDS::Study::Save	(	in boolean	theMultiFile,
		in boolean	theASCII
	)
raises	(	StudyInvalidReference
	)

Saving the study in a file (or files).

Saves a study.

Parameters

theMultiFile	If this parameter is True the study will be saved in several files.
theASCII	If this parameter is True the study will be saved in ASCII format, otherwise in HDF format.

Referenced by SALOME_DriverPy.SALOME_DriverPy_i::SaveASCII().

◆ SaveAs()

boolean SALOMEDS::Study::SaveAs	(	in URLPath	aUrl,
		in boolean	theMultiFile,
		in boolean	theASCII
	)
raises	(	StudyInvalidReference
	)

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

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

Parameters

aUrl	The path to the definite file in which the study will be saved
theMultiFile	If this parameter is True the study will be saved in several files.
theASCII	If this parameter is True the study will be saved in ASCII format, otherwise in HDF format.

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

◆ SetBoolean()

void SALOMEDS::Study::SetBoolean	(	in string	theVarName,
		in boolean	theValue
	)
raises	(	StudyInvalidReference
	)

Create boolean variable with Name theVarName and value theValue.

(or set if variable value into theValue already exists)

Parameters

theVarName	is a name of the variable
theVarName	is a value of the variable.

◆ SetInteger()

void SALOMEDS::Study::SetInteger	(	in string	theVarName,
		in long	theValue
	)
raises	(	StudyInvalidReference
	)

Create integer variable with Name theVarName and value theValue.

(or set if variable value into theValue already exists)

Parameters

theVarName	is a name of the variable
theVarName	is a value of the variable.

◆ SetReal()

void SALOMEDS::Study::SetReal	(	in string	theVarName,
		in double	theValue
	)
raises	(	StudyInvalidReference
	)

Create real variable with Name theVarName and value theValue.

(or set if variable value into theValue already exists)

Parameters

theVarName	is a name of the variable
theVarName	is a value of the variable.

◆ SetString()

void SALOMEDS::Study::SetString	(	in string	theVarName,
		in string	theValue
	)
raises	(	StudyInvalidReference
	)

Create string variable with Name theVarName and value theValue.

(or set if variable value into theValue already exists)

Parameters

theVarName	is a name of the variable
theVarName	is a value of the variable.

◆ SetStringAsDouble()

void SALOMEDS::Study::SetStringAsDouble	(	in string	theVarName,
		in double	theValue
	)
raises	(	StudyInvalidReference
	)

Set current value as double for string variable.

◆ SetStudyLock()

void SALOMEDS::Study::SetStudyLock	(	in string	theLockerID	)
raises	(	StudyInvalidReference
	)

Mark this Study as being locked by the given locker.

The lock status can be checked by method IsStudyLocked

Parameters

theLockerID identifies a locker of the study can be for ex. IOR of the engine that locks the study.

◆ Shutdown()

void SALOMEDS::Study::Shutdown ( )

◆ ShutdownWithExit()

oneway void SALOMEDS::Study::ShutdownWithExit ( )

Shutdown the Study process.

◆ UndoPostponed()

void SALOMEDS::Study::UndoPostponed	(	in long	theWay	)
raises	(	StudyInvalidReference
	)

◆ UnLockStudy()

void SALOMEDS::Study::UnLockStudy	(	in string	theLockerID	)
raises	(	StudyInvalidReference
	)

Mark this Study as being unlocked by the given locker.

The lock status can be checked by method IsStudyLocked

Parameters

theLockerID identifies a locker of the study can be for ex. IOR of the engine that unlocks the study.

◆ UpdateIORLabelMap()

void SALOMEDS::Study::UpdateIORLabelMap	(	in string	anIOR,
		in string	anEntry
	)
raises	(	StudyInvalidReference
	)

Labels dependency.

Updates the map with IOR attribute. It's an inner method used for optimization.

Field Documentation

◆ IsSaved

attribute boolean SALOMEDS::Study::IsSaved

Indicate whether the study has been saved.

◆ Name

attribute wstring SALOMEDS::Study::Name

The name of the Study.

This is equivalent to the methods setName() & getName()

◆ URL

attribute wstring SALOMEDS::Study::URL

Indicate the file where the study has been saved.

Data Structures

Public Types

Public Member Functions

Data Fields

Detailed Description

Member Typedef Documentation

◆ ListOfSObject

Member Function Documentation

◆ AddCreatedPostponed()

◆ AddPostponed()

◆ attach()

◆ CanCopy()

◆ CanOpen()

◆ CanPaste()

◆ Clear()

◆ ConvertIORToObject()

◆ ConvertObjectToIOR()

◆ Copy()

◆ CreateObjectID()

◆ detach()

◆ DumpStudy()

◆ EnableUseCaseAutoFilling()

◆ FindComponent()

◆ FindComponentID()

◆ FindDependances()

◆ FindObject()

◆ FindObjectByName()

◆ FindObjectByPath()

◆ FindObjectID()

◆ FindObjectIOR()

◆ GetBoolean()

◆ GetCommonParameters()

◆ GetDefaultScript()

◆ GetDumpPath()

◆ GetInteger()

◆ GetLastModificationDate()

◆ GetLocalImpl()

◆ GetLockerID()

◆ GetModificationsDate()

◆ GetModuleParameters()

◆ GetObjectPath()

◆ GetPersistentReference()

◆ getPID()

◆ GetProperties()

◆ GetReal()

◆ GetString()

◆ GetUseCaseBuilder()

◆ GetVariableNames()

◆ Init()

◆ IsBoolean()

◆ IsEmpty()

◆ IsInteger()

◆ IsModified()

◆ IsReal()

◆ IsString()

◆ IsStudyLocked()

◆ IsVariable()

◆ IsVariableUsed()

◆ Modified()

◆ NewBuilder()

◆ NewChildIterator()

◆ NewComponentIterator()

◆ Open()

◆ ParseVariables()

◆ Paste()

◆ ping()

◆ RemovePostponed()

◆ RemoveVariable()

◆ RenameVariable()

◆ Save()

◆ SaveAs()

◆ SetBoolean()

◆ SetInteger()

◆ SetReal()

◆ SetString()

◆ SetStringAsDouble()

◆ SetStudyLock()

◆ Shutdown()

◆ ShutdownWithExit()

◆ UndoPostponed()