Merge changes from 'master' branch.

[modules/kernel.git] / idl / SALOME_Component.idl

diff --git a/idl/SALOME_Component.idl b/idl/SALOME_Component.idl
index 1e6df762557371844dcea14fbd325cbc70a18093..805e09d260fca2c6c717d47729053b485534c574 100644 (file)
--- a/idl/SALOME_Component.idl
+++ b/idl/SALOME_Component.idl
@@ -80,7 +80,7 @@ module Engines
                            try to make a Python import of COMPONENT,
                            then a lib open of libCOMPONENTEngine.so
       \param reason      in case of error (return false) a string explaining the error
                            try to make a Python import of COMPONENT,
                            then a lib open of libCOMPONENTEngine.so
       \param reason      in case of error (return false) a string explaining the error

-      \return true if load successfull or already done, false otherwise
+      \return true if load successful or already done, false otherwise

     */
     boolean load_component_Library(in string componentName, out string reason);
 
     */
     boolean load_component_Library(in string componentName, out string reason);
 


@@ -90,22 +90,17 @@ module Engines
       \param componentName Name of the component which will be registered
                            in Registry and Name Service,
                          (instance number suffix added to the registered name)
       \param componentName Name of the component which will be registered
                            in Registry and Name Service,
                          (instance number suffix added to the registered name)

-      \param studyId        0 if instance is not associated to a study,
-                            >0 otherwise (== study id)

       \return a loaded component
     */
       \return a loaded component
     */

-    Engines::EngineComponent create_component_instance(in string componentName,
-                                                       in long studyId);
+    Engines::EngineComponent create_component_instance(in string componentName);

 
     //! Create a new Python servant instance of a generic service.
         /*!
           This simply loads the service in the current container by importing the
           corresponding Python module.
           Warning: no internal registration is done, so it is up to the caller to
 
     //! Create a new Python servant instance of a generic service.
         /*!
           This simply loads the service in the current container by importing the
           corresponding Python module.
           Warning: no internal registration is done, so it is up to the caller to

-          manage the various instanciation.
+          manage the various instantiation.

           \param serviceName Name of the service
           \param serviceName Name of the service

-
-                                >0 otherwise (== study id)

           \param reason  in case of error (return void string) a string explaining the error
           \return the IOR of the loaded service.
         */
           \param reason  in case of error (return void string) a string explaining the error
           \return the IOR of the loaded service.
         */


@@ -118,25 +113,20 @@ module Engines
       \param componentName Name of the component which will be registered
                            in Registry and Name Service,
                          (instance number suffix added to the registered name)
       \param componentName Name of the component which will be registered
                            in Registry and Name Service,
                          (instance number suffix added to the registered name)

-      \param studyId        0 if instance is not associated to a study,
-                            >0 otherwise (== study id)

       \param env         a dict of env variables
       \param reason      in case of error (return nil) a string explaining the error
       \return a loaded component
     */
     Engines::EngineComponent create_component_instance_env(in string componentName,
       \param env         a dict of env variables
       \param reason      in case of error (return nil) a string explaining the error
       \return a loaded component
     */
     Engines::EngineComponent create_component_instance_env(in string componentName,

-                                                           in long studyId, in FieldsDict env,
+                                                           in FieldsDict env,

                                                            out string reason);
     //! Find a servant instance of a component
     /*!
       \param registeredName  Name of the component in Registry or Name Service,
                              without instance suffix number
                                                            out string reason);
     //! Find a servant instance of a component
     /*!
       \param registeredName  Name of the component in Registry or Name Service,
                              without instance suffix number

-      \param studyId        0 if instance is not associated to a study,
-                            >0 otherwise (== study id)
-      \return the first instance found with same studyId
+      \return the first instance found

     */
     */

-    EngineComponent find_component_instance(in string registeredName,
-                                            in long studyId);
+    EngineComponent find_component_instance(in string registeredName);

 
     //! Find a servant instance of a component, or create a new one.
     /*!
 
     //! Find a servant instance of a component, or create a new one.
     /*!


@@ -261,15 +251,6 @@ module Engines
     //!  Determines whether the server has already been loaded or not.
     void ping();
 
     //!  Determines whether the server has already been loaded or not.
     void ping();
 

-    //!  Get study associated to component instance
-    /*!
-      get study associated to component instance
-      \return -1: not initialised (Internal Error)
-               0: multistudy component instance
-              >0: study id associated to this instance
-    */
-    long getStudyId();
-

     //! Remove component instance from container
     /*!
       Deactivates the %Component.
     //! Remove component instance from container
     /*!
       Deactivates the %Component.


@@ -355,8 +336,7 @@ module Engines
       Returns a python script, which is being played back reproduces
       the data model of component
     */
       Returns a python script, which is being played back reproduces
       the data model of component
     */

-    TMPFile DumpPython(in Object theStudy,
-                       in boolean isPublished,
+    TMPFile DumpPython(in boolean isPublished,

                        in boolean isMultiFile,
                        out boolean isValidScript);
 
                        in boolean isMultiFile,
                        out boolean isValidScript);
 


@@ -369,7 +349,7 @@ module Engines
 
       \return CORBA Ref of the requested file.
 
 
       \return CORBA Ref of the requested file.
 

-      \exception contains informations of what if the component cannot
+      \exception contains information of what if the component cannot

       sends the file's reference.
     */
     Engines::Salome_file getInputFileToService(in string service_name,
       sends the file's reference.
     */
     Engines::Salome_file getInputFileToService(in string service_name,


@@ -389,7 +369,7 @@ module Engines
 
       \param service_name service's name.
 
 
       \param service_name service's name.
 

-      \exception contains informations about files that are not in a good state.
+      \exception contains information about files that are not in a good state.

     */
     void checkInputFilesToService(in string service_name)           raises(SALOME::SALOME_Exception);
 
     */
     void checkInputFilesToService(in string service_name)           raises(SALOME::SALOME_Exception);
 


@@ -415,7 +395,7 @@ module Engines
 
       \return CORBA Ref of the requested file.
 
 
       \return CORBA Ref of the requested file.
 

-      \exception contains informations of what if the component cannot
+      \exception contains information of what if the component cannot

       sends the file's reference.
     */
     Engines::Salome_file getOutputFileToService(in string service_name,
       sends the file's reference.
     */
     Engines::Salome_file getOutputFileToService(in string service_name,


@@ -435,7 +415,7 @@ module Engines
 
       \param service_name service's name.
 
 
       \param service_name service's name.
 

-      \exception contains informations about files that are not in a good state.
+      \exception contains information about files that are not in a good state.

     */
     void checkOutputFilesToService(in string service_name)        raises(SALOME::SALOME_Exception);
 
     */
     void checkOutputFilesToService(in string service_name)        raises(SALOME::SALOME_Exception);
 


@@ -469,11 +449,10 @@ module Engines
       It is worth using this method only if hasObjectInfo() method returns true.
 
       \param entry object's entry.
       It is worth using this method only if hasObjectInfo() method returns true.
 
       \param entry object's entry.

-      \param studyId study id

 
       \return an information about the given object.
     */
 
       \return an information about the given object.
     */

-    string getObjectInfo(in long studyId, in string entry);
+    string getObjectInfo(in string entry);

 
     //! Get version of the component
     /*!
 
     //! Get version of the component
     /*!


@@ -589,7 +568,7 @@ module Engines
 
       \param hdf5_file name (with path) of the hdf5_file.
 
 
       \param hdf5_file name (with path) of the hdf5_file.
 

-      \exception contains informations of errors if the loading doesn't succeed.
+      \exception contains information of errors if the loading doesn't succeed.

      */
     void load(in string hdf5_file)                            raises (SALOME::SALOME_Exception);
 
      */
     void load(in string hdf5_file)                            raises (SALOME::SALOME_Exception);
 


@@ -598,7 +577,7 @@ module Engines
 
       \param  hdf5_file name (with path) of the hdf5_file.
 
 
       \param  hdf5_file name (with path) of the hdf5_file.
 

-      \exception contains informations of errors if the save doesn't succeed.
+      \exception contains information of errors if the save doesn't succeed.

 
     */
     void save(in string hdf5_file)                            raises (SALOME::SALOME_Exception);
 
     */
     void save(in string hdf5_file)                            raises (SALOME::SALOME_Exception);


@@ -609,7 +588,7 @@ module Engines
 
       \param  hdf5_file name (with path) of the hdf5_file.
 
 
       \param  hdf5_file name (with path) of the hdf5_file.
 

-      \exception contains informations of errors if the save doesn't succeed.
+      \exception contains information of errors if the save doesn't succeed.

 
     */
     void save_all(in string hdf5_file)                            raises (SALOME::SALOME_Exception);
 
     */
     void save_all(in string hdf5_file)                            raises (SALOME::SALOME_Exception);