src/engine/BL_Job.hxx

   1 // Copyright (C) 2009-2024  CEA, EDF
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef _BL_JOB_HXX_
  21 #define _BL_JOB_HXX_
  22
  23 #include "BL_Engine.hxx"
  24 #include "BL_Traces.hxx"
  25
  26 #include <string>
  27 #include <list>
  28
  29 #ifdef WNT
  30 #undef ERROR
  31 #endif
  32
  33 namespace BL{
  34
  35   class BL_Engine_EXPORT Job
  36   {
  37     public:
  38       Job();
  39       Job(const std::string & name);
  40       virtual ~Job();
  41
  42       void setName(const std::string & name);
  43       std::string getName();
  44
  45       enum JobType {YACS_SCHEMA, COMMAND, PYTHON_SALOME, COMMAND_SALOME};
  46       void setType(BL::Job::JobType type);
  47       void setType(const std::string & type);
  48       BL::Job::JobType getType();
  49
  50       void setJobFile(const std::string & job_file);
  51       std::string & getJobFile();
  52
  53       void setEnvFile(const std::string & env_file);
  54       std::string & getEnvFile();
  55
  56       void setPreCommand(const std::string & pre_command);
  57       std::string & getPreCommand();
  58
  59       void setDumpYACSState(const int & dump_yacs_state);
  60       int getDumpYACSState();
  61
  62       void setYacsDriverOptions(const std::string& options);
  63       const std::string& getYacsDriverOptions()const;
  64
  65       enum MemReqType {MEM_PER_NODE, MEM_PER_CPU};
  66
  67       struct BatchParam
  68       {
  69         std::string batch_directory;
  70         std::string maximum_duration;
  71         long mem_limit;
  72         MemReqType mem_req_type;
  73         int nb_proc;
  74         int nb_node;
  75         bool exclusive;
  76
  77         // Parameters for COORM
  78         std::string launcher_file;
  79         std::string launcher_args;
  80       };
  81       void setBatchParameters(const BL::Job::BatchParam & param);
  82       const BL::Job::BatchParam & getBatchParameters();
  83
  84       struct FilesParam
  85       {
  86         std::string result_directory;
  87         std::list<std::string> input_files_list;
  88         std::list<std::string> output_files_list;
  89       };
  90       void setFilesParameters(BL::Job::FilesParam & param);
  91       BL::Job::FilesParam & getFilesParameters();
  92
  93       void setResource(const std::string & resource);
  94       std::string & getResource();
  95
  96       void setBatchQueue(const std::string & queue);
  97       std::string & getBatchQueue();
  98
  99       void setBatchPartition(const std::string & partition);
 100       std::string & getBatchPartition();
 101
 102       void setWCKey(const std::string & wckey);
 103       const std::string & getWCKey();
 104
 105       void setExtraParams(const std::string & extra_params);
 106       const std::string & getExtraParams();
 107
 108       void setLoadLevelerJobType(const std::string & jobtype);
 109       std::string & getLoadLevelerJobType();
 110
 111       enum State {CREATED, IN_PROCESS, QUEUED, RUNNING, PAUSED, FINISHED, ERROR, FAILED, NOT_CREATED};
 112       void setState(BL::Job::State state);
 113       BL::Job::State getState();
 114       std::string setStringState(const std::string & state);
 115
 116       enum ThreadState {NOTHING, STARTING};
 117       void setThreadState(BL::Job::ThreadState state);
 118       BL::Job::ThreadState getThreadState();
 119
 120       void setSalomeLauncherId(int id);
 121       int getSalomeLauncherId();
 122
 123     private:
 124       BL::Job::State _state;
 125       BL::Job::ThreadState _thread_state;
 126       int _dump_yacs_state;
 127       std::string _yacs_driver_options;
 128
 129       std::string _name;
 130
 131       BL::Job::JobType _type;
 132       std::string _job_file;
 133       std::string _env_file;
 134       std::string _pre_command;
 135
 136       BL::Job::BatchParam _batch_params;
 137       BL::Job::FilesParam _files_params;
 138       std::string _resource_choosed;
 139       std::string _batch_queue;
 140       std::string _batch_partition;
 141       std::string _wckey;
 142       std::string _extra_params;
 143       std::string _ll_jobtype;
 144
 145       int _salome_launcher_id;
 146   };
 147
 148 }
 149
 150 #endif