wrench::WorkflowTask Class Reference

A computational task in a Workflow. More...

#include <WorkflowTask.h>

Inheritance diagram for wrench::WorkflowTask:

Public Types
enum	State {   NOT_READY, READY, PENDING, COMPLETED,   UNKNOWN }
	Task states. More...

Public Member Functions
void	addInputFile (std::shared_ptr< DataFile >file)
	Add an input file to the task. More...
void	addOutputFile (std::shared_ptr< DataFile >file)
	Add an output file to the task. More...
double	getAverageCPU () const
	Get the task average CPU usage. More...
unsigned long	getBytesRead () const
	Get the number of bytes read by the task. More...
unsigned long	getBytesWritten () const
	Get the number of bytes written by the task. More...
std::vector< std::shared_ptr< WorkflowTask > >	getChildren ()
	Get the children of a task. More...
std::string	getClusterID () const
	Get the cluster Id for the task. More...
std::string	getColor () const
	Get the task's color ("" if none) More...
double	getComputationEndDate () const
	Get the task's most recent computation end date. More...
double	getComputationStartDate () const
	Get the tasks's most recent computation start date. More...
double	getEndDate () const
	Get the task's most recent end date. More...
std::stack< WorkflowTaskExecution >	getExecutionHistory () const
	Get the execution history of this task. More...
std::string	getExecutionHost () const
	Returns the name of the host on which the task has most recently been executed, or "" if the task has never been executed yet. Could be a virtual hostname. More...
unsigned int	getFailureCount ()
	Get the number of times a task has failed. More...
double	getFailureDate () const
	Get the task's most recent failure date. More...
double	getFlops () const
	Get the number of flops of the task. More...
const std::string &	getID () const
	Get the id of the task. More...
std::vector< std::shared_ptr< DataFile > >	getInputFiles () const
	Get the list of input DataFile objects for the task. More...
Job *	getJob () const
	Get the task's containing job. More...
unsigned long	getMaxNumCores () const
	Get the maximum number of cores that the task can use. More...
double	getMemoryRequirement () const
	Get the memory_manager_service requirement of the task. More...
unsigned long	getMinNumCores () const
	Get the minimum number of cores required for running the task. More...
unsigned long	getNumberOfChildren ()
	Get the number of children of a task. More...
unsigned long	getNumberOfParents ()
	Get the number of parents of a task. More...
unsigned long	getNumCoresAllocated () const
	Returns the number of cores allocated for this task's most recent execution or 0 if an execution attempt was never made. More...
std::vector< std::shared_ptr< DataFile > >	getOutputFiles () const
	Get the list of output DataFile objects for the task. More...
std::shared_ptr< ParallelModel >	getParallelModel () const
	Get the task's parallel model. More...
std::vector< std::shared_ptr< WorkflowTask > >	getParents ()
	Get the parents of a task. More...
std::string	getPhysicalExecutionHost () const
	Returns the name of the PHYSICAL host on which the task has most recently been executed, or "" if the task has never been executed yet. More...
unsigned long	getPriority () const
	Get the task priority. By default, priority is 0. More...
double	getReadInputEndDate () const
	Get the task's most recent read input end date. More...
double	getReadInputStartDate () const
	Get the task's most recent read input start date. More...
std::shared_ptr< WorkflowTask >	getSharedPtr ()
double	getStartDate () const
	Get the task's most recent start date. More...
WorkflowTask::State	getState () const
	Get the state of the task. More...
std::string	getStateAsString () const
	Get the state of the task as a string. More...
double	getTerminationDate () const
	Get the tasks's most recent termination date (when it was explicitly requested to be terminated by the execution controller) More...
unsigned long	getTopLevel () const
	Returns the task's top level (max number of hops on a reverse path up to an entry task. Entry tasks have a top-level of 0) More...
std::shared_ptr< Workflow >	getWorkflow () const
	Get the workflow that contains the task. More...
double	getWriteOutputEndDate () const
	Get the task's most recent write output end date. More...
double	getWriteOutputStartDate () const
	Get the task's most recent write output start date. More...
void	setAverageCPU (double)
	Set the task average CPU usage. More...
void	setBytesRead (unsigned long)
	Set the number of bytes read by the task. More...
void	setBytesWritten (unsigned long)
	Set the number of bytes written by the task. More...
void	setClusterID (std::string)
	Set the cluster id for the task. More...
void	setColor (std::string)
	Set the task's color. More...
void	setParallelModel (std::shared_ptr< ParallelModel > model)
	Set the task's parallel model. More...
void	setPriority (long)
	Set the task priority. More...

Static Public Member Functions
static std::string	stateToString (WorkflowTask::State state)
	Convert task state to a string (useful for output, debugging, logging, etc.) More...

Detailed Description

A computational task in a Workflow.

Member Enumeration Documentation

State

enum wrench::WorkflowTask::State

Task states.

Enumerator
NOT_READY	Not ready (parents have not completed)
READY	Ready (parents have completed)
PENDING	Pending (has been submitted to a compute service)
COMPLETED	Completed (successfully completed)
UNKNOWN	Some Unknown state (should not happen)

Member Function Documentation

addInputFile()

void wrench::WorkflowTask::addInputFile

(

std::shared_ptr< DataFile >

file

)

Add an input file to the task.

Parameters

file

the file

Exceptions

std::invalid_argument

addOutputFile()

void wrench::WorkflowTask::addOutputFile

(

std::shared_ptr< DataFile >

file

)

Add an output file to the task.

Parameters

file

the file

getAverageCPU()

double wrench::WorkflowTask::getAverageCPU

(

)

const

Get the task average CPU usage.

Returns

the task average CPU usage

getBytesRead()

unsigned long wrench::WorkflowTask::getBytesRead

(

)

const

Get the number of bytes read by the task.

Returns

number of bytes read by the task in KB

getBytesWritten()

unsigned long wrench::WorkflowTask::getBytesWritten

(

)

const

Get the number of bytes written by the task.

Returns

number of bytes written by the task in KB

getChildren()

std::vector< std::shared_ptr< WorkflowTask > > wrench::WorkflowTask::getChildren

(

)

Get the children of a task.

Returns

a list of workflow tasks

getClusterID()

std::string wrench::WorkflowTask::getClusterID

(

)

const

Get the cluster Id for the task.

Returns

a cluster id, or an empty string

getColor()

std::string wrench::WorkflowTask::getColor

(

)

const

Get the task's color ("" if none)

Returns

A color string in "#rrggbb" format

getComputationEndDate()

double wrench::WorkflowTask::getComputationEndDate

(

)

const

Get the task's most recent computation end date.

Returns

the date when the computation portion of a task ended (-1 if computation has not ended yet or if no execution history exists for this task yet)

getComputationStartDate()

double wrench::WorkflowTask::getComputationStartDate

(

)

const

Get the tasks's most recent computation start date.

Returns

the date when the computation portion of a task started (-1 if computation has not started yet or if no execution history exists for this task yet)

getEndDate()

double wrench::WorkflowTask::getEndDate

(

)

const

Get the task's most recent end date.

Returns

a end date (-1 if task has not completed yet or if no execution history exists for this task yet)

getExecutionHistory()

std::stack< WorkflowTask::WorkflowTaskExecution > wrench::WorkflowTask::getExecutionHistory

(

)

const

Get the execution history of this task.

Returns

a stack of WorkflowTaskExecution objects, one for each attempted execution of the task

getExecutionHost()

std::string wrench::WorkflowTask::getExecutionHost

(

)

const

Returns the name of the host on which the task has most recently been executed, or "" if the task has never been executed yet. Could be a virtual hostname.

Returns

hostname

getFailureCount()

unsigned int wrench::WorkflowTask::getFailureCount

(

)

Get the number of times a task has failed.

Returns

a failure count

getFailureDate()

double wrench::WorkflowTask::getFailureDate

(

)

const

Get the task's most recent failure date.

Returns

the date when the task failed (-1 if it didn't fail or if no execution history exists for this task yet)

getFlops()

double wrench::WorkflowTask::getFlops

(

)

const

Get the number of flops of the task.

Returns

a number of flops

getID()

const std::string & wrench::WorkflowTask::getID

(

)

const

Get the id of the task.

Returns

an id as a string

getInputFiles()

std::vector< std::shared_ptr< DataFile > > wrench::WorkflowTask::getInputFiles

(

)

const

Get the list of input DataFile objects for the task.

Returns

a list workflow files

getJob()

Job * wrench::WorkflowTask::getJob

(

)

const

Get the task's containing job.

Returns

job: the job

getMaxNumCores()

unsigned long wrench::WorkflowTask::getMaxNumCores

(

)

const

Get the maximum number of cores that the task can use.

Returns

a number of cores

getMemoryRequirement()

double wrench::WorkflowTask::getMemoryRequirement

(

)

const

Get the memory_manager_service requirement of the task.

Returns

a memory_manager_service requirement (in bytes)

getMinNumCores()

unsigned long wrench::WorkflowTask::getMinNumCores

(

)

const

Get the minimum number of cores required for running the task.

Returns

a number of cores

getNumberOfChildren()

unsigned long wrench::WorkflowTask::getNumberOfChildren

(

)

Get the number of children of a task.

Returns

a number of children

getNumberOfParents()

unsigned long wrench::WorkflowTask::getNumberOfParents

(

)

Get the number of parents of a task.

Returns

a number of parents

getNumCoresAllocated()

unsigned long wrench::WorkflowTask::getNumCoresAllocated

(

)

const

Returns the number of cores allocated for this task's most recent execution or 0 if an execution attempt was never made.

Returns

number of cores

getOutputFiles()

std::vector< std::shared_ptr< DataFile > > wrench::WorkflowTask::getOutputFiles

(

)

const

Get the list of output DataFile objects for the task.

Returns

a list of workflow files

getParallelModel()

std::shared_ptr< ParallelModel > wrench::WorkflowTask::getParallelModel

(

)

const

Get the task's parallel model.

Returns

the parallel model

getParents()

std::vector< std::shared_ptr< WorkflowTask > > wrench::WorkflowTask::getParents

(

)

Get the parents of a task.

Returns

a list of workflow tasks

getPhysicalExecutionHost()

std::string wrench::WorkflowTask::getPhysicalExecutionHost

(

)

const

Returns the name of the PHYSICAL host on which the task has most recently been executed, or "" if the task has never been executed yet.

Returns

hostname

getPriority()

unsigned long wrench::WorkflowTask::getPriority

(

)

const

Get the task priority. By default, priority is 0.

Returns

the task priority

getReadInputEndDate()

double wrench::WorkflowTask::getReadInputEndDate

(

)

const

Get the task's most recent read input end date.

Returns

the date when the read input portion of the task has completed (-1 if it has not begun or if no execution history exists for this task yet)

getReadInputStartDate()

double wrench::WorkflowTask::getReadInputStartDate

(

)

const

Get the task's most recent read input start date.

Returns

the date when the read input portion of the task has begun (-1 if it has not yet begun or if no execution history exists for this task yet)

getStartDate()

double wrench::WorkflowTask::getStartDate

(

)

const

Get the task's most recent start date.

Returns

a start date (-1 if task has not started yet)

getState()

WorkflowTask::State wrench::WorkflowTask::getState

(

)

const

Get the state of the task.

Returns

a task state

getStateAsString()

std::string wrench::WorkflowTask::getStateAsString

(

)

const

Get the state of the task as a string.

Returns

a string

getTerminationDate()

double wrench::WorkflowTask::getTerminationDate

(

)

const

Get the tasks's most recent termination date (when it was explicitly requested to be terminated by the execution controller)

Returns

the date when the task was terminated (-1 if it wasn't terminated or if not execution history exists for this task yet)

getTopLevel()

unsigned long wrench::WorkflowTask::getTopLevel

(

)

const

Returns the task's top level (max number of hops on a reverse path up to an entry task. Entry tasks have a top-level of 0)

Returns

getWorkflow()

std::shared_ptr< Workflow > wrench::WorkflowTask::getWorkflow

(

)

const

Get the workflow that contains the task.

Returns

a workflow

getWriteOutputEndDate()

double wrench::WorkflowTask::getWriteOutputEndDate

(

)

const

Get the task's most recent write output end date.

Returns

the date when the write output portion of a task has completed (-1 if it has not completed yet or if no execution history exists for this task yet)

getWriteOutputStartDate()

double wrench::WorkflowTask::getWriteOutputStartDate

(

)

const

Get the task's most recent write output start date.

Returns

the date when the write output portion of a task has begun (-1 if it has not yet started or if no execution history exists for this task yet)

setAverageCPU()

void wrench::WorkflowTask::setAverageCPU

(

double

average_cpu

)

Set the task average CPU usage.

Parameters

average_cpu

task average CPU usage

setBytesRead()

void wrench::WorkflowTask::setBytesRead

(

unsigned long

bytes_read

)

Set the number of bytes read by the task.

Parameters

bytes_read

number of bytes read by the task in KB

setBytesWritten()

void wrench::WorkflowTask::setBytesWritten

(

unsigned long

bytes_written

)

Set the number of bytes written by the task.

Parameters

bytes_written

number of bytes written by the task in KB

setClusterID()

void wrench::WorkflowTask::setClusterID

(

std::string

id

)

Set the cluster id for the task.

Parameters

id	cluster id the task belongs to

setColor()

void wrench::WorkflowTask::setColor

(

std::string

color

)

Set the task's color.

Parameters

color

A color string in "#rrggbb" format

setParallelModel()

void wrench::WorkflowTask::setParallelModel

(

std::shared_ptr< ParallelModel >

model

)

Set the task's parallel model.

Parameters

model

a parallel model

setPriority()

void wrench::WorkflowTask::setPriority

(

long

priority

)

Set the task priority.

Parameters

priority

task priority

stateToString()

std::string wrench::WorkflowTask::stateToString ( WorkflowTask::State  state )

static

Convert task state to a string (useful for output, debugging, logging, etc.)

Get a task internal state as a string.

Parameters

state

task state

Returns

a string

Parameters

internal_state

the internal state

Returns

an internal state as a string

---

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

• WorkflowTask.h
• WorkflowTask.cpp