1 // Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #ifndef _SALOME_LAUNCHER_IDL_
24 #define _SALOME_LAUNCHER_IDL_
26 #include "SALOME_Exception.idl"
27 #include "SALOME_ResourcesManager.idl"
29 /*! \file SALOME_Launcher.idl \brief interfaces for %SALOME Launcher service
36 typedef sequence<string> FilesList;
38 //! A generic parameter
44 //! Generic parameter list
45 typedef sequence<Engines::Parameter> ParameterList;
50 //! Job Type - Could be equal to "command" or "yacs_file" or "python_salome"
58 string work_directory;
59 string local_directory;
60 string result_directory;
62 /*! Time for the batch (has to be like this : hh:mm) - Could be empty, in
63 this case, default value of the selected resource will be used.
65 string maximum_duration;
67 // Memory is expressed in megabytes -> mem_mb
68 // Number of Processors -> nb_proc
69 ResourceParameters resource_required;
72 Name of the batch queue choosed - optional
76 //! Specifies if the job must run in exclusive mode (without sharing nodes with other jobs)
80 Specific parameters for each type of job - optional
82 Engines::ParameterList specific_parameters;
84 // Parameters for COORM
92 Engines::JobParameters job_parameters;
94 typedef sequence<Engines::JobDescription> JobsList;
96 interface SalomeLauncherObserver
98 void notify(in string event_name, in string event_data);
101 /*! \brief Interface of the %salomelauncher
102 This interface is used for interaction with the unique instance
105 interface SalomeLauncher
108 long createJob (in Engines::JobParameters job_parameters) raises (SALOME::SALOME_Exception);
109 void launchJob (in long job_id) raises (SALOME::SALOME_Exception);
110 string getJobState (in long job_id) raises (SALOME::SALOME_Exception);
111 string getAssignedHostnames (in long job_id) raises (SALOME::SALOME_Exception); // Get names or ids of hosts assigned to the job
112 void getJobResults(in long job_id, in string directory) raises (SALOME::SALOME_Exception);
113 boolean getJobDumpState(in long job_id, in string directory) raises (SALOME::SALOME_Exception);
114 void stopJob (in long job_id) raises (SALOME::SALOME_Exception);
115 void removeJob (in long job_id) raises (SALOME::SALOME_Exception);
118 long createJobWithFile(in string xmlJobFile, in string clusterName) raises (SALOME::SALOME_Exception);
119 boolean testBatch (in ResourceParameters params) raises (SALOME::SALOME_Exception);
121 // SALOME kernel service methods
125 // Observer and introspection methods
126 void addObserver(in Engines::SalomeLauncherObserver observer);
127 void removeObserver(in Engines::SalomeLauncherObserver observer);
128 Engines::JobsList getJobsList();
129 Engines::JobParameters getJobParameters(in long job_id) raises (SALOME::SALOME_Exception);
131 // Save and load methods
132 void loadJobs(in string jobs_file) raises (SALOME::SALOME_Exception);
133 void saveJobs(in string jobs_file) raises (SALOME::SALOME_Exception);