WRENCH  1.10
Cyberinfrastructure Simulation Workbench
Overview Installation Getting Started WRENCH 101 WRENCH 102
Public Types | Public Member Functions | List of all members
wrench::PilotJob Class Reference

A pilot (i.e., non-standard) workflow job that can be submitted to a ComputeService by a WMS (via a JobManager) More...

#include <PilotJob.h>

Inheritance diagram for wrench::PilotJob:
wrench::WorkflowJob

Public Types

enum  State {
  NOT_SUBMITTED, PENDING, RUNNING, EXPIRED,
  FAILED, TERMINATED
}
 Pilot job states. More...
 

Public Member Functions

std::shared_ptr< ComputeServicegetComputeService ()
 Get the compute service provided by the (running) pilot job. More...
 
unsigned long getPriority ()
 Get the pilot job priority value. More...
 
PilotJob::State getState ()
 Get the state of the pilot job. More...
 
void setComputeService (std::shared_ptr< ComputeService > cs)
 Set the compute service on which the pilot job is running. More...
 
- Public Member Functions inherited from wrench::WorkflowJob
virtual ~WorkflowJob ()
 Destructor.
 
std::string getCallbackMailbox ()
 Get the "next" callback mailbox (returns the origin (i.e., workflow) mailbox if the mailbox stack is empty) More...
 
double getEndDate ()
 Get the date at which the job ended (<0 means "never submitted") More...
 
std::string getName ()
 Get the job's name. More...
 
std::string getOriginCallbackMailbox ()
 Get the "origin" callback mailbox. More...
 
std::shared_ptr< ComputeServicegetParentComputeService ()
 Get the parent compute service of the job. More...
 
std::map< std::string, std::string > getServiceSpecificArguments ()
 Return the service-specific arguments that were used during job submission. More...
 
double getSubmitDate ()
 Get the date at which the job was last submitted (<0 means "never submitted") More...
 
std::string popCallbackMailbox ()
 Get the "next" callback mailbox (returns the workflow mailbox if the mailbox stack is empty), and pops it. More...
 
void pushCallbackMailbox (std::string)
 Pushes a callback mailbox. More...
 
void setParentComputeService (std::shared_ptr< ComputeService > compute_service)
 Set the parent compute service of the job. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wrench::WorkflowJob
 WorkflowJob ()
 Constructor. More...
 
unsigned long getNewUniqueNumber ()
 Generate a unique number (for each newly generated job) More...
 
- Protected Attributes inherited from wrench::WorkflowJob
std::stack< std::string > callback_mailbox_stack
 Stack of callback mailboxes (to pop notifications)
 
double end_date
 The date at which the job ended (with success or failure)
 
std::string name
 The job's name.
 
std::shared_ptr< ComputeServiceparent_compute_service
 The compute service to which the job was submitted.
 
std::map< std::string, std::string > service_specific_args
 Service-specific arguments used during job submission.
 
double submit_date
 The date at which the job was last submitted.
 
Workflowworkflow
 The workflow this job belong to.
 

Detailed Description

A pilot (i.e., non-standard) workflow job that can be submitted to a ComputeService by a WMS (via a JobManager)

Member Enumeration Documentation

◆ State

Pilot job states.

Enumerator
NOT_SUBMITTED 

Not submitted yet.

PENDING 

Submitted but not running.

RUNNING 

Running.

EXPIRED 

Expired due to a time-to-live limit.

FAILED 

Failed.

TERMINATED 

Terminated by submitter.

Member Function Documentation

◆ getComputeService()

std::shared_ptr< ComputeService > wrench::PilotJob::getComputeService ( )

Get the compute service provided by the (running) pilot job.

Returns
a compute service

◆ getPriority()

unsigned long wrench::PilotJob::getPriority ( )
virtual

Get the pilot job priority value.

Returns
the pilot job priority value

Reimplemented from wrench::WorkflowJob.

◆ getState()

PilotJob::State wrench::PilotJob::getState ( )

Get the state of the pilot job.

Returns
the state

◆ setComputeService()

void wrench::PilotJob::setComputeService ( std::shared_ptr< ComputeService cs)

Set the compute service on which the pilot job is running.

Parameters
csa compute service

The documentation for this class was generated from the following files: