SALOMEDS::Study Interface Reference

Study Interface More...

import "SALOMEDS.idl";

Collaboration diagram for SALOMEDS::Study:


Public Types
typedef sequence< SObject >	ListOfSObject
Public Member Functions
PersistentReference	GetPersistentReference ()
SalomeReference	GetTransientReference ()
boolean	IsEmpty ()
SComponent	FindComponent (in string aComponentName)
SComponent	FindComponentID (in ID aComponentID)
SObject	FindObject (in string anObjectName)
SObject	FindObjectID (in ID aObjectID)
SObject	CreateObjectID (in ID aObjectID)
SObject	FindObjectIOR (in ID aObjectIOR)
ListOfSObject	FindObjectByName (in string anObjectName, in string aComponentName)
SObject	FindObjectByPath (in string thePath)
string	GetObjectPath (in Object theObject)
void	SetContext (in string thePath)
string	GetContext ()
ListOfStrings	GetObjectNames (in string theContext)
ListOfStrings	GetDirectoryNames (in string theContext)
ListOfStrings	GetFileNames (in string theContext)
ListOfStrings	GetComponentNames (in string theContext)
ChildIterator	NewChildIterator (in SObject aSO)
SComponentIterator	NewComponentIterator ()
StudyBuilder	NewBuilder ()
void	UpdateIORLabelMap (in string anIOR, in string anEntry)
	Labels dependency.
AttributeStudyProperties	GetProperties ()
	Getting properties of the study.
boolean	IsModified ()
ListOfSObject	FindDependances (in SObject anObject)
	List of SObjects.
string	GetLastModificationDate ()
	The date of the last saving of the study.
ListOfDates	GetModificationsDate ()
	The list of modification dates of the study.
string	ConvertObjectToIOR (in Object theObject)
	Object conversion.
Object	ConvertIORToObject (in string theIOR)
	Object conversion.
UseCaseBuilder	GetUseCaseBuilder ()
void	Close ()
void	EnableUseCaseAutoFilling (in boolean isEnabled)
void	AddPostponed (in string theIOR)
void	AddCreatedPostponed (in string theIOR)
void	RemovePostponed (in long theUndoLimit)
void	UndoPostponed (in long theWay)
boolean	DumpStudy (in string thePath, in string theBaseName, in boolean isPublished)
AttributeParameter	GetCommonParameters (in string theID, in long theSavePoint)
AttributeParameter	GetModuleParameters (in string theID, in string theModuleName, in long theSavePoint)
string	GetDefaultScript (in string theID, in string theModuleName)
long	GetLocalImpl (in string theHostname, in long thePID, out boolean isLocal)
Data Fields
attribute string	Name
	The name of the Study.
attribute short	StudyId
	The ID of the Study.
attribute boolean	IsSaved
attribute string	URL
Data Structures
exception	StudyInvalidContext
exception	StudyCommentError
exception	StudyInvalidComponent
exception	StudyInvalidDirectory
exception	StudyNameAlreadyUsed
exception	StudyNameError
exception	StudyObjectAlreadyExists

Detailed Description

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 ( )

Gets the persistent reference to the Study.

SalomeReference SALOMEDS::Study::GetTransientReference ( )

Gets a transient reference to the Study.

boolean SALOMEDS::Study::IsEmpty ( )

Returns True if the Study is empty

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

Allows to 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 also an example of this method usage in batchmode of SALOME application.

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

Allows to find a SComponent by ID of the according SObject

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

Allows to 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 also an example of this method usage in batchmode of SALOME application.

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

Allows to 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 )

Allows to 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 )

Allows to 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

)

Finds 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 )

Allows to 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 )

Returns the path to the SObject.

void SALOMEDS::Study::SetContext ( in string thePath )

Sets the context of the Study.
Parameters:

thePath String parameter defining the context of the study.

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

string SALOMEDS::Study::GetContext ( )

Gets the context of the Study.

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

ListOfStrings SALOMEDS::Study::GetObjectNames ( in string theContext )

Returns 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 )

Returns 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 )

Returns 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 )

Returns 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 )

Creates 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 ( )

Creates a new iterator of the SComponents.

Returns:
A new iterator of the SComponents.

StudyBuilder SALOMEDS::Study::NewBuilder ( )

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

Returns:
A new StudyBuilder.

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

void SALOMEDS::Study::UpdateIORLabelMap ( in string anIOR,

in string anEntry

)

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

AttributeStudyProperties SALOMEDS::Study::GetProperties ( )

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

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

boolean SALOMEDS::Study::IsModified ( )

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

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

Returns the list of SObjects which refers to anObject.

string SALOMEDS::Study::GetLastModificationDate ( )

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

ListOfDates SALOMEDS::Study::GetModificationsDate ( )

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 )

Converts an object into IOR.
Returns:
IOR

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

Converts IOR into an object.
Returns:
An object

UseCaseBuilder SALOMEDS::Study::GetUseCaseBuilder ( )

Gets a new UseCaseBuilder.

void SALOMEDS::Study::Close ( )

Closes the components in the study, removes itself from the StudyManager.

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

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

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

Functions for internal usage only

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

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

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

boolean SALOMEDS::Study::DumpStudy ( in string thePath,

in string theBaseName,

in boolean isPublished

)

AttributeParameter SALOMEDS::Study::GetCommonParameters ( in string theID,

in long theSavePoint

)

Returns 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

)

Returns 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 theID,

in string theModuleName

)

Returns a default Python script to restore visual parameters for given theModuleName.
Parameters:

theID identifies a common parameters set (Example: "Interface Applicative")

theModuleName is a name of the module (Example: "Geometry")

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

Field Documentation

attribute string SALOMEDS::Study::Name

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

attribute short SALOMEDS::Study::StudyId

This is equivalent to the methods setID() & getID()

attribute boolean SALOMEDS::Study::IsSaved

Determines whether the study has been saved

attribute string SALOMEDS::Study::URL

Determines the file where the study has been saved

SALOMEDS::Study Interface Reference

Public Types

Public Member Functions

Data Fields

Data Structures

Detailed Description

Member Typedef Documentation

Member Function Documentation

Field Documentation