#include <molequeue/jobdata.h>
Internal container for job details.
- Author
- David C. Lonie
Each JobData instance stores information about a specific job. All JobData objects are owned by a JobManager, which dispenses JobReferenceBase subclasses (Job and JobRequest) that are used to interact with the JobData members.
void setQueue |
( |
const QString & |
newQueue | ) |
|
- Parameters
-
newQueue | name of the queue. |
- Returns
- Name of queue to use.
void setProgram |
( |
const QString & |
newProgram | ) |
|
- Parameters
-
newProgram | Name of the program. |
QString program |
( |
| ) |
const |
- Returns
- Name of program to run.
void setJobState |
( |
JobState |
state | ) |
|
JobState jobState |
( |
| ) |
const |
void setDescription |
( |
const QString & |
newDesc | ) |
|
- Parameters
-
newDesc | Description of job |
QString description |
( |
| ) |
const |
- Returns
- newDesc Description of job
- Parameters
-
files | FileSpecification objects describing additional input files to be placed in the working directory of the job prior to execution. |
- Returns
- FileSpecification objects describing additional input files to be placed in the working directory of the job prior to execution.
- Returns
- A reference to the additional input files list.
void setOutputDirectory |
( |
const QString & |
path | ) |
|
- Parameters
-
path | String containing a location to copy the output files to after the job completes. Ignored if empty. |
QString outputDirectory |
( |
| ) |
const |
- Returns
- String containing a location to copy the output files to after the job completes. Ignored if empty.
void setLocalWorkingDirectory |
( |
const QString & |
path | ) |
|
- Parameters
-
path | Temporary working directory where files are stored during job execution. |
QString localWorkingDirectory |
( |
| ) |
const |
- Returns
- Temporary working directory where files are stored during job execution.
void setCleanRemoteFiles |
( |
bool |
clean | ) |
|
- Parameters
-
clean | If true, delete any working files on the remote server. Default: false. |
bool cleanRemoteFiles |
( |
| ) |
const |
- Returns
- If true, delete any working files on the remote server. Default: false.
void setRetrieveOutput |
( |
bool |
b | ) |
|
- Parameters
-
b | If true, copies files back from remote server. Default: true |
bool retrieveOutput |
( |
| ) |
const |
- Returns
- If true, copies files back from remote server. Default: true
void setCleanLocalWorkingDirectory |
( |
bool |
b | ) |
|
- Parameters
-
b | If true, the local working files are removed after job is complete. Should be used with setOutputDirectory. Default: false |
bool cleanLocalWorkingDirectory |
( |
| ) |
const |
- Returns
- If true, the local working files are removed after job is complete. Should be used with setOutputDirectory. Default: false
void setHideFromGui |
( |
bool |
b | ) |
|
- Parameters
-
b | If true, the job will not appear in the queue. Default: false |
bool hideFromGui |
( |
| ) |
const |
- Returns
- If true, the job will not appear in the queue. Default: false
void setPopupOnStateChange |
( |
bool |
b | ) |
|
- Parameters
-
b | If true, changes in the job state will trigger a popup notification from the MoleQueue system tray icon. Default: false |
bool popupOnStateChange |
( |
| ) |
const |
- Returns
- If true, changes in the job state will trigger a popup notification from the MoleQueue system tray icon. Default: false
void setNumberOfCores |
( |
int |
num | ) |
|
- Parameters
-
num | The total number of processor cores to use (if applicable). Default: 1 |
int numberOfCores |
( |
| ) |
const |
- Returns
- The total number of processor cores to use (if applicable). Default: 1
void setMaxWallTime |
( |
int |
minutes | ) |
|
- Parameters
-
minutes | The maximum walltime for this job in minutes. Setting this to a value <= 0 will use the queue-specific default max walltime. Only available for remote queues. Default is -1. |
int maxWallTime |
( |
| ) |
const |
- Returns
- The maximum walltime for this job in minutes. Setting this to a value <= 0 will use the queue-specific default max walltime. Only available for remote queues. Default is -1.
void setMoleQueueId |
( |
IdType |
id | ) |
|
- Parameters
-
id | Internal MoleQueue identifier |
IdType moleQueueId |
( |
| ) |
const |
- Returns
- Internal MoleQueue identifier
void setQueueId |
( |
IdType |
id | ) |
|
QHash<QString, QString>& keywordsRef |
( |
| ) |
|
- Returns
- A reference to the job's keyword hash
void setKeywords |
( |
const QHash< QString, QString > & |
keyrep | ) |
|
- Parameters
-
keyrep | The keyword replacement hash |
QHash<QString, QString> keywords |
( |
| ) |
const |
- Returns
- The keyword replacement hash
QJsonObject toJsonObject |
( |
| ) |
const |
- Returns
- The Job's internal state as a QJsonObject
void setFromJson |
( |
const QJsonObject & |
state | ) |
|
Update the Job's internal state from a QJsonObject.
bool load |
( |
const QString & |
stateFilename | ) |
|
Initialize the JobData from the state in JSON file stateFileName.
Write a mqjobinfo.json file to the JobData's local working directory with the job state.
Called when the JobData is modified.
FileSpecification objects describing additional input files, to be placed in the working directory of the job prior to execution.
QString m_outputDirectory |
|
protected |
String containing a location to copy the output files to after the job completes. Ignored if empty.
QString m_localWorkingDirectory |
|
protected |
Temporary working directory where files are stored during job execution.
If true, delete any working files on the remote server. Default: false.
If true, copies files back from remote server. Default: true.
bool m_cleanLocalWorkingDirectory |
|
protected |
If true, the local working files are removed after job is complete. Should be used with setOutputDirectory. Default: false
If true, the job will not appear in the queue. Default: false.
bool m_popupOnStateChange |
|
protected |
If true, changes in the job state will trigger a popup notification from the MoleQueue system tray icon. Default: true
The total number of processor cores to use (if applicable). Default: 1
The maximum walltime for this job in minutes. Setting this to a value <= 0 will use the queue-specific default max walltime. Only available for remote queues. Default is -1.
Internal MoleQueue identifier.
QHash<QString, QString> m_keywords |
|
protected |
List of custom keyword replacements for the job's launch script.
The documentation for this class was generated from the following file: