the base class for the various EventLoop drivers that allow to run jobs on different backends More...

#include <Driver.h>

Inheritance diagram for EL::Driver:

Collaboration diagram for EL::Driver:

Public Member Functions
void	testInvariant () const
	test the invariant of this object More...

	Driver ()
	standard default constructor More...

SH::MetaObject *	options ()
	the list of options to jobs with this driver More...

const SH::MetaObject *	options () const

std::string	submit (const Job &job, const std::string &location) const
	submit the given job with the given output location and wait for it to finish More...

std::string	submitOnly (const Job &job, const std::string &location) const
	submit the given job with the given output location and return immediately More...

Static Public Member Functions
static void	resubmit (const std::string &location, const std::string &option)
	resubmit all failed sub-jobs for the job in the given location More...

static bool	retrieve (const std::string &location)
	retrieve all the output for the job in the given location More...

static bool	wait (const std::string &location, unsigned time=60)
	retrieve all the output for the job in the given location and wait until it is finished completely. More...

static void	updateLocation (const std::string &location)
	update the internal location of files, after moving the submission directory More...

static void	mergedOutputSave (Detail::ManagerData &data)
	create and save a sample handler assuming we created all the merged files at the requested locations More...

static void	diskOutputSave (Detail::ManagerData &data)
	make the output sample handler for the given job or stream from the information stored in the histogram files. More...

Protected Member Functions
virtual ::StatusCode	doManagerStep (Detail::ManagerData &data) const

Static Protected Attributes
static bool	abortRetrieve
	this flag is set to true when the wait() function is running and a SIGINT is caught, meaning that control should be returned to the user as soon as possible. More...

Private Member Functions
	ClassDef (Driver, 1)

Private Attributes
SH::MetaObject	m_options
	members directly corresponding to accessors More...

Friends
class	Detail::DriverManager

Detailed Description

the base class for the various EventLoop drivers that allow to run jobs on different backends

The interface here is intended for users to interact with directly, but it is considered an expert level task to define new implementations of this class.

Definition at line 27 of file Driver.h.

Constructor & Destructor Documentation

◆ Driver()

EL::Driver::Driver ( )

standard default constructor

Guarantee: strong

Failures: low level errors I

Member Function Documentation

◆ ClassDef()

EL::Driver::ClassDef	(	Driver	,
		1
	)

private

◆ diskOutputSave()

static void EL::Driver::diskOutputSave ( Detail::ManagerData & data )

static

make the output sample handler for the given job or stream from the information stored in the histogram files.

This is optional, but it is convenient for drivers that use (conventional) writers

Guarantee: basic

Failures: out of memory II
i/o errors

◆ doManagerStep()

virtual ::StatusCode EL::Driver::doManagerStep ( Detail::ManagerData & data ) const

protected

◆ mergedOutputSave()

static void EL::Driver::mergedOutputSave ( Detail::ManagerData & data )

static

create and save a sample handler assuming we created all the merged files at the requested locations

This is optional, but it is convenient for drivers that want to keep their outputs locally.

Guarantee: basic

Failures: out of memory II
i/o errors

◆ options() [1/2]

SH::MetaObject* EL::Driver::options ( )

the list of options to jobs with this driver

Guarantee: no-fail

Postcondition: result != 0

◆ options() [2/2]

const SH::MetaObject* EL::Driver::options ( ) const

◆ resubmit()

static void EL::Driver::resubmit	(	const std::string &	location,
		const std::string &	option
	)

static

resubmit all failed sub-jobs for the job in the given location

\parm option driver-specific option string selecting which jobs to resubmit (and how)

Guarantee: basic, may partially resubmit

Failures: out of memory III
job resubmission errors
job can't be read
job was made with different driver

◆ retrieve()

static bool EL::Driver::retrieve ( const std::string & location )

static

retrieve all the output for the job in the given location

While job failures will cause this method to fail you can typically retry it multiple times if you can use partial results.

Returns: whether the job completed successfully

Guarantee: basic, may partially retrieve

Failures: out of memory III
job failures
job can't be read
job was made with different driver

◆ submit()

std::string EL::Driver::submit	(	const Job &	job,
		const std::string &	location
	)		const

submit the given job with the given output location and wait for it to finish

This is mostly for small jobs and backward compatibility. For longer jobs use submitOnly instead.

Returns: The actual location of the submit directory, if the job was configured to generate a unique directory.

Guarantee: basic, may partially submit

Failures: out of memory II

Failures: can't create directory at location
submission errors

◆ submitOnly()

std::string EL::Driver::submitOnly	(	const Job &	job,
		const std::string &	location
	)		const

submit the given job with the given output location and return immediately

This method allows you to submit jobs to your local batch system, log out and at a later point log back in again.

Returns: The actual location of the submit directory, if the job was configured to generate a unique directory.

Guarantee: basic, may partially submit

Failures: out of memory II
can't create directory at location
submission errors \warn not all drivers support this. some will do all their work in the submit function. \warn you normally need to call wait() or retrieve() before you can use the output.

◆ testInvariant()

void EL::Driver::testInvariant ( ) const

test the invariant of this object

Guarantee: no-fail

◆ updateLocation()

static void EL::Driver::updateLocation ( const std::string & location )

static

update the internal location of files, after moving the submission directory

Guarantee: basic, may update partially

Failures: out of memory II \warn only move the submission directory after all your jobs are finished, or the results will be unpredictable

◆ wait()

static bool EL::Driver::wait	(	const std::string &	location,
		unsigned	time = `60`
	)

static

retrieve all the output for the job in the given location and wait until it is finished completely.

poll the output every time seconds.

While job failures will cause this method to fail you can typically retry it multiple times if you can use partial results.

Typically sleeping for 60 seconds is an appropriate interval, but if it doesn't work for you, you can change it here.

Guarantee: basic, may partially retrieve

Failures: out of memory III
job failures
job can't be read
job was made with different driver

Friends And Related Function Documentation

◆ Detail::DriverManager

friend class Detail::DriverManager

friend

Definition at line 229 of file Driver.h.

Member Data Documentation

◆ abortRetrieve

bool EL::Driver::abortRetrieve

staticprotected

this flag is set to true when the wait() function is running and a SIGINT is caught, meaning that control should be returned to the user as soon as possible.

drivers can use it to abort long running operations in doRetrieve before completion

Definition at line 212 of file Driver.h.

◆ m_options

SH::MetaObject EL::Driver::m_options

private

members directly corresponding to accessors

Definition at line 233 of file Driver.h.

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

Driver.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Driver()

Member Function Documentation

◆ ClassDef()

◆ diskOutputSave()

◆ doManagerStep()

◆ mergedOutputSave()

◆ options() [1/2]

◆ options() [2/2]

◆ resubmit()

◆ retrieve()

◆ submit()

◆ submitOnly()

◆ testInvariant()

◆ updateLocation()

◆ wait()

Friends And Related Function Documentation

◆ Detail::DriverManager

Member Data Documentation

◆ abortRetrieve

◆ m_options