The MoleQueueWidget class provides a widget for configuring and submitting a MoleQueue::JobObject.
#include <avogadro/molequeue/molequeuewidget.h>
::MoleQueue::JobObject& jobTemplate |
( |
| ) |
|
A "template" MoleQueue::JobObject that is used to initialize the GUI. Should be fully configured to submit, as this is used to initialize job that will be submitted by submitJobRequest.
const ::MoleQueue::JobObject& jobTemplate |
( |
| ) |
const |
A "template" MoleQueue::JobObject that is used to initialize the GUI. Should be fully configured to submit, as this is used to initialize job that will be submitted by submitJobRequest.
void setJobTemplate |
( |
const ::MoleQueue::JobObject & |
job | ) |
|
|
slot |
A "template" MoleQueue::JobObject that is used to initialize the GUI. Should be fully configured to submit, as this is used to initialize job that will be submitted by submitJobRequest.
void showAndSelectProgram |
( |
const QString & |
programName | ) |
|
Expand all queue nodes that contain a program that matches programName and select the first matching program node. Matches are case insensitive.
bool submissionSuccess |
( |
| ) |
const |
- Returns
- True if the last submission was successful. Only valid after jobSubmitted has been emitted.
QString jobState |
( |
| ) |
const |
- Returns
- True if the last submission was successful. Only valid after jobSubmitted has been emitted.
bool jobCompleted |
( |
| ) |
const |
- Returns
- True if the job has finished running.
bool jobSuccess |
( |
| ) |
const |
- Returns
- true if the job completed without error.
- Returns
- The request id associated with the last call to submitJobRequest. -1 if there was a submission error.
unsigned int moleQueueId |
( |
| ) |
const |
- Returns
- The MoleQueue ID associated with the last submitJobRequest() call. Only valid after jobSubmitted has been emitted.
- Note
- If an error occurs, InvalidMoleQueueId will be returned.
QString submissionError |
( |
| ) |
const |
bool openOutput |
( |
| ) |
const |
- Returns
- True if the user has requested that the output file be opened when the calculation completes.
bool requestJobLookup |
( |
| ) |
|
- Returns
- True if moleQueueId() is valid and the server is connected, false if the request cannot be sent.
void setBatchMode |
( |
bool |
batch | ) |
|
If the widget is in 'batch mode', options that don't make sense are hidden (such as 'open output when finished').
- Returns
- True if the user has selected a program, false otherwise.
::MoleQueue::JobObject configuredJob |
( |
| ) |
const |
- Returns
- A JobObject with the GUI options. Any settings in jobTemplate that are not handled by the GUI are passed through untouched to the new object.
Query the MoleQueue server (if available) for the list of available queues and programs.
Submit the job returned by configuredJob() to MoleQueue.
- Returns
- The request id associated with the submission, or -1 on error.
- Note
- The result of the submission request can be checked by monitoring jobSubmitted, which will always be emitted after this slot is called.
void jobSubmitted |
( |
bool |
success | ) |
|
|
signal |
Emitted after a call to submitJobRequest
- Parameters
-
success | True if the job has been accepted by MoleQueue. |
void jobFinished |
( |
bool |
success | ) |
|
|
signal |
Emitted after jobSubmitted is emitted and the job completes.
- Parameters
-
success | True if the job enters the "Finished" state. False if the job enters the "Canceled" or "Error" states. |
void jobUpdated |
( |
const ::MoleQueue::JobObject & |
job | ) |
|
|
signal |
Emitted after a successful call to requestJobLookup().
- Parameters
-
job | The result of the lookupJob() RPC query. |
const unsigned int InvalidMoleQueueId |
|
static |
The documentation for this class was generated from the following file: