-// Copyright (C) 2007-2014 CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2020 CEA/DEN, EDF R&D, OPEN CASCADE
//
// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
{
/*! \brief Name of the file in which the %Study is saved.
*/
- typedef string URL;
+ typedef wstring URLPath;
/*! \brief Main identifier of an object in %SALOME application
*/
*/
typedef string SalomeReference;
-/*! \brief List of the names of studies which are currently open in this %SALOME session.
-
-Since %SALOME is a multi-study application, it allows to open a lot of studies
-during each working session.
-*/
- typedef sequence<string> ListOfOpenStudies;
//! List of file names
typedef sequence<string> ListOfFileNames;
//! List of modification dates of a study
interface GenericAttribute;
interface Study;
- interface StudyManager;
interface StudyBuilder;
interface SObject;
interface SComponent;
//! Exception indicating that this feature hasn't been implemented in %SALOME application.
exception NotImplemented {};
+ //==========================================================================
+/*! \brief %Study Builder Interface
- //===========================================================================
- /*! \brief %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
- <BR><VAR>The Path </VAR>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 '/'.
- <BR><VAR>The Context</VAR> is the current directory of an object.</P>
+ The purpose of the Builder is to add and/or remove objects and attributes.
+ A %StudyBuilder is linked to a %Study. A
+ command management is provided for the undo/redo functionalities.
+ \note
+ <BR><VAR>The Tag</VAR> of an item in %SALOME application is a symbolic description of
+ item's position in the tree-type structure of the browser. In general it has the following
+ form: <TT>0:2:1:1</TT>
*/
+ //==========================================================================
- interface Study
+ interface StudyBuilder
{
+/*! \brief %LockProtection Exception
-//! Invalid study context
- exception StudyInvalidContext {};
-//! Invalid study component
- exception StudyInvalidComponent {};
-//! Invalid directory of the %study exception
- exception StudyInvalidDirectory {};
-//! Exception pointing that this name of the study has already been used.
- exception StudyNameAlreadyUsed {};
-//! study object already exists
- exception StudyObjectAlreadyExists {};
-//! Invalid name of the %study exception
- exception StudyNameError {};
-//! Invalid study comment
- exception StudyCommentError {};
+ This exception is raised while attempting to modify a locked %study.
+*/
+ exception LockProtection {};
+/*! \brief Creation of a new %SComponent.
-/*! \brief The name of the %Study
+ Creates a new %SComponent
+ \param ComponentDataType Data type of the %SComponent which will be created.
+
+<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
- This is equivalent to the methods setName() & getName()
*/
- attribute string Name; // equivalent to setName() & getName()
-/*! \brief The ID of the %Study
+ SComponent NewComponent(in string ComponentDataType) raises(LockProtection);
+
+/*! \brief Definition of the instance to the %SComponent
- This is equivalent to the methods setID() & getID()
+ Defines the instance to the %SComponent.
*/
- attribute short StudyId;
-//! Sequence containing %SObjects
- typedef sequence<SObject> ListOfSObject;
-//! Get the persistent reference to the %Study.
- PersistentReference GetPersistentReference();
-//! Get a transient reference to the %Study.
- SalomeReference GetTransientReference();
+ void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR) raises(LockProtection);
-/*! \brief indicate whether the %Study is empty
+/*! \brief Deletion of a %SComponent
- \return True if the %Study is empty
+ Removes a %SComponent.
*/
- boolean IsEmpty();
-/*! \brief Find a %SComponent by its name.
+ void RemoveComponent(in SComponent aComponent) raises(LockProtection);
- \param aComponentName It's a string value in the Comment Attribute of the Component,
- which is looked for, defining the data type of this Component.
+/*! \brief Creation of a new %SObject
-<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
+ Creates a new %SObject under a definite father %SObject.
-*/
- SComponent FindComponent (in string aComponentName);
+ \param theFatherObject The father %SObject under which this one should be created.
+ \return New %SObject
+
+<em>See \ref example18 for an example of this method usage in batchmode of %SALOME application.</em>
-/*! \brief Find a %SComponent by ID of the according %SObject
*/
- SComponent FindComponentID(in ID aComponentID);
-/*! \brief Find a %SObject by the Name Attribute of this %SObject
- \param anObjectName String parameter defining the name of the object
- \return The obtained %SObject
+ SObject NewObject (in SObject theFatherObject) raises(LockProtection);
-<em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
-*/
- SObject FindObject (in string anObjectName);
-/*! \brief Find a %SObject by its ID
+/*! \brief Creation of a new %SObject with a definite %tag
- \param aObjectID This parameter defines the ID of the required object
- \return The obtained %SObject
-*/
- SObject FindObjectID (in ID aObjectID);
-/*! \brief Create a %SObject by its ID
+ Creates a new %SObject with a definite %tag.
- \param aObjectID This parameter defines the ID of the required object
- \return The created %SObject
-*/
- SObject CreateObjectID (in ID aObjectID);
-/*! \brief Find a %SObject by IOR of the object belonging to this %SObject.
+ \param atag Long value corresponding to the tag of the new %SObject.
+ \return New %SObject
- \param anObjectName This parameter defines the IOR of the object
- \return The obtained %SObject
*/
- SObject FindObjectIOR (in ID aObjectIOR);
-/*! \brief Find in the study all %SObjects produced by a given %Component.
+ SObject NewObjectToTag (in SObject theFatherObject, in long atag) raises(LockProtection);
+/*! \brief Deletion of the %SObject
- \param anObjectName The Name Attribute of the searched %SObjects should correspond to <VAR>anObjectName</VAR>.
- \param aComponentName The name of the component, which objects are searched for.
-*/
- ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName);
-/*! \brief Find a %SObject by the path to it.
+ Removes a %SObject from the %StudyBuilder.
- \param thePath The path to the required %SObject.
- \return The obtained %SObject.
+ \param anObject The %SObject to be deleted.
*/
- SObject FindObjectByPath(in string thePath);
-/*! \brief Get the path to the %SObject.
+ void RemoveObject (in SObject anObject) raises(LockProtection);
+/*! \brief Deletion of the %SObject with all his child objects.
+
+ Removes the %SObject with all his child objects.
+
+ \param anObject The %SObject to be deleted with all child objects.
*/
- string GetObjectPath(in Object theObject);
+ void RemoveObjectWithChildren(in SObject anObject) raises(LockProtection);
-/*! \brief Set the context of the %Study.
+/*!
+ Loads a %SComponent.
- \param thePath String parameter defining the context of the study.
+<em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
-<em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
-*/
- void SetContext(in string thePath);
-/*! \brief Get the context of the %Study.
-
-<em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
*/
- string GetContext();
-/*! \brief Get a list of names of objects corresponding to the context.
+ void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
+/*!
+ Loads a %SObject.
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
+ \param sco %SObject to be loaded.
*/
- ListOfStrings GetObjectNames(in string theContext);
-/*! \brief Get a list of names of directories and subdirectories corresponding to the context.
+ void Load (in SObject sco);
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
-*/
- ListOfStrings GetDirectoryNames(in string theContext);
-/*! \brief Get a list of names of Files corresponding to the context.
+/*! \brief Looking for or creating an attribute assigned to the %SObject
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
-*/
- ListOfStrings GetFileNames(in string theContext);
-/*! \brief Get a list of names of Components corresponding to the context.
+ Allows to find or create an attribute of a specific type which is assigned to the object.
+ \param anObject The %SObject corresponding to the attribute which is looked for.
+ \param aTypeOfAttribute Type of the attribute.
- \note If the parameter <VAR>theContext</VAR> is empty, then the current context will be used.
+<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
*/
- ListOfStrings GetComponentNames(in string theContext);
-/*! \brief Create a new iterator of child levels of the given %SObject.
- \param aSO The given %SObject
- \return A new iterator of child levels of the given %SObject.
-*/
- ChildIterator NewChildIterator(in SObject aSO);
+ GenericAttribute FindOrCreateAttribute(in SObject anObject,
+ in string aTypeOfAttribute) raises(LockProtection);
-/*! \brief Create a new iterator of the %SComponents.
+/*! \brief Looking for an attribute assigned to a %SObject
- \return A new iterator of the %SComponents.
-*/
- SComponentIterator NewComponentIterator();
+ Allows to find an attribute of a specific type which is assigned to the object.
+ \param anObject The %SObject corresponding to the attribute which is looked for.
+ \param aTypeOfAttribute Type of the attribute.
+ \param anAttribute Where the attribute is placed if it's found.
+ \return True if it finds an attribute.
+ */
-/*! \brief Create a new %StudyBuilder to add or modify an object in the study.
+ boolean FindAttribute(in SObject anObject,
+ out GenericAttribute anAttribute,
+ in string aTypeOfAttribute);
+/*! \brief Deleting the attribute assigned to the %SObject
- \return A new %StudyBuilder.
+ Removes the attribute of a specific type which is assigned to the object.
+ \param anObject The %SObject corresponding to the attribute.
+ \param aTypeOfAttribute Type of the attribute.
-<em>See \ref example20 for an example of this method usage in batchmode of %SALOME application.</em>
+<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
+*/
+ void RemoveAttribute(in SObject anObject,
+ in string aTypeOfAttribute) raises(LockProtection);
+/*!
+ Adds a reference between %anObject and %theReferencedObject.
+ \param anObject The %SObject which will get a reference
+ \param theReferencedObject The %SObject having a reference
*/
- StudyBuilder NewBuilder() ;
-/*! \brief Labels dependency
- Updates the map with IOR attribute. It's an inner method used for optimization.
+ void Addreference(in SObject anObject,
+ in SObject theReferencedObject) ;
+
+/*!
+ Removes a reference from %anObject to another object.
+ \param anObject The %SObject which contains a reference
*/
- void UpdateIORLabelMap(in string anIOR, in string anEntry);
-/*! \brief Getting properties of the study
+ void RemoveReference(in SObject anObject) ;
- Returns the attribute, which contains the properties of this study.
+/*! \brief Identification of the %SObject's substructure.
-<em>See \ref example20 for an example of this method usage in batchmode of %SALOME application.</em>
+ Identification of the %SObject's substructure by GUID.
-*/
- AttributeStudyProperties GetProperties();
-/*! \brief Indicate whether the %study has been saved
-*/
- attribute boolean IsSaved;
-/*! \brief Indicate whether the %study has been modified and not saved.
- Returns True if the %study has been modified and not saved.
+ \param anObject The %SObject which will be identified
+ \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
*/
- boolean IsModified();
+ void SetGUID(in SObject anObject, in string theGUID) raises(LockProtection);
+/*!
+Searches for a definite %SObject with a definite GUID and returns True if it finds it.
-/*! \brief Mark the %study as being modified and not saved.
+\param anObject A definite %SObject which will be identified
+\param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
*/
- void Modified();
+ boolean IsGUID(in SObject anObject, in string theGUID);
-/*! \brief Indicate the file where the %study has been saved
-*/
- attribute string URL;
+/*! \brief Creation of a new command
-/*! \brief List of %SObjects
+ Creates a new command which can contain several different actions.
+
+<em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
- Returns the list of %SObjects which refers to %anObject.
*/
- ListOfSObject FindDependances(in SObject anObject);
+ void NewCommand(); // command management
+/*! \brief Execution of the command
-/*! \brief The date of the last saving of the study
+ Commits all actions declared within this command.
- Returns the date of the last saving of study with format: "DD/MM/YYYY HH:MM"
-*/
- string GetLastModificationDate();
-/*! \brief The list of modification dates of the study
+ \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
- Returns the list of modification dates (without creation date) with format "DD/MM/YYYY HH:MM".
- Note : the first modification begins the list.
-*/
- ListOfDates GetModificationsDate();
-/*! \brief Object conversion.
+<em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
- Converts an object into IOR.
- \return IOR
*/
- string ConvertObjectToIOR(in Object theObject);
-/*! \brief Object conversion.
-
- Converts IOR into an object.
- \return An object
+ void CommitCommand() raises(LockProtection); // command management
+/*!
+ Returns True if at this moment there is a command under execution.
*/
- Object ConvertIORToObject(in string theIOR);
+ boolean HasOpenCommand();
+/*! \brief Cancellation of the command
-/*! \brief Get a new %UseCaseBuilder.
-*/
- UseCaseBuilder GetUseCaseBuilder();
+ Cancels all actions declared within the command.
-/*! \brief Close the components in the study, remove itself from the %StudyManager.
+<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
*/
- void Close();
+ void AbortCommand(); // command management
+/*! \brief Undolimit
-/*! \brief Enable (if isEnabled = True)/disable automatic addition of new %SObjects to the use case.
+ The number of actions which can be undone
*/
- void EnableUseCaseAutoFilling(in boolean isEnabled);
+ attribute long UndoLimit;
+/*! \brief Undo method
-/*!
- Functions for internal usage only
-*/
- void AddPostponed(in string theIOR);
+ Cancels all actions of the last command.
- void AddCreatedPostponed(in string theIOR);
+ \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
- void RemovePostponed(in long theUndoLimit);
+<em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
- void UndoPostponed(in long theWay);
+*/
+ void Undo() raises (LockProtection);
+/*! \brief Redo method
- boolean DumpStudy(in string thePath,
- in string theBaseName,
- in boolean isPublished,
- in boolean isMultiFile);
+ Redoes all actions of the last command.
-/*! \brief Get an AttributeParameter used to store common parameters for given %theSavePoint.
+\exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
+
+<em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
- \param theID identifies a common parameters set (Example: "Interface Applicative")
- \param theSavePoint is number of a set of parameters as there can be several sets
*/
- AttributeParameter GetCommonParameters(in string theID, in long theSavePoint);
+ void Redo() raises (LockProtection);
+/*!
+ Returns True if at this moment there are any actions which can be canceled.
-/*! \brief Get an AttributeParameter used to store parameters for given %theModuleName.
+<em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
- \param theID identifies a common parameters set (Example: "Interface Applicative")
- \param theModuleName is a name of the module (Example: "Geometry")
- \param theSavePoint is number of a set of parameters as there can be several sets
*/
- AttributeParameter GetModuleParameters(in string theID, in string theModuleName, in long theSavePoint);
-
+ boolean GetAvailableUndos();
+/*!
+ Returns True if at this moment there are any actions which can be redone.
-/*! \brief Get a default Python script to restore visual parameters for given %theModuleName.
+<em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
- \param theModuleName is a name of the module (Example: "Geometry")
- \param indent is a string to use for script indentation
*/
- string GetDefaultScript(in string theModuleName, in string indent);
-
+ boolean GetAvailableRedos();
/*!
- Private method, returns an implementation of this Study.
- \param theHostname is a hostname of the caller
- \param thePID is a process ID of the caller
- \param isLocal is set True if the Study is launched locally with the caller
-*/
- long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
+ Puts name attribute with the given string value to the given %SObject
+ \param theSO Existing SObject to set name attribute.
+ \param theValue The value to be set to the name attribute.
+*/
+ void SetName(in SObject theSO, in string theValue) raises (LockProtection);
-/*! \brief Mark this Study as being locked by the given locker.
+/*!
+ Puts comment attribute with the given string value to the given %SObject
- The lock status can be checked by method IsStudyLocked
- \param theLockerID identifies a locker of the study can be for ex. IOR of the engine that locks the study.
+ \param theSO Existing SObject to set comment attribute.
+ \param theValue The value to be set to the comment attribute.
*/
- void SetStudyLock(in string theLockerID);
+ void SetComment(in SObject theSO, in string theValue) raises (LockProtection);
-/*! \brief Indicate if the Study is locked
+/*!
+ Puts IOR attribute with the given string value to the given %SObject
- Returns True if the Study was marked locked.
+ \param theSO Existing SObject to set IOR attribute.
+ \param theValue The value to be set to the IOR attribute.
*/
- boolean IsStudyLocked();
+ void SetIOR(in SObject theSO, in string theValue) raises (LockProtection);
+ };
-/*! \brief Mark this Study as being unlocked by the given locker.
+ //===========================================================================
+ /*! \brief %Study Interface
- The lock status can be checked by method IsStudyLocked
- \param theLockerID identifies a locker of the study can be for ex. IOR of the engine that unlocks the study.
+ 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
+ <BR><VAR>The Path </VAR>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 '/'.
+ <BR><VAR>The Context</VAR> is the current directory of an object.</P>
*/
- void UnLockStudy(in string theLockerID);
-/*! \brief Get the list of IDs of the Study's lockers.
-*/
- ListOfStrings GetLockerID();
+ interface Study
+ {
-/*! \brief Create real variable with Name theVarName and value theValue
+//! Invalid study reference
+ exception StudyInvalidReference {};
+//! Invalid study component
+ exception StudyInvalidComponent {};
+//! Invalid directory of the %study exception
+ exception StudyInvalidDirectory {};
+//! Exception pointing that this name of the study has already been used.
+ exception StudyNameAlreadyUsed {};
+//! study object already exists
+ exception StudyObjectAlreadyExists {};
+//! Invalid name of the %study exception
+ exception StudyNameError {};
+//! Invalid study comment
+ exception StudyCommentError {};
- (or set if variable value into theValue already exists)
- \param theVarName is a name of the variable
- \param theVarName is a value of the variable.
+/*!
+ Determines whether the server has already been loaded or not.
*/
- void SetReal( in string theVarName, in double theValue );
-
-/*! \brief Create integer variable with Name theVarName and value theValue
-
- (or set if variable value into theValue already exists)
- \param theVarName is a name of the variable
- \param theVarName is a value of the variable.
+ void ping();
+ void Shutdown();
+/*!
+ Returns the PID of the server
*/
- void SetInteger( in string theVarName, in long theValue );
-/*! \brief Create boolean variable with Name theVarName and value theValue
+ long getPID();
- (or set if variable value into theValue already exists)
- \param theVarName is a name of the variable
- \param theVarName is a value of the variable.
+/*!
+ Shutdown the Study process.
*/
- void SetBoolean( in string theVarName, in boolean theValue );
+ oneway void ShutdownWithExit();
-/*! \brief Create string variable with Name theVarName and value theValue
+/*! \brief The name of the %Study
- (or set if variable value into theValue already exists)
- \param theVarName is a name of the variable
- \param theVarName is a value of the variable.
+ This is equivalent to the methods setName() & getName()
*/
- void SetString( in string theVarName, in string theValue );
+ attribute wstring Name; // equivalent to getName()
-/*! \brief Set current value as double for string variable
+/*! \brief Indicate the file where the %study has been saved
*/
- void SetStringAsDouble( in string theVarName, in double theValue );
-/*! \brief Get value of a real variable
-
- \param theVarName is a name of the variable.
-*/
- double GetReal( in string theVarName );
+//! Sequence containing %SObjects
+ typedef sequence<SObject> ListOfSObject;
+//! Get the persistent reference to the %Study.
+ PersistentReference GetPersistentReference() raises(StudyInvalidReference);
-/*! \brief Get value of an integer variable
+/*! \brief indicate whether the %Study is empty
- \param theVarName is a name of the variable.
+ \return True if the %Study is empty
*/
- long GetInteger( in string theVarName );
-
-/*! \brief Get value of a boolean variable
+ boolean IsEmpty() raises(StudyInvalidReference);
+/*! \brief Find a %SComponent by its name.
- \param theVarName is a name of the variable.
-*/
- boolean GetBoolean( in string theVarName );
+ \param aComponentName It's a string value in the Comment Attribute of the Component,
+ which is looked for, defining the data type of this Component.
-/*! \brief Get value of a string variable
+<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
- \param theVarName is a name of the variable.
*/
- string GetString( in string theVarName );
-
+ SComponent FindComponent (in string aComponentName) raises(StudyInvalidReference);
-/*! \brief Indicate if a variable is real
-
- Return true if variable is real otherwise return false.
- \param theVarName is a name of the variable.
+/*! \brief Find a %SComponent by ID of the according %SObject
*/
- boolean IsReal( in string theVarName );
+ SComponent FindComponentID(in ID aComponentID) raises(StudyInvalidReference);
+/*! \brief Find a %SObject by the Name Attribute of this %SObject
-/*! \brief Indicate if a variable is integer
+ \param anObjectName String parameter defining the name of the object
+ \return The obtained %SObject
- Return true if variable is integer otherwise return false.
- \param theVarName is a name of the variable.
+<em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
*/
- boolean IsInteger( in string theVarName );
-
-/*! \brief Indicate if a variable is boolean
+ SObject FindObject (in string anObjectName) raises(StudyInvalidReference);
+/*! \brief Find a %SObject by its ID
- Return true if variable is boolean otherwise return false.
- \param theVarName is a name of the variable.
+ \param aObjectID This parameter defines the ID of the required object
+ \return The obtained %SObject
*/
- boolean IsBoolean( in string theVarName );
-
-/*! \brief Indicate if a variable is string
+ SObject FindObjectID (in ID aObjectID) raises(StudyInvalidReference);
+/*! \brief Create a %SObject by its ID
- Return true if variable is string otherwise return false.
- \param theVarName is a name of the variable.
+ \param aObjectID This parameter defines the ID of the required object
+ \return The created %SObject
*/
- boolean IsString( in string theVarName );
-
-/*! \brief Indicate if a variable exists in the study
+ SObject CreateObjectID (in ID aObjectID) raises(StudyInvalidReference);
+/*! \brief Find a %SObject by IOR of the object belonging to this %SObject.
- Return true if variable exists in the study,
- otherwise return false.
- \param theVarName is a name of the variable.
+ \param anObjectName This parameter defines the IOR of the object
+ \return The obtained %SObject
*/
- boolean IsVariable( in string theVarName );
+ SObject FindObjectIOR (in ID aObjectIOR) raises(StudyInvalidReference);
+/*! \brief Find in the study all %SObjects produced by a given %Component.
-/*! \brief Get names of all variables from the study.
+ \param anObjectName The Name Attribute of the searched %SObjects should correspond to <VAR>anObjectName</VAR>.
+ \param aComponentName The name of the component, which objects are searched for.
*/
- ListOfStrings GetVariableNames();
-
-/*! \brief Remove a variable
-
- Remove variable with the specified name from the study with substitution of its value.
+ ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName) raises(StudyInvalidReference);
+/*! \brief Find a %SObject by the path to it.
- \param theVarName Name of the variable.
- \return Status of operation.
+ \param thePath The path to the required %SObject.
+ \return The obtained %SObject.
*/
- boolean RemoveVariable( in string theVarName );
-
-/*! \brief Rename a variable
-
- Rename variable with the specified name within the study.
-
- \param theVarName Name of the variable.
- \param theNewVarName New name for the variable.
- \return Status of operation.
+ SObject FindObjectByPath(in string thePath) raises(StudyInvalidReference);
+/*! \brief Get the path to the %SObject.
*/
- boolean RenameVariable( in string theVarName, in string theNewVarName );
-
-/*! \brief Indicate whether variable is used
+ string GetObjectPath(in Object theObject) raises(StudyInvalidReference);
- Check that variable is used in the study.
+/*! \brief Create a new iterator of child levels of the given %SObject.
- \param theVarName Name of the variable.
- \return Variable usage.
+ \param aSO The given %SObject
+ \return A new iterator of child levels of the given %SObject.
*/
- boolean IsVariableUsed( in string theVarName );
+ ChildIterator NewChildIterator(in SObject aSO) raises(StudyInvalidReference);
-/*! \brief Parse variables used for object creation
+/*! \brief Create a new iterator of the %SComponents.
- \param string with variables, separated by special symbol.
- \return Variables list.
+ \return A new iterator of the %SComponents.
*/
- ListOfListOfStrings ParseVariables( in string theVars );
+ SComponentIterator NewComponentIterator() raises(StudyInvalidReference);
-/*!
- Attach an observer to the Study
+/*! \brief Create a new %StudyBuilder to add or modify an object in the study.
- \param theObserver observer being attached
- \param modify when \c true, observer receives any object's modification events;
- otherwise observer receives object's creation events only
-*/
- void attach(in SALOMEDS::Observer theObserver, in boolean modify);
-/*!
- Detach an observer from the Study
+ \return A new %StudyBuilder.
- \param theObserver observer to be detached
+<em>See \ref example20 for an example of this method usage in batchmode of %SALOME application.</em>
*/
- void detach(in SALOMEDS::Observer theObserver);
- };
-
- //===========================================================================
- /*! \brief %SimanStudy Interface
+ StudyBuilder NewBuilder() raises(StudyInvalidReference);
+/*! \brief Labels dependency
- The Siman (simulation management) study is an interface extension to the %Study
- with functions for working with SIMAN server. Is allows to get data from SIMAN (check-out operation)
- and to store it back (check-in operation).
- This interface is correctly working if SALOME is compiled with SimanIO library, launched with siman
- option and connection to SIMAN server is established and alive. Only one study per application,
- checked out from the SIMAN is SimanStudy. For other studies all functionality is unaccessible.
+ Updates the map with IOR attribute. It's an inner method used for optimization.
*/
+ void UpdateIORLabelMap(in string anIOR, in string anEntry) raises(StudyInvalidReference);
- interface SimanStudy
- {
+/*! \brief Getting properties of the study
-//! No connection with SIMAN server
- exception SimanStudyNoConnection {};
-//! There is no SimanStudy with: study with checked out data.
- exception SimanStudyNotExists {};
+ Returns the attribute, which contains the properties of this study.
-/*! \brief The ID of the study in SIMAN server
+<em>See \ref example20 for an example of this method usage in batchmode of %SALOME application.</em>
- This is equivalent to the methods setStudyId() & getStudyId()
*/
- attribute string StudyId;
-
-/*! \brief The ID of the scenario in SIMAN server
-
- This is equivalent to the methods setScenarioId() & getScenarioId()
+ AttributeStudyProperties GetProperties() raises(StudyInvalidReference);
+/*! \brief Indicate whether the %study has been saved
*/
- attribute string ScenarioId;
-/*! \brief The ID of the user in SIMAN server
+ attribute boolean IsSaved;
+/*! \brief Indicate whether the %study has been modified and not saved.
- This is equivalent to the methods setUserId() & getUserId()
+ Returns True if the %study has been modified and not saved.
*/
- attribute string UserId;
-
-/*! \brief Get data from SIMAN and put it to the given study
-
- This method is called for just created study to make it referenced
- by this Siman study. Also it fills this study by the checked out
- data from SIMAN server.
- Warning: StudyID, ScenarioID and User Id must be set before calling of this method!
+ boolean IsModified() raises(StudyInvalidReference);
- \param theTarget referenced study for checking out
+/*! \brief Mark the %study as being modified and not saved.
*/
- void CheckOut(in Study theTarget);
+ void Modified() raises(StudyInvalidReference);
-/*! \brief Get data from the source study and store in SIMAN
-
- It works only with already checked out study.
- \param theModuleName name of the module the check in must be perfrormed for. If empty, check in is performed for all modules.
+/*! \brief Indicate the file where the %study has been saved
*/
- void CheckIn(in string theModuleName);
+ attribute wstring URL;
-/*! \brief Returns the %Study with checked out data
+/*! \brief List of %SObjects
- If study is null, there is no such study in this application instance, or Salome was
- launched without siman option.
+ Returns the list of %SObjects which refers to %anObject.
*/
- Study getReferencedStudy();
+ ListOfSObject FindDependances(in SObject anObject) raises(StudyInvalidReference);
-};
-
- //==========================================================================
-/*! \brief %Study Builder Interface
+/*! \brief The date of the last saving of the study
- The purpose of the Builder is to add and/or remove objects and attributes.
- A %StudyBuilder is linked to a %Study. A
- command management is provided for the undo/redo functionalities.
- \note
- <BR><VAR>The Tag</VAR> of an item in %SALOME application is a symbolic description of
- item's position in the tree-type structure of the browser. In general it has the following
- form: <TT>0:2:1:1</TT>
+ Returns the date of the last saving of study with format: "DD/MM/YYYY HH:MM"
*/
- //==========================================================================
-
- interface StudyBuilder
- {
-/*! \brief %LockProtection Exception
+ string GetLastModificationDate() raises(StudyInvalidReference);
+/*! \brief The list of modification dates of the study
- This exception is raised while attempting to modify a locked %study.
+ Returns the list of modification dates (without creation date) with format "DD/MM/YYYY HH:MM".
+ Note : the first modification begins the list.
*/
- exception LockProtection {};
-/*! \brief Creation of a new %SComponent.
-
- Creates a new %SComponent
- \param ComponentDataType Data type of the %SComponent which will be created.
-
-<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
+ ListOfDates GetModificationsDate() raises(StudyInvalidReference);
+/*! \brief Object conversion.
+ Converts an object into IOR.
+ \return IOR
*/
- SComponent NewComponent(in string ComponentDataType) raises(LockProtection);
-/*! \brief Definition of the instance to the %SComponent
+ string ConvertObjectToIOR(in Object theObject);
+/*! \brief Object conversion.
- Defines the instance to the %SComponent.
+ Converts IOR into an object.
+ \return An object
*/
- void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR) raises(LockProtection);
-
-/*! \brief Deletion of a %SComponent
+ Object ConvertIORToObject(in string theIOR);
- Removes a %SComponent.
+/*! \brief Get a new %UseCaseBuilder.
*/
- void RemoveComponent(in SComponent aComponent) raises(LockProtection);
-
-/*! \brief Creation of a new %SObject
-
- Creates a new %SObject under a definite father %SObject.
-
- \param theFatherObject The father %SObject under which this one should be created.
- \return New %SObject
-
-<em>See \ref example18 for an example of this method usage in batchmode of %SALOME application.</em>
+ UseCaseBuilder GetUseCaseBuilder() raises(StudyInvalidReference);
+/*! \brief Clear a study object
*/
+ void Clear() raises(StudyInvalidReference);
- SObject NewObject (in SObject theFatherObject) raises(LockProtection);
-
-/*! \brief Creation of a new %SObject with a definite %tag
-
- Creates a new %SObject with a definite %tag.
+/*! \brief Initialization a study object
+*/
+ void Init() raises(StudyInvalidReference);
- \param atag Long value corresponding to the tag of the new %SObject.
- \return New %SObject
+/*! \brief Open a study by url
+ Reads and activates the structure of the study %Objects.
+ \param aStudyUrl The path to the study
*/
- SObject NewObjectToTag (in SObject theFatherObject, in long atag) raises(LockProtection);
-/*! \brief Deletion of the %SObject
+ boolean Open (in URLPath aStudyUrl) raises (SALOME::SALOME_Exception);
- Removes a %SObject from the %StudyBuilder.
+/*! \brief Check if study can be opened
- \param anObject The %SObject to be deleted.
+ Tries to open and read given url.
+ \param aStudyUrl The path to the study
*/
- void RemoveObject (in SObject anObject) raises(LockProtection);
-/*! \brief Deletion of the %SObject with all his child objects.
+ boolean CanOpen (in URLPath aStudyUrl);
- Removes the %SObject with all his child objects.
+/*! \brief Saving the study in a file (or files).
- \param anObject The %SObject to be deleted with all child objects.
+ Saves a study.
+ \param theMultiFile If this parameter is True the study will be saved in several files.
+ \param theASCII If this parameter is True the study will be saved in ASCII format, otherwise in HDF format.
*/
- void RemoveObjectWithChildren(in SObject anObject) raises(LockProtection);
+ boolean Save(in boolean theMultiFile, in boolean theASCII) raises(StudyInvalidReference);
-/*!
- Loads a %SComponent.
+/*! \brief Saving the study in a specified file (or files).
-<em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
+ Saves the study in a specified file (or files).
+ \param aUrl The path to the definite file in which the study will be saved
+ \param theMultiFile If this parameter is True the study will be saved in several files.
+ \param theASCII If this parameter is True the study will be saved in ASCII format, otherwise in HDF format.
+<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
*/
- void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception);
+ boolean SaveAs(in URLPath aUrl, // if the file already exists
+ in boolean theMultiFile, // overwrite (as option)
+ in boolean theASCII)
+ raises(StudyInvalidReference);
/*!
- Loads a %SObject.
-
- \param sco %SObject to be loaded.
+ Returns True, if the given %SObject can be copied to the clipboard.
*/
- void Load (in SObject sco);
-
-/*! \brief Looking for or creating an attribute assigned to the %SObject
-
- Allows to find or create an attribute of a specific type which is assigned to the object.
- \param anObject The %SObject corresponding to the attribute which is looked for.
- \param aTypeOfAttribute Type of the attribute.
-
-<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
+ boolean CanCopy(in SObject theObject) raises(StudyInvalidReference);
+/*!
+ Returns True, if the given %SObject is copied to the clipboard.
+ \param theObject The %SObject which will be copied
*/
-
- GenericAttribute FindOrCreateAttribute(in SObject anObject,
- in string aTypeOfAttribute) raises(LockProtection);
-
-/*! \brief Looking for an attribute assigned to a %SObject
-
- Allows to find an attribute of a specific type which is assigned to the object.
- \param anObject The %SObject corresponding to the attribute which is looked for.
- \param aTypeOfAttribute Type of the attribute.
- \param anAttribute Where the attribute is placed if it's found.
- \return True if it finds an attribute.
- */
-
- boolean FindAttribute(in SObject anObject,
- out GenericAttribute anAttribute,
- in string aTypeOfAttribute);
-/*! \brief Deleting the attribute assigned to the %SObject
-
- Removes the attribute of a specific type which is assigned to the object.
- \param anObject The %SObject corresponding to the attribute.
- \param aTypeOfAttribute Type of the attribute.
-
-<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
+ boolean Copy(in SObject theObject) raises(StudyInvalidReference);
+/*!
+ Returns True, if the object from the clipboard can be pasted to the given %SObject.
+ \param theObject The %SObject stored in the clipboard.
*/
- void RemoveAttribute(in SObject anObject,
- in string aTypeOfAttribute) raises(LockProtection);
+ boolean CanPaste(in SObject theObject) raises(StudyInvalidReference);
/*!
- Adds a reference between %anObject and %theReferencedObject.
- \param anObject The %SObject which will get a reference
- \param theReferencedObject The %SObject having a reference
+ Returns the %SObject in which the object from the clipboard was pasted to.
+ \param theObject The %SObject which will be pasted
+ \exception SALOMEDS::StudyBuilder::LockProtection This exception is raised, when trying to paste
+ an object into a study, which is protected for modifications.
*/
+ SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
- void Addreference(in SObject anObject,
- in SObject theReferencedObject) ;
+/*! \brief Enable (if isEnabled = True)/disable automatic addition of new %SObjects to the use case.
+*/
+ void EnableUseCaseAutoFilling(in boolean isEnabled) raises(StudyInvalidReference);
/*!
- Removes a reference from %anObject to another object.
- \param anObject The %SObject which contains a reference
+ Functions for internal usage only
*/
+ void AddPostponed(in string theIOR) raises(StudyInvalidReference);
- void RemoveReference(in SObject anObject) ;
-
-/*!
- Adds a directory in the %Study.
- \param theName String parameter defining the name of the directory.
+ void AddCreatedPostponed(in string theIOR) raises(StudyInvalidReference);
-<em>See \ref example23 for an example of this method usage in batchmode of %SALOME application.</em>
+ void RemovePostponed(in long theUndoLimit) raises(StudyInvalidReference);
-*/
- void AddDirectory(in string theName) raises(LockProtection);
+ void UndoPostponed(in long theWay) raises(StudyInvalidReference);
-/*! \brief Identification of the %SObject's substructure.
+ boolean DumpStudy(in string thePath,
+ in string theBaseName,
+ in boolean isPublished,
+ in boolean isMultiFile) raises(StudyInvalidReference);
- Identification of the %SObject's substructure by GUID.
+/*! \brief Returns the folder of the python script which is currently dumped.
+*/
+ string GetDumpPath();
+/*! \brief Get an AttributeParameter used to store common parameters for given %theSavePoint.
- \param anObject The %SObject which will be identified
- \param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
+ \param theID identifies a common parameters set (Example: "Interface Applicative")
+ \param theSavePoint is number of a set of parameters as there can be several sets
*/
+ AttributeParameter GetCommonParameters(in string theID, in long theSavePoint) raises(StudyInvalidReference);
- void SetGUID(in SObject anObject, in string theGUID) raises(LockProtection);
-/*!
-Searches for a definite %SObject with a definite GUID and returns True if it finds it.
+/*! \brief Get an AttributeParameter used to store parameters for given %theModuleName.
-\param anObject A definite %SObject which will be identified
-\param theGUID GUID has the following format "00000000-0000-0000-0000-000000000000"
+ \param theID identifies a common parameters set (Example: "Interface Applicative")
+ \param theModuleName is a name of the module (Example: "Geometry")
+ \param theSavePoint is number of a set of parameters as there can be several sets
*/
- boolean IsGUID(in SObject anObject, in string theGUID);
+ AttributeParameter GetModuleParameters(in string theID, in string theModuleName, in long theSavePoint) raises(StudyInvalidReference);
-/*! \brief Creation of a new command
- Creates a new command which can contain several different actions.
-
-<em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
+/*! \brief Get a default Python script to restore visual parameters for given %theModuleName.
+ \param theModuleName is a name of the module (Example: "Geometry")
+ \param indent is a string to use for script indentation
*/
- void NewCommand(); // command management
-/*! \brief Execution of the command
+ string GetDefaultScript(in string theModuleName, in string indent) raises(StudyInvalidReference);
- Commits all actions declared within this command.
+/*!
+ Private method, returns an implementation of this Study.
+ \param theHostname is a hostname of the caller
+ \param thePID is a process ID of the caller
+ \param isLocal is set True if the Study is launched locally with the caller
+*/
+ long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
- \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
-<em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
+/*! \brief Mark this Study as being locked by the given locker.
+ The lock status can be checked by method IsStudyLocked
+ \param theLockerID identifies a locker of the study can be for ex. IOR of the engine that locks the study.
*/
- void CommitCommand() raises(LockProtection); // command management
-/*!
- Returns True if at this moment there is a command under execution.
-*/
- boolean HasOpenCommand();
-/*! \brief Cancelation of the command
+ void SetStudyLock(in string theLockerID) raises(StudyInvalidReference);
- Cancels all actions declared within the command.
-
-<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
-*/
- void AbortCommand(); // command management
-/*! \brief Undolimit
+/*! \brief Indicate if the Study is locked
- The number of actions which can be undone
+ Returns True if the Study was marked locked.
*/
- attribute long UndoLimit;
-/*! \brief Undo method
+ boolean IsStudyLocked() raises(StudyInvalidReference);
- Cancels all actions of the last command.
-
- \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
+/*! \brief Mark this Study as being unlocked by the given locker.
-<em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
+ The lock status can be checked by method IsStudyLocked
+ \param theLockerID identifies a locker of the study can be for ex. IOR of the engine that unlocks the study.
+*/
+ void UnLockStudy(in string theLockerID) raises(StudyInvalidReference);
+/*! \brief Get the list of IDs of the Study's lockers.
*/
- void Undo() raises (LockProtection);
-/*! \brief Redo method
+ ListOfStrings GetLockerID() raises(StudyInvalidReference);
- Redoes all actions of the last command.
+/*! \brief Create real variable with Name theVarName and value theValue
-\exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications.
+ (or set if variable value into theValue already exists)
+ \param theVarName is a name of the variable
+ \param theVarName is a value of the variable.
+*/
+ void SetReal( in string theVarName, in double theValue ) raises(StudyInvalidReference);
-<em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
+/*! \brief Create integer variable with Name theVarName and value theValue
+ (or set if variable value into theValue already exists)
+ \param theVarName is a name of the variable
+ \param theVarName is a value of the variable.
*/
- void Redo() raises (LockProtection);
-/*!
- Returns True if at this moment there are any actions which can be canceled.
-
-<em>See \ref example16 for an example of this method usage in batchmode of %SALOME application.</em>
+ void SetInteger( in string theVarName, in long theValue ) raises(StudyInvalidReference);
+/*! \brief Create boolean variable with Name theVarName and value theValue
+ (or set if variable value into theValue already exists)
+ \param theVarName is a name of the variable
+ \param theVarName is a value of the variable.
*/
- boolean GetAvailableUndos();
-/*!
- Returns True if at this moment there are any actions which can be redone.
+ void SetBoolean( in string theVarName, in boolean theValue ) raises(StudyInvalidReference);
-<em>See \ref example3 for an example of this method usage in batchmode of %SALOME application.</em>
+/*! \brief Create string variable with Name theVarName and value theValue
+ (or set if variable value into theValue already exists)
+ \param theVarName is a name of the variable
+ \param theVarName is a value of the variable.
*/
- boolean GetAvailableRedos();
-/*!
- Puts name attribute with the given string value to the given %SObject
+ void SetString( in string theVarName, in string theValue ) raises(StudyInvalidReference);
- \param theSO Existing SObject to set name attribute.
- \param theValue The value to be set to the name attribute.
+/*! \brief Set current value as double for string variable
*/
- void SetName(in SObject theSO, in string theValue) raises (LockProtection);
+ void SetStringAsDouble( in string theVarName, in double theValue ) raises(StudyInvalidReference);
-/*!
- Puts comment attribute with the given string value to the given %SObject
+/*! \brief Get value of a real variable
- \param theSO Existing SObject to set comment attribute.
- \param theValue The value to be set to the comment attribute.
+ \param theVarName is a name of the variable.
*/
- void SetComment(in SObject theSO, in string theValue) raises (LockProtection);
+ double GetReal( in string theVarName ) raises(StudyInvalidReference);
-/*!
- Puts IOR attribute with the given string value to the given %SObject
+/*! \brief Get value of an integer variable
- \param theSO Existing SObject to set IOR attribute.
- \param theValue The value to be set to the IOR attribute.
+ \param theVarName is a name of the variable.
*/
- void SetIOR(in SObject theSO, in string theValue) raises (LockProtection);
- };
-
- //==========================================================================
-/*! \brief %Study Manager interface
+ long GetInteger( in string theVarName ) raises(StudyInvalidReference);
- 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.
-*/
- //==========================================================================
+/*! \brief Get value of a boolean variable
- interface StudyManager
- {
-/*!
- Determines whether the server has already been loaded or not.
+ \param theVarName is a name of the variable.
*/
- void ping();
+ boolean GetBoolean( in string theVarName ) raises(StudyInvalidReference);
- void Shutdown();
+/*! \brief Get value of a string variable
-/*!
- Returns the PID of the server
+ \param theVarName is a name of the variable.
*/
- long getPID();
-
-/*!
- Shutdown the StudyManager process.
-*/
- oneway void ShutdownWithExit();
-
-/*! \brief Creation of a new study
-
- Creates a new study with a definite name.
+ string GetString( in string theVarName ) raises(StudyInvalidReference);
- \param study_name String parameter defining the name of the study
-<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
+/*! \brief Indicate if a variable is real
+ Return true if variable is real otherwise return false.
+ \param theVarName is a name of the variable.
*/
- Study NewStudy(in string study_name);
+ boolean IsReal( in string theVarName ) raises(StudyInvalidReference);
-/*! \brief Open a study
-
- Reads and activates the structure of the study %Objects.
- \param aStudyUrl The path to the study
- \warning This method doesn't activate the corba objects. Only a component can do it.
+/*! \brief Indicate if a variable is integer
-<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
+ Return true if variable is integer otherwise return false.
+ \param theVarName is a name of the variable.
*/
- Study Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception);
+ boolean IsInteger( in string theVarName ) raises(StudyInvalidReference);
-/*! \brief Closing the study
+/*! \brief Indicate if a variable is boolean
- Closes a study.
+ Return true if variable is boolean otherwise return false.
+ \param theVarName is a name of the variable.
*/
- void Close(in Study aStudy);
-/*! \brief Saving the study in a HDF file (or files).
+ boolean IsBoolean( in string theVarName ) raises(StudyInvalidReference);
- Saves a study.
+/*! \brief Indicate if a variable is string
- \param theMultiFile If this parameter is True the study will be saved in several files.
+ Return true if variable is string otherwise return false.
+ \param theVarName is a name of the variable.
+*/
+ boolean IsString( in string theVarName ) raises(StudyInvalidReference);
-<em>See \ref example19 for an example of this method usage in batchmode of %SALOME application.</em>
+/*! \brief Indicate if a variable exists in the study
+ Return true if variable exists in the study,
+ otherwise return false.
+ \param theVarName is a name of the variable.
*/
- boolean Save(in Study aStudy, in boolean theMultiFile);
-/*! \brief Saving a study in a ASCII file (or files).
+ boolean IsVariable( in string theVarName ) raises(StudyInvalidReference);
- Saves a study in an ASCII format file (or files).
- \param theMultiFile If this parameter is True the study will be saved in several files.
+/*! \brief Get names of all variables from the study.
*/
- boolean SaveASCII(in Study aStudy, in boolean theMultiFile);
-/*! \brief Saving the study in a specified HDF file (or files).
-
- Saves the study in a specified file (or files).
- \param aUrl The path to the definite file in whcih the study will be saved
- \param aStudy The study which will be saved
- \param theMultiFile If this parameter is True the study will be saved in several files.
+ ListOfStrings GetVariableNames() raises(StudyInvalidReference);
-<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
-*/
- boolean SaveAs(in URL aUrl, // if the file already exists
- in Study aStudy,
- in boolean theMultiFile); // overwrite (as option)
-/*! \brief Saving the study in a specified ASCII file (or files).
+/*! \brief Remove a variable
- Saves the study in a specified ASCII file (or files).
+ Remove variable with the specified name from the study with substitution of its value.
- \param aUrl The path to the definite file in whcih the study will be saved
- \param aStudy The study which will be saved
- \param theMultiFile If this parameter is True the study will be saved in several files.
+ \param theVarName Name of the variable.
+ \return Status of operation.
*/
- boolean SaveAsASCII(in URL aUrl, // if the file already exists
- in Study aStudy,
- in boolean theMultiFile); // overwrite (as option)
-
+ boolean RemoveVariable( in string theVarName ) raises(StudyInvalidReference);
-/*! \brief List of open studies.
+/*! \brief Rename a variable
-Gets the list of open studies
+ Rename variable with the specified name within the study.
- \return A list of open studies in the current session.
+ \param theVarName Name of the variable.
+ \param theNewVarName New name for the variable.
+ \return Status of operation.
*/
- ListOfOpenStudies GetOpenStudies();
-
-/*! \brief Getting a particular %Study picked by name
+ boolean RenameVariable( in string theVarName, in string theNewVarName ) raises(StudyInvalidReference);
- Activates a particular %Study
- among the session collection picking it by name.
- \param aStudyName The name of the study
-*/
- Study GetStudyByName (in string aStudyName);
+/*! \brief Indicate whether variable is used
-/*! \brief Getting a particular %Study picked by ID
+ Check that variable is used in the study.
- Activates a particular %Study
- among the session collection picking it by ID.
- \param aStudyID The ID of the study
+ \param theVarName Name of the variable.
+ \return Variable usage.
*/
- Study GetStudyByID (in short aStudyID);
+ boolean IsVariableUsed( in string theVarName ) raises(StudyInvalidReference);
- // copy/paste methods
+/*! \brief Parse variables used for object creation
-/*!
- Returns True, if the given %SObject can be copied to the clipboard.
-*/
- boolean CanCopy(in SObject theObject);
-/*!
- Returns True, if the given %SObject is copied to the clipboard.
- \param theObject The %SObject which will be copied
-*/
- boolean Copy(in SObject theObject);
-/*!
- Returns True, if the object from the clipboard can be pasted to the given %SObject.
- \param theObject The %SObject stored in the clipboard.
-*/
- boolean CanPaste(in SObject theObject);
-/*!
- Returns the %SObject in which the object from the clipboard was pasted to.
- \param theObject The %SObject which will be pasted
- \exception SALOMEDS::StudyBuilder::LockProtection This exception is raised, when trying to paste
- an object into a study, which is protected for modifications.
+ \param string with variables, separated by special symbol.
+ \return Variables list.
*/
- SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection);
+ ListOfListOfStrings ParseVariables( in string theVars ) raises(StudyInvalidReference);
-/*! \brief Object conversion.
+/*!
+ Attach an observer to the Study
- Converts an object into IOR.
- \return IOR
-*/
- string ConvertObjectToIOR(in Object theObject);
-/*! \brief Object conversion.
-
- Converts IOR into an object.
- \return An object
+ \param theObserver observer being attached
+ \param modify when \c true, observer receives any object's modification events;
+ otherwise observer receives object's creation events only
*/
- Object ConvertIORToObject(in string theIOR);
-
+ void attach(in SALOMEDS::Observer theObserver, in boolean modify);
/*!
- Private method, returns an implementation of this StudyManager.
- \param theHostname is a hostname of the caller
- \param thePID is a process ID of the caller
- \param isLocal is set True if the StudyManager is launched locally with the caller
-*/
- long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal);
+ Detach an observer from the Study
-/*! \brief Returns the siman study based on the given study.
-
- Creates a new Siman study, or returns just a previously created.
- \return Siman study, or none if it is not siman mode
+ \param theObserver observer to be detached
*/
- SimanStudy GetSimanStudy();
-
+ void detach(in SALOMEDS::Observer theObserver);
};
-
//==========================================================================
/*! \brief %SObject interface
The objects in the %study are built by the %StudyBuilder. The %SObject interface
provides methods for elementary inquiries, like getting an object %ID or its attribuites.
\note
-
+
<BR><VAR>Tag</VAR> of an item in %SALOME application is an integer value uniquely defining an item
in the tree-type data structure.
<BR><VAR>ID</VAR> of an item is a description of item's position in the tree-type data structure.
boolean IsNull();
/*! Gets an object %ID
-
\return ID of the %SObject.
*/
ID GetID();
-/*! Acquisition of the father %Component of the %SObject
+/*! Acquisition of the father %Component of the %SObject
\return The father %Component of the %SObject.
*/
SComponent GetFatherComponent();
-/*! Acquisition of the father %SObject of the %SObject
+/*! Acquisition of the father %SObject of the %SObject
\return the father %SObject of the given %SObject.
*/
SObject GetFather();
-/*! Gets the %tag of a %SObject
+/*! Gets the %tag of a %SObject
\return the %tag of a %SObject.
*/
short Tag();
-/*! Gets the depth of a %SObject
+/*! Returns a tag of the last child %SObject (if any) of this %SObject.
+ Returns zero if this %SObject has no children.
+*/
+ short GetLastChildTag();
+
+/*! Gets the depth of a %SObject
\return the depth of a %SObject.
*/
short Depth();
-/*! Looks for subobjects of a given %SObject.
+/*! Looks for subobjects of a given %SObject.
\param atag Tag of the given %SObject
\return True if it finds a subobject of the %SObject with a definite tag as well as the required subobject.
*/
-
boolean FindSubObject (in long atag, out SObject obj);
-/*! Looks for attributes of a given %SObject
+/*! Looks for attributes of a given %SObject
\param aTypeOfAttribute String value defining the type of the required attribute of the given %SObject.
\return True if it finds an attribute of a definite type of the given %SObject as well as the discovered attribute.
<em>See \ref example1 for an example of this method usage in batchmode of %SALOME application.</em>
*/
boolean FindAttribute(out GenericAttribute anAttribute,
- in string aTypeOfAttribute);
-/*! Looks for a %SObject which the given %SObject refers to.
+ in string aTypeOfAttribute);
+/*! Looks for a %SObject which the given %SObject refers to.
\return The object which the given %SObject refers to as well as True if it finds
this object.
*/
boolean ReferencedObject(out SObject obj); // A REVOIR
-/*! Gets all attributes of a given %SObject
+/*! Gets all attributes of a given %SObject
\return The list of all attributes of the given %SObject.
<em>See \ref example17 for an example of this method usage in batchmode of %SALOME application.</em>
*/
ListOfAttributes GetAllAttributes();
-/*! Gets the study of a given %SObject.
-
- \return The study containing the given %SObject.
-*/
- Study GetStudy();
/*! Gets the CORBA object by its own IOR attribute.
Returns nil, if can't.
-
\return The CORBA object of the %SObject.
*/
Object GetObject();
string Type();
//! Get the class type
- string GetClassType();
-
+ string GetClassType();
+
//! Get SObject
SObject GetSObject();
Adds a child object <VAR>theObject</VAR> to the given father <VAR>theFather</VAR> object in the use case.
*/
boolean AppendTo(in SObject theFather, in SObject theObject);
+/*!
+ Return index of a child among father children
+*/
+ long GetIndexInFather(in SObject theFather, in SObject theObject);
/*!
Inserts in the use case the object <VAR>theFirst</VAR> before the object <VAR>theNext</VAR>.
*/
can be called by any component and which provide the following functionality:
<ul>
<li> publishing in the study of the objects created by a definite component
- <li> saving/loading of the data created by a definite component. These methods are called by the StudyManager when loading/saving a study containing the data created by a definite component.
- <li> transforming of the transient references into persistant references (or vice versa) of the SObjects when saving (or loading) a study
+ <li> saving/loading of the data created by a definite component. These methods are called when loading/saving a study containing the data created by a definite component.
+ <li> transforming of the transient references into persistent references (or vice versa) of the SObjects when saving (or loading) a study
<li> copy/paste common functionality. These methods can be called by any component in order to copy/paste its object created in the study
</ul>
/*! \brief Saving the data produced by a definite component.
- This method is called by the StudyManager when saving a study.
+ This method is called when saving a study.
\param theComponent %SComponent corresponding to this Component
\param theURL The path to the file in which the data will be saved.
\param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files.
/*! \brief Saving the data in ASCII format produced by a definite component.
- This method is called by the StudyManager when saving a study in ASCII format.
+ This method is called when saving a study in ASCII format.
\param theComponent %SComponent corresponding to this Component
\param theURL The path to the file in which the data will be saved.
\param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files.
/*! \brief Loading the data.
- This method is called by the StudyManager when opening a study.
+ This method is called when opening a study.
\param theComponent %SComponent corresponding to this Component
\param theStream The file which contains all data saved by the component on Save method
\param isMultiFile If the value of this boolean parameter is True, the data will be loaded from several files
/*! \brief Loading the data from files in ASCII format.
- This method is called by the StudyManager when opening a study.
+ This method is called when opening a study.
\param theComponent %SComponent corresponding to this Component
\param theStream The file which contains all data saved by the component on Save method
\param isMultiFile If the value of this boolean parameter is True, the data will be loaded from several files
/*! \brief Closing of the study
- This method Close is called by the StudyManager when closing a study.
+ This method Close is called when closing a study.
\param aSComponent The according %SComponent
*/
*/
string IORToLocalPersistentID (in SObject theSObject,
- in string IORString,
- in boolean isMultiFile,
- in boolean isASCII);
+ in string IORString,
+ in boolean isMultiFile,
+ in boolean isASCII);
/*!
Transforms PersistentID into IOR of the object. It is called for each
object in the %study.
*/
string LocalPersistentIDToIOR (in SObject theSObject,
- in string aLocalPersistentID,
- in boolean isMultiFile,
- in boolean isASCII)
+ in string aLocalPersistentID,
+ in boolean isMultiFile,
+ in boolean isASCII)
raises (SALOME::SALOME_Exception);
// Publishing in the study
/*! \brief Publishing in the study
Publishes the given object in the %study, using the algorithm of this component.
- \param theStudy The %study in which the object is published
\param theSObject If this parameter is null the object is published for the first time. Otherwise
this parameter should contain a reference to the object published earlier
\param theObject The object which is published
\return The published %SObject.
*/
- SObject PublishInStudy(in Study theStudy, in SObject theSObject, in Object theObject, in string theName);
+ SObject PublishInStudy(in SObject theSObject, in Object theObject, in string theName);
// copy/paste methods
