A class to describe a unit of work that's a sub-component of a StandardJob. More...

#include <Workunit.h>

Public Member Functions
	Workunit (std::shared_ptr< StandardJob > job, std::vector< std::tuple< WorkflowFile , std::shared_ptr< FileLocation >, std::shared_ptr< FileLocation >>> pre_file_copies, WorkflowTask task, std::map< WorkflowFile , std::shared_ptr< FileLocation >> file_locations, std::vector< std::tuple< WorkflowFile , std::shared_ptr< FileLocation >, std::shared_ptr< FileLocation >>> post_file_copies, std::vector< std::tuple< WorkflowFile *, std::shared_ptr< FileLocation >>> cleanup_file_deletions)
	Constructor. More...

std::shared_ptr< StandardJob >	getJob ()
	Retrieve the standard job this workunit belongs to. More...

Static Public Member Functions
static void	addDependency (std::shared_ptr< Workunit > parent, std::shared_ptr< Workunit > child)
	Add a dependency between two work units (does nothing if the dependency already exists) More...

static std::set< std::shared_ptr< Workunit > >	createWorkunits (std::shared_ptr< StandardJob > job)
	Create all work units for a newly dispatched job. More...

Public Attributes
std::set< std::shared_ptr< Workunit > >	children
	The Workunits that depend on this Workunit.

std::vector< std::tuple< WorkflowFile *, std::shared_ptr< FileLocation > > >	cleanup_file_deletions
	File deletions to perform last.

std::map< WorkflowFile *, std::shared_ptr< FileLocation > >	file_locations
	Locations where computational tasks should read/write files.

std::shared_ptr< StandardJob >	job
	The StandardJob this Workunit belongs to.

unsigned long	num_pending_parents
	The number of Workunits this Workunit depends on.

std::vector< std::tuple< WorkflowFile *, std::shared_ptr< FileLocation >, std::shared_ptr< FileLocation > > >	post_file_copies
	File copies to perform after computational tasks completes.

std::vector< std::tuple< WorkflowFile *, std::shared_ptr< FileLocation >, std::shared_ptr< FileLocation > > >	pre_file_copies
	File copies to perform before computational tasks begin.

WorkflowTask *	task = nullptr
	Computational task to perform.

Detailed Description

A class to describe a unit of work that's a sub-component of a StandardJob.

Constructor & Destructor Documentation

wrench::Workunit::Workunit	(	std::shared_ptr< StandardJob >	job,
		std::vector< std::tuple< WorkflowFile *, std::shared_ptr< FileLocation >, std::shared_ptr< FileLocation >>>	pre_file_copies,
		WorkflowTask *	task,
		std::map< WorkflowFile *, std::shared_ptr< FileLocation >>	file_locations,
		std::vector< std::tuple< WorkflowFile *, std::shared_ptr< FileLocation >, std::shared_ptr< FileLocation >>>	post_file_copies,
		std::vector< std::tuple< WorkflowFile *, std::shared_ptr< FileLocation >>>	cleanup_file_deletions
	)

Constructor.

Parameters

job	the job this workunit belongs to
pre_file_copies	a vector of file copy actions to perform in sequence first
task	a WorkflowTask
file_locations	locations where tasks should read/write files
post_file_copies	a vector of file copy actions to perform in sequence after all tasks
cleanup_file_deletions	a vector of file deletion actions to perform last

void wrench::Workunit::addDependency	(	std::shared_ptr< Workunit >	parent,
		std::shared_ptr< Workunit >	child
	)

static

Add a dependency between two work units (does nothing if the dependency already exists)

Parameters

parent	the parent work unit
child	the child work unit

Exceptions

std::invalid_argument

std::set< std::shared_ptr< Workunit > > wrench::Workunit::createWorkunits ( std::shared_ptr< StandardJob > job )

static

Create all work units for a newly dispatched job.

Parameters

job the job

std::shared_ptr< StandardJob > wrench::Workunit::getJob ( )

Retrieve the standard job this workunit belongs to.

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