X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=idl%2FSALOMEDS.idl;h=955cf78373321a54d1dbb39529f82475ad1b1338;hb=b3fe8a4e22faa6c1e01582ba55818164395d8f31;hp=15e6511642f67b5d8504422b921208160f70e544;hpb=788659d329f8451bd9c2197748003d2dd69b2e85;p=modules%2Fkernel.git diff --git a/idl/SALOMEDS.idl b/idl/SALOMEDS.idl index 15e651164..955cf7837 100644 --- a/idl/SALOMEDS.idl +++ b/idl/SALOMEDS.idl @@ -1,7 +1,9 @@ -// Copyright (C) 2003 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, -// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS -// -// This library is free software; you can redistribute it and/or +// Copyright (C) 2007-2010 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 +// +// This library is free software; you can redistribute it and/or // modify it under the terms of the GNU Lesser General Public // License as published by the Free Software Foundation; either // version 2.1 of the License. @@ -15,20 +17,14 @@ // License along with this library; if not, write to the Free Software // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA // -// See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org -// -// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com // + // File : SALOMEDS.idl // Author : Yves FRICAUD // $Header$ - -/*! \mainpage - \image html Application-About.png -*/ - -/*! - \file SALOMEDS.idl This file contains a set of interfaces used for creation, managment +// +/*! \file SALOMEDS.idl \brief This file contains a set of interfaces used for creation, management and modification of the %Study */ @@ -36,47 +32,45 @@ #define _SALOMEDS_IDL_ #include "SALOME_Exception.idl" +#include "SALOME_GenericObj.idl" -/*! - This package contains the interfaces used for creation, managment +/*! \brief + This package contains the interfaces used for creation, management and modification of the %Study */ module SALOMEDS { -/*! \typedef URL - Name of the file in which the %Study is saved. - +/*! \brief Name of the file in which the %Study is saved. */ typedef string URL; -/*! Main identifier of an object in %SALOME application +/*! \brief Main identifier of an object in %SALOME application */ typedef string ID; -/*! While saving the data, IOR is transformed into persistent reference +/*! \brief While saving the data, IOR is transformed into persistent reference */ typedef string PersistentReference; -/*! IOR of the study in %SALOME application +/*! \brief IOR of the study in %SALOME application */ typedef string SalomeReference; -/*! List of the names of studies which are currently open in this %SALOME session. +/*! \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 ListOfOpenStudies; -/*! List of file names -*/ +//! List of file names typedef sequence ListOfFileNames; -/*! List of modification dates of a study -*/ +//! List of modification dates of a study typedef sequence ListOfDates ; -/*! An unbounded sequence of strings -*/ +//! An unbounded sequence of strings typedef sequence ListOfStrings ; -/*! A byte stream which is used for binary data transfer between different components -*/ +//! An unbounded sequence of sequence of strings + typedef sequence ListOfListOfStrings ; +//! A byte stream which is used for binary data transfer between different components typedef sequence TMPFile; // Reference to other objects is treated with function AddReference @@ -96,16 +90,14 @@ during each working session. interface ChildIterator; interface Driver; interface AttributeStudyProperties; + interface AttributeParameter; interface UseCaseIterator; interface UseCaseBuilder; - interface Callback; -/*! List of attributes of %SObjects -*/ +//! List of attributes of %SObjects typedef sequence ListOfAttributes; -/*! Exception indicating that this feature hasn't been implemented in %SALOME PRO application. -*/ +//! Exception indicating that this feature hasn't been implemented in %SALOME application. exception NotImplemented {}; @@ -128,19 +120,21 @@ during each working session. interface Study { +//! Invalid study context exception StudyInvalidContext {}; +//! Invalid study component exception StudyInvalidComponent {}; -/*! Invalid directory of the %study exception -*/ +//! Invalid directory of the %study exception exception StudyInvalidDirectory {}; -/*! Exception pointing that this name of the study has already been used. -*/ +//! 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 -*/ +//! Invalid name of the %study exception exception StudyNameError {}; +//! Invalid study comment exception StudyCommentError {}; + /*! \brief The name of the %Study This is equivalent to the methods setName() & getName() @@ -151,139 +145,123 @@ during each working session. This is equivalent to the methods setID() & getID() */ attribute short StudyId; -/*! Sequence containing %SObjects -*/ +//! Sequence containing %SObjects typedef sequence ListOfSObject; -/*! - Gets the persistent reference to the %Study. -*/ +//! Get the persistent reference to the %Study. PersistentReference GetPersistentReference(); -/*! - Gets a transient reference to the %Study. -*/ +//! Get a transient reference to the %Study. SalomeReference GetTransientReference(); -/*! - Returns True if the %Study is empty +/*! \brief indicate whether the %Study is empty + + \return True if the %Study is empty */ boolean IsEmpty(); -/*! - Allows to find a %SComponent by its name. +/*! \brief Find a %SComponent by its name. + \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. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example1 for an example of this method usage in batchmode of %SALOME application. + */ SComponent FindComponent (in string aComponentName); -/*! - Allows to find a %SComponent by ID of the according %SObject + +/*! \brief Find a %SComponent by ID of the according %SObject */ SComponent FindComponentID(in ID aComponentID); -/*! - Allows to find a %SObject by the Name Attribute of this %SObject +/*! \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 -
See also an example of this method usage in batchmode of %SALOME application. - +See \ref example19 for an example of this method usage in batchmode of %SALOME application. */ SObject FindObject (in string anObjectName); -/*! - Allows to find a %SObject by its ID +/*! \brief Find a %SObject by its ID + \param aObjectID This parameter defines the ID of the required object \return The obtained %SObject - */ SObject FindObjectID (in ID aObjectID); -/*! - Allows to create a %SObject by its ID +/*! \brief Create a %SObject by its ID + \param aObjectID This parameter defines the ID of the required object \return The created %SObject - */ SObject CreateObjectID (in ID aObjectID); -/*! - Allows to find a %SObject by IOR of the object belonging to this %SObject. +/*! \brief Find a %SObject by IOR of the object belonging to this %SObject. + \param anObjectName This parameter defines the IOR of the object \return The obtained %SObject - */ SObject FindObjectIOR (in ID aObjectIOR); -/*! - Finds in the study all %SObjects produced by a given %Component. +/*! \brief Find in the study all %SObjects produced by a given %Component. + \param anObjectName The Name Attribute of the searched %SObjects should correspond to anObjectName. \param aComponentName The name of the component, which objects are searched for. */ ListOfSObject FindObjectByName(in string anObjectName, in string aComponentName); -/*! - Allows to find a %SObject by the path to it. +/*! \brief Find a %SObject by the path to it. \param thePath The path to the required %SObject. \return The obtained %SObject. - */ SObject FindObjectByPath(in string thePath); -/*! - Returns the path to the %SObject. +/*! \brief Get the path to the %SObject. */ string GetObjectPath(in Object theObject); -/*! - Sets the context of the %Study. - \param thePath String parameter defining the context of the study. +/*! \brief Set the context of the %Study. -
See also an example of this method usage in batchmode of %SALOME application. + \param thePath String parameter defining the context of the study. +See \ref example23 for an example of this method usage in batchmode of %SALOME application. */ void SetContext(in string thePath); -/*! - Gets the context of the %Study. +/*! \brief Get the context of the %Study. -
See also an example of this method usage in batchmode of %SALOME application. - +See \ref example23 for an example of this method usage in batchmode of %SALOME application. */ string GetContext(); -/*! - Returns a list of names of objects corresponding to the context. +/*! \brief 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 GetObjectNames(in string theContext); -/*! - Returns a list of names of directories and subdirectories corresponding to the context. +/*! \brief 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 GetDirectoryNames(in string theContext); -/*! - Returns a list of names of Files corresponding to the context. +/*! \brief 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 GetFileNames(in string theContext); -/*! - Returns a list of names of Components corresponding to the context. +/*! \brief 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. */ ListOfStrings GetComponentNames(in string theContext); -/*! - Creates a new iterator of child levels of the given %SObject. +/*! \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); -/*! - Creates a new iterator of the %SComponents. +/*! \brief Create a new iterator of the %SComponents. \return A new iterator of the %SComponents. */ SComponentIterator NewComponentIterator(); -/*! - Creates a new %StudyBuilder to add or modify an object in the study. - \return A new %StudyBuilder. +/*! \brief Create a new %StudyBuilder to add or modify an object in the study. -
See also an example of this method usage in batchmode of %SALOME application. + \return A new %StudyBuilder. +See \ref example20 for an example of this method usage in batchmode of %SALOME application. */ StudyBuilder NewBuilder() ; /*! \brief Labels dependency @@ -294,22 +272,26 @@ during each working session. /*! \brief Getting properties of the study - Returns the attriubte, which contains the properties of this study. + Returns the attribute, which contains the properties of this study. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example20 for an example of this method usage in batchmode of %SALOME application. */ AttributeStudyProperties GetProperties(); -/*! - Determines whether the %study has been saved +/*! \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. */ boolean IsModified(); -/*! - Determines the file where the %study has been saved + +/*! \brief Mark the %study as being modified and not saved. +*/ + void Modified(); + +/*! \brief Indicate the file where the %study has been saved */ attribute string URL; @@ -342,18 +324,15 @@ during each working session. \return An object */ Object ConvertIORToObject(in string theIOR); -/*! - Gets a new %UseCaseBuilder. +/*! \brief Get a new %UseCaseBuilder. */ UseCaseBuilder GetUseCaseBuilder(); -/*! - Closes the components in the study, removes itself from the %StudyManager. +/*! \brief Close the components in the study, remove itself from the %StudyManager. */ void Close(); -/*! - Enables(if isEnabled = True)/disables automatic addition of new %SObjects to the use case. +/*! \brief Enable (if isEnabled = True)/disable automatic addition of new %SObjects to the use case. */ void EnableUseCaseAutoFilling(in boolean isEnabled); @@ -367,6 +346,200 @@ during each working session. void RemovePostponed(in long theUndoLimit); void UndoPostponed(in long theWay); + + boolean DumpStudy(in string thePath, in string theBaseName, in boolean isPublished); + +/*! \brief Get an AttributeParameter used to store common parameters for given %theSavePoint. + + \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); + +/*! \brief Get an AttributeParameter used to store parameters for given %theModuleName. + + \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); + + +/*! \brief Get a default Python script to restore visual parameters for given %theModuleName. + + \param theID identifies a common parameters set (Example: "Interface Applicative") + \param theModuleName is a name of the module (Example: "Geometry") +*/ + string GetDefaultScript(in string theID, in string theModuleName); + +/*! + 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); + + +/*! \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 SetStudyLock(in string theLockerID); + +/*! \brief Indicate if the Study is locked + + Returns True if the Study was marked locked. +*/ + boolean IsStudyLocked(); + +/*! \brief Mark this Study as being unlocked 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 unlocks the study. +*/ + void UnLockStudy(in string theLockerID); + +/*! \brief Get the list of IDs of the Study's lockers. +*/ + ListOfStrings GetLockerID(); + +/*! \brief Create real 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 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 SetInteger( in string theVarName, in long theValue ); +/*! \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. +*/ + void SetBoolean( in string theVarName, in boolean theValue ); + +/*! \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. +*/ + void SetString( in string theVarName, in string theValue ); + +/*! \brief Set current value as double for string variable +*/ + 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 ); + +/*! \brief Get value of an integer variable + + \param theVarName is a name of the variable. +*/ + long GetInteger( in string theVarName ); + +/*! \brief Get value of a boolean variable + + \param theVarName is a name of the variable. +*/ + boolean GetBoolean( in string theVarName ); + +/*! \brief Get value of a string variable + + \param theVarName is a name of the variable. +*/ + string GetString( in string theVarName ); + + +/*! \brief Indicate if a variable is real + + Return true if variable is real otherwise return false. + \param theVarName is a name of the variable. +*/ + boolean IsReal( in string theVarName ); + +/*! \brief Indicate if a variable is integer + + Return true if variable is integer otherwise return false. + \param theVarName is a name of the variable. +*/ + boolean IsInteger( in string theVarName ); + +/*! \brief Indicate if a variable is boolean + + Return true if variable is boolean otherwise return false. + \param theVarName is a name of the variable. +*/ + boolean IsBoolean( in string theVarName ); + +/*! \brief Indicate if a variable is string + + Return true if variable is string otherwise return false. + \param theVarName is a name of the variable. +*/ + boolean IsString( in string theVarName ); + +/*! \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 IsVariable( in string theVarName ); + +/*! \brief Get names of all variables from the study. +*/ + ListOfStrings GetVariableNames(); + +/*! \brief Remove a variable + + Remove variable with the specified name from the study with substitution of its value. + + \param theVarName Name of the variable. + \return Status of operation. +*/ + 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. +*/ + boolean RenameVariable( in string theVarName, in string theNewVarName ); + +/*! \brief Indicate whether variable is used + + Check that variable is used in the study. + + \param theVarName Name of the variable. + \return Variable usage. +*/ + boolean IsVariableUsed( in string theVarName ); + +/*! \brief Parse variables used for object creation + + \param string with variables, separated by special symbol. + \return Variables list. +*/ + ListOfListOfStrings ParseVariables( in string theVars ); + }; //========================================================================== @@ -394,7 +567,7 @@ during each working session. Creates a new %SComponent \param ComponentDataType Data type of the %SComponent which will be created. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example17 for an example of this method usage in batchmode of %SALOME application. */ SComponent NewComponent(in string ComponentDataType) raises(LockProtection); @@ -403,6 +576,7 @@ during each working session. Defines the instance to the %SComponent. */ void DefineComponentInstance (in SComponent aComponent,in Object ComponentIOR) raises(LockProtection); + /*! \brief Deletion of a %SComponent Removes a %SComponent. @@ -416,7 +590,7 @@ during each working session. \param theFatherObject The father %SObject under which this one should be created. \return New %SObject -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example18 for an example of this method usage in batchmode of %SALOME application. */ @@ -449,7 +623,7 @@ during each working session. /*! Loads a %SComponent. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example19 for an example of this method usage in batchmode of %SALOME application. */ void LoadWith (in SComponent sco, in Driver Engine) raises (SALOME::SALOME_Exception); @@ -466,7 +640,7 @@ during each working session. \param anObject The %SObject corresponding to the attribute which is looked for. \param aTypeOfAttribute Type of the attribute. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example1 for an example of this method usage in batchmode of %SALOME application. */ GenericAttribute FindOrCreateAttribute(in SObject anObject, @@ -490,7 +664,7 @@ during each working session. \param anObject The %SObject corresponding to the attribute. \param aTypeOfAttribute Type of the attribute. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example17 for an example of this method usage in batchmode of %SALOME application. */ void RemoveAttribute(in SObject anObject, in string aTypeOfAttribute) raises(LockProtection); @@ -514,7 +688,7 @@ during each working session. Adds a directory in the %Study. \param theName String parameter defining the name of the directory. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example23 for an example of this method usage in batchmode of %SALOME application. */ void AddDirectory(in string theName) raises(LockProtection); @@ -541,7 +715,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin Creates a new command which can contain several different actions. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example3 for an example of this method usage in batchmode of %SALOME application. */ void NewCommand(); // command management @@ -551,7 +725,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example16 for an example of this method usage in batchmode of %SALOME application. */ void CommitCommand() raises(LockProtection); // command management @@ -563,7 +737,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin Cancels all actions declared within the command. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example17 for an example of this method usage in batchmode of %SALOME application. */ void AbortCommand(); // command management /*! \brief Undolimit @@ -577,7 +751,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example16 for an example of this method usage in batchmode of %SALOME application. */ void Undo() raises (LockProtection); @@ -587,40 +761,24 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin \exception LockProtection This exception is raised, when trying to perform this command a study, which is protected for modifications. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example16 for an example of this method usage in batchmode of %SALOME application. */ void Redo() raises (LockProtection); /*! Returns True if at this moment there are any actions which can be canceled. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example16 for an example of this method usage in batchmode of %SALOME application. */ boolean GetAvailableUndos(); /*! Returns True if at this moment there are any actions which can be redone. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example3 for an example of this method usage in batchmode of %SALOME application. */ boolean GetAvailableRedos(); -/*! - This method is called when adding an object into study. - It sets the callback for addition of the given %SObject. - \param theCallback New assigned callback. - \return The previous callback. -*/ - Callback SetOnAddSObject(in Callback theCallback); -/*! - This method is called when adding an object into study. - It sets the callback for removal of the given %SObject. - - \return The previous callback. - \param theCallback New assigned callback. -*/ - Callback SetOnRemoveSObject(in Callback theCallback); - /*! Puts name attribute with the given string value to the given %SObject @@ -664,13 +822,25 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin */ void ping(); + void Shutdown(); + +/*! + Returns the PID of the server +*/ + long getPID(); + +/*! + Shutdown the StudyManager process. +*/ + oneway void ShutdownWithExit(); + /*! \brief Creation of a new study Creates a new study with a definite name. \param study_name String parameter defining the name of the study -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example17 for an example of this method usage in batchmode of %SALOME application. */ Study NewStudy(in string study_name); @@ -681,7 +851,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin \param aStudyUrl The path to the study \warning This method doesn't activate the corba objects. Only a component can do it. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example1 for an example of this method usage in batchmode of %SALOME application. */ Study Open (in URL aStudyUrl) raises (SALOME::SALOME_Exception); @@ -696,16 +866,16 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin \param theMultiFile If this parameter is True the study will be saved in several files. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example19 for an example of this method usage in batchmode of %SALOME application. */ - void Save(in Study aStudy, in boolean theMultiFile); + boolean Save(in Study aStudy, in boolean theMultiFile); /*! \brief Saving a study in a ASCII file (or files). 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. */ - void SaveASCII(in Study aStudy, in boolean theMultiFile); + 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). @@ -713,9 +883,9 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin \param aStudy The study which will be saved \param theMultiFile If this parameter is True the study will be saved in several files. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example1 for an example of this method usage in batchmode of %SALOME application. */ - void SaveAs(in URL aUrl, // if the file already exists + 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). @@ -726,7 +896,7 @@ Searches for a definite %SObject with a definite GUID and returns True if it fin \param aStudy The study which will be saved \param theMultiFile If this parameter is True the study will be saved in several files. */ - void SaveAsASCII(in URL aUrl, // if the file already exists + boolean SaveAsASCII(in URL aUrl, // if the file already exists in Study aStudy, in boolean theMultiFile); // overwrite (as option) @@ -778,6 +948,29 @@ Gets the list of open studies an object into a study, which is protected for modifications. */ SObject Paste(in SObject theObject) raises (SALOMEDS::StudyBuilder::LockProtection); + +/*! \brief Object conversion. + + Converts an object into IOR. + \return IOR +*/ + string ConvertObjectToIOR(in Object theObject); +/*! \brief Object conversion. + + Converts IOR into an object. + \return An object +*/ + Object ConvertIORToObject(in string theIOR); + +/*! + 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); + + }; @@ -795,7 +988,7 @@ Gets the list of open studies */ //========================================================================== - interface SObject + interface SObject : SALOME::GenericObj { /*! Name of the %SObject */ @@ -837,7 +1030,7 @@ Gets the list of open studies \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. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example1 for an example of this method usage in batchmode of %SALOME application. */ boolean FindAttribute(out GenericAttribute anAttribute, in string aTypeOfAttribute); @@ -851,20 +1044,20 @@ Gets the list of open studies \return The list of all attributes of the given %SObject. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example17 for an example of this method usage in batchmode of %SALOME application. */ ListOfAttributes GetAllAttributes(); /*! Gets the study of a given %SObject. - /return The study containing the 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. + \return The CORBA object of the %SObject. */ Object GetObject(); @@ -885,6 +1078,14 @@ Gets the list of open studies Returns empty string if there is no IOR attribute. */ string GetIOR(); + +/*! + Private method, returns an implementation of this SObject. + \param theHostname is a hostname of the caller + \param thePID is a process ID of the caller + \param isLocal is set True if the SObject is launched locally with the caller +*/ + long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal); }; @@ -894,7 +1095,7 @@ Gets the list of open studies %Generic attribute is a base interface for all attributes which can be assigned to the SObjects created in the study. */ //========================================================================== - interface GenericAttribute + interface GenericAttribute : SALOME::GenericObj { /*! \brief Exception locking all changes @@ -909,13 +1110,22 @@ Gets the list of open studies */ void CheckLocked() raises (LockProtection); - string Store(); - - void Restore(in string theData); - + //! Get Type string Type(); + //! Get the class type + string GetClassType(); + + //! Get SObject SObject GetSObject(); + + //! Private method, returns an implementation of this GenericAttribute. +/*! + \param theHostname is a hostname of the caller + \param thePID is a process ID of the caller + \param isLocal is set True if the GenericAttribute is launched locally with the caller +*/ + long long GetLocalImpl(in string theHostname, in long thePID, out boolean isLocal); }; @@ -930,12 +1140,12 @@ Gets the list of open studies //========================================================================== interface SComponent : SObject { -/*! Gets the data type of the given %SComponent +/*! \brief Gets the data type of the given %SComponent \return The data type of this %SComponent. */ string ComponentDataType(); -/*! Gets the IOR of the given component +/*! \brief Gets the IOR of the given component \return True (if there is an instance of the given component) and its IOR. */ @@ -951,25 +1161,25 @@ Gets the list of open studies The search is started from the first %SComponent in the list. */ //========================================================================== - interface SComponentIterator + interface SComponentIterator : SALOME::GenericObj { /*! -Activates the %SComponentIterator. +\brief Activates the %SComponentIterator. */ void Init(); -/*! Method More +/*! \brief Method More \return True if there is one more %SComponent in the list. */ boolean More(); /*! -Moves the iterator to the next %SComponent in the list. +\brief Moves the iterator to the next %SComponent in the list. */ void Next(); /*! - Returns the %SComponent corresponding to the current %SComponent found by the iterator. + \brief Returns the %SComponent corresponding to the current %SComponent found by the iterator. -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example1 for an example of this method usage in batchmode of %SALOME application. */ SComponent Value(); @@ -982,31 +1192,31 @@ Moves the iterator to the next %SComponent in the list. levels. */ //========================================================================== - interface ChildIterator + interface ChildIterator : SALOME::GenericObj { /*! -Activates the %ChildIterator. +\brief Activates the %ChildIterator. */ void Init(); /*! -Activates the %ChildIterator for all child levels. +\brief Activates the %ChildIterator for all child levels. \param allLevels If this boolean parameter is True, the %ChildIterator will be activated for all child levels. */ void InitEx(in boolean allLevels); -/*! Method More +/*! \brief Method More \return True if there is one more %ChildIterator in the list. */ boolean More(); /*! - Passes the iterator to the next level. + \brief Passes the iterator to the next level. */ void Next(); /*! - Returns the %SObject corresponding to the current object found by the iterator. + \brief Returns the %SObject corresponding to the current object found by the iterator. */ SObject Value(); }; @@ -1017,7 +1227,7 @@ Activates the %ChildIterator for all child levels. This interface contains a set of methods used for iteration over the objects in the use case. */ - interface UseCaseIterator + interface UseCaseIterator : SALOME::GenericObj { /*! Activates the %UseCaseIterator. @@ -1046,7 +1256,7 @@ Activates the %UseCaseIterator. Use case in the study represents a user-managed subtree, containing all or some of the objects which exist in the study. The %UseCaseBuilder interface contains a set of methods used for management of the use case in the study. */ - interface UseCaseBuilder + interface UseCaseBuilder : SALOME::GenericObj { /*! Adds to the use case an object as a child of the current object of the use case. @@ -1108,25 +1318,6 @@ Activates the %UseCaseIterator. UseCaseIterator GetUseCaseIterator(in SObject theObject); }; //========================================================================== - //========================================================================== -/*! \brief The callback interface - - The %StudyBuilder can be created with the method NewBuilder. While invocation of this method a new object of the class Callback is created - and this object is assigned to the newly created Builder as callback which should be called when adding and removing of the ojects. -*/ - interface Callback - { -/*! - Invokes the corresponding method Append of the %UseCaseBuilder. -*/ - void OnAddSObject(in SObject theObject); -/*! - Invokes the corresponding method Remove of the %UseCaseBuilder. -*/ - void OnRemoveSObject(in SObject theObject); - }; - - //========================================================================== /*! \brief %Driver interface This class represents a common tool for all components integrated into SALOME application, that allows them to communicate with the study. It contains a set of methods which @@ -1151,7 +1342,7 @@ can be called by any component and which provide the following functionality: \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files. \return A byte stream TMPFile that contains all saved data -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example19 for an example of this method usage in batchmode of %SALOME application. */ @@ -1166,7 +1357,7 @@ can be called by any component and which provide the following functionality: \param isMultiFile If the value of this boolean parameter is True, the data will be saved in several files. \return A byte stream TMPFile that will contain all saved data -
See also an example of this method usage in batchmode of %SALOME application. +See \ref example19 for an example of this method usage in batchmode of %SALOME application. */ TMPFile SaveASCII(in SComponent theComponent, in string theURL, in boolean isMultiFile);