Salome HOME
Go on for RequestSwitcher conquest
[modules/yacs.git] / idl / SALOME_Launcher.idl
index a1427ba61bc5a331029d68d531f2a7177f55b5dd..a114a998251ec9a00e9dcc8a5be25a3d8fb60af8 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2016  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
@@ -72,7 +72,7 @@ struct JobParameters
   string env_file; 
 
   //! List of local data files to be copied to #work_directory.
-  /*! #job_file and #env_file are automaticaly copied, without adding them
+  /*! #job_file and #env_file are automatically copied, without adding them
       to this list. If basenames are specified, then the files are supposed
       to be located in #local_directory.
   */
@@ -94,16 +94,16 @@ struct JobParameters
       this directory. A change directory toward this working directory is done
       by the batch system before running the job.
       If not specified (empty string), the launcher will use the working
-      directory of the chosen ressource and if this is also an empty string
+      directory of the chosen resource and if this is also an empty string
       the value used will be $HOME/Batch/workdir_"date" where $HOME is the
-      value of the environment variable on the remote ressource and "date" is
+      value of the environment variable on the remote resource and "date" is
       the current date.
   */
   string work_directory;
 
   //! Prefix to be applied to #in_files.
   /*! It can be used to specify where to find the local input files.
-      It's optionnal if you specify the absolute path name of input files.
+      It's optional if you specify the absolute path name of input files.
   */
   string local_directory;
 
@@ -122,8 +122,8 @@ struct JobParameters
   */
   string maximum_duration; 
 
-  //! Specifies the rules to choose the ressource where to execute the job.
-  /*! The additionnal two following parameters MUST be specified explicitly,
+  //! Specifies the rules to choose the resource where to execute the job.
+  /*! The additional two following parameters MUST be specified explicitly,
       because they are not provided by the resource definition:
       - mem_mb -> Memory expressed in megabytes.
       - nb_proc -> Number of Processors.
@@ -153,6 +153,9 @@ struct JobParameters
         when the job type is "yacs_file". It gives the number of seconds
         between two updates of the state dump file. There will be no dump file
         if this parameter is missing or if its value is less than 1.
+      - YACSDriverOptions : options of the driver command when the job type is
+        "yacs_file".
+      - LoalLevelerJobType : LL_JOBTYPE.
   */
   Engines::ParameterList specific_parameters;
 
@@ -195,8 +198,7 @@ interface SalomeLauncher
   /*! Launching the job consists of:
       - create the working directory on the remote file system
       - copy the input files into the working directory
-      - source the environment file if defined
-      - run the job
+      - submit the job to the batch manager
   */
   void   launchJob    (in long job_id)                           raises (SALOME::SALOME_Exception);