Study Interface More...

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

exception	StudyInvalidComponent
	Invalid study component. More...

exception	StudyInvalidContext
	Invalid study context. 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
	Sequence containing SObjects. More...

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

SalomeReference	GetTransientReference () raises (StudyInvalidReference)
	Get a transient 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...

void	SetContext (in string thePath) raises (StudyInvalidReference, StudyInvalidContext)
	Set the context of the Study. More...

string	GetContext () raises (StudyInvalidReference, StudyInvalidContext)
	Get the context of the Study. More...

ListOfStrings	GetObjectNames (in string theContext) raises (StudyInvalidReference, StudyInvalidContext)
	Get a list of names of objects corresponding to the context. More...

ListOfStrings	GetDirectoryNames (in string theContext) raises (StudyInvalidReference, StudyInvalidContext)
	Get a list of names of directories and subdirectories corresponding to the context. More...

ListOfStrings	GetFileNames (in string theContext) raises (StudyInvalidReference, StudyInvalidContext)
	Get a list of names of Files corresponding to the context. More...

ListOfStrings	GetComponentNames (in string theContext) raises (StudyInvalidReference)
	Get a list of names of Components corresponding to the context. 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	Close () raises (StudyInvalidReference)
	Close the components in the study, remove itself from the StudyManager. 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)

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)

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)

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)

void	detach (in SALOMEDS::Observer theObserver)

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

attribute short	StudyId
	The ID of the Study. More...

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

attribute string	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 StudyManager and 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

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

Sequence containing SObjects.

Member Function Documentation

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

Get the persistent reference to the Study.

SalomeReference SALOMEDS::Study::GetTransientReference ( ) raises (StudyInvalidReference)

Get a transient reference to the Study.

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

indicate whether the Study is empty

Returns: True if the Study is empty

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.

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

Find a SComponent by ID of the according SObject.

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.

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

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

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

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.

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.

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

Get the path to the SObject.

void SALOMEDS::Study::SetContext ( in string thePath ) raises (StudyInvalidReference, StudyInvalidContext)

Set the context of the Study.

Parameters

thePath String parameter defining the context of the study.

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

string SALOMEDS::Study::GetContext ( ) raises (StudyInvalidReference, StudyInvalidContext)

Get the context of the Study.

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

ListOfStrings SALOMEDS::Study::GetObjectNames ( in string theContext ) raises (StudyInvalidReference, StudyInvalidContext)

Get a list of names of objects corresponding to the context.

Note: If the parameter theContext is empty, then the current context will be used.

ListOfStrings SALOMEDS::Study::GetDirectoryNames ( in string theContext ) raises (StudyInvalidReference, StudyInvalidContext)

Get a list of names of directories and subdirectories corresponding to the context.

Note: If the parameter theContext is empty, then the current context will be used.

ListOfStrings SALOMEDS::Study::GetFileNames ( in string theContext ) raises (StudyInvalidReference, StudyInvalidContext)

Get a list of names of Files corresponding to the context.

Note: If the parameter theContext is empty, then the current context will be used.

ListOfStrings SALOMEDS::Study::GetComponentNames ( in string theContext ) raises (StudyInvalidReference)

Get a list of names of Components corresponding to the context.

Note: If the parameter theContext is empty, then the current context will be used.

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.

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

Create a new iterator of the SComponents.

Returns: A new iterator of the SComponents.

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.

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.

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.

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.

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

Mark the study as being modified and not saved.

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

List of SObjects.

Returns the list of SObjects which refers to anObject.

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"

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.

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

Object conversion.

Converts an object into IOR.

Returns: IOR

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

Object conversion.

Converts IOR into an object.

Returns: An object

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

Get a new UseCaseBuilder.

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

Close the components in the study, remove itself from the StudyManager.

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

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

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

Functions for internal usage only

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

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

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

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

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.

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

Indicate if the Study is locked.

Returns True if the Study was marked locked.

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.

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

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

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.

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.

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.

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.

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

Set current value as double for string variable.

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

Get value of a real variable.

Parameters