Salome HOME
Fix typos by Kunda
[modules/kernel.git] / idl / SALOME_ResourcesManager.idl
index 68578b5645e6cb69ac17d28e280cd92dea594b47..4dafdf76d27a983586d05f062c966bc9c55660da 100644 (file)
@@ -35,13 +35,14 @@ module Engines
 typedef sequence<string> ResourceList;
 //! components list
 typedef sequence<string> CompoList;
-
+typedef sequence<long> IntegerList;
+  
 //! Type to describe required properties of a resource
 struct ResourceParameters
 {
   //! resource name - manual selection
-  /*! If a name is provided, the ressource will be imposed.
-      If the name is an empty string, the ressource will be chosen to match
+  /*! If a name is provided, the resource will be imposed.
+      If the name is an empty string, the resource will be chosen to match
       the other parameters.
   */
   string name;
@@ -72,14 +73,14 @@ struct ResourceParameters
       The parameter specifies the maximum memory value that could be allocated
       for executing the job. This takes into account not only the data that
       could be loaded by the batch process but also the linked dynamic library.
-      A possible problem, for exemple in the case where you use the ssh
+      A possible problem, for example in the case where you use the ssh
       emulation of a batch system, is to get an error message as below
       when libBatch tries to run the ssh command:
 \verbatim
 /usr/bin/ssh: error while loading shared libraries: libcrypto.so.0.9.8: failed
 to map segment from shared object: Cannot allocate memory
 \endverbatim
-      In this exemple, the mem_mb was set to 1MB, value that is not
+      In this example, the mem_mb was set to 1MB, value that is not
       sufficient to load the dynamic libraries linked to the ssh
       executable (libcrypto.so in the error message).
       So, even in the case of a simple test shell script, you should
@@ -116,7 +117,8 @@ struct ResourceDefinition
   string username;
   //! salome application to use to start a remote container
   string applipath;
-  //! list of available components 
+  //! list of available components.
+  //! An empty list means every component is available.
   CompoList componentList;
 
   //! operating system 
@@ -188,6 +190,9 @@ interface ResourcesManager
   //! Create a machine file for PaCO container
   string getMachineFile(in string resource_name, in long nb_procs, in string parallelLib)
     raises (SALOME::SALOME_Exception);
+
+  //! Return list of resources available (regarding content of CatalogResources.xml). And for each resource the number of proc available of it.
+  void ListAllAvailableResources(out ResourceList machines, out IntegerList nbProcsOfMachines) raises (SALOME::SALOME_Exception);
 };
 
 };