src/engine/BL_Job.hxx

   1 // Copyright (C) 2009-2013  CEA/DEN, EDF R&D
   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.
   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};
  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 setDumpYACSState(const int & dump_yacs_state);
  57       int getDumpYACSState();
  58
  59       struct BatchParam
  60       {
  61         std::string batch_directory;
  62         std::string maximum_duration;
  63         std::string expected_memory;
  64         int nb_proc;
  65         bool exclusive;
  66
  67                 // Parameters for COORM
  68                 std::string launcher_file;
  69                 std::string launcher_args;
  70       };
  71       void setBatchParameters(const BL::Job::BatchParam & param);
  72       const BL::Job::BatchParam & getBatchParameters();
  73
  74       struct FilesParam
  75       {
  76         std::string result_directory;
  77         std::list<std::string> input_files_list;
  78         std::list<std::string> output_files_list;
  79       };
  80       void setFilesParameters(BL::Job::FilesParam & param);
  81       BL::Job::FilesParam & getFilesParameters();
  82
  83       void setResource(const std::string & resource);
  84       std::string & getResource();
  85
  86       void setBatchQueue(const std::string & queue);
  87       std::string & getBatchQueue();
  88
  89       void setLoadLevelerJobType(const std::string & jobtype);
  90       std::string & getLoadLevelerJobType();
  91
  92       enum State {CREATED, IN_PROCESS, QUEUED, RUNNING, PAUSED, FINISHED, ERROR, FAILED, NOT_CREATED};
  93       void setState(BL::Job::State state);
  94       BL::Job::State getState();
  95       std::string setStringState(const std::string & state);
  96
  97       enum ThreadState {NOTHING, STARTING};
  98       void setThreadState(BL::Job::ThreadState state);
  99       BL::Job::ThreadState getThreadState();
 100
 101       void setSalomeLauncherId(int id);
 102       int getSalomeLauncherId();
 103
 104     private:
 105       BL::Job::State _state;
 106       BL::Job::ThreadState _thread_state;
 107       int _dump_yacs_state;
 108
 109       std::string _name;
 110
 111       BL::Job::JobType _type;
 112       std::string _job_file;
 113       std::string _env_file;
 114
 115       BL::Job::BatchParam _batch_params;
 116       BL::Job::FilesParam _files_params;
 117       std::string _resource_choosed;
 118       std::string _batch_queue;
 119       std::string _ll_jobtype;
 120
 121       int _salome_launcher_id;
 122   };
 123
 124 }
 125
 126 #endif