arcjobtool :: Tasks :: BaseTask :: Class BaseTask

[frames] | no frames]

Class BaseTask

source code

Instance Methods

[hide private]

__init__(self, createRunScript=True)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

addInputFile(self, inputFile, url='') source code

addAndCopyInputFile(self, inputFile, copyFile=True)
Add and copy input files to task workdir.

source code

clearInputFiles(self)

source code

removeInputFile(self, inputFile)

source code

addSweepFile(self, sweepFile)

source code

clearSweepFiles(self)

source code

removeSweepFile(self, sweepFile)

source code

addOutputFile(self, outputFile, url='') source code

clearOutputFiles(self)

source code

addCluster(self, cluster)

source code

clearClusters(self)

source code

tagAsExecutable(self, filename)

source code

clearExecutableTags(self)

source code

addRuntimeEnvironment(self, runtimeEnvironment)

source code

clearRuntimeEnvironments(self)

source code

__setstate__(self, state)

source code

onUpdateState(self, state, version)
Add or remove task attributes that has changed from the version loaded from disk.

source code

setup(self)

source code

clean(self)

source code

__saveDefaultConfig(self, config)

source code

__loadDefaultConfig(self, config)

source code

save(self)

source code

load(self)

source code

onSaveConfig(self, config)

source code

onLoadConfig(self, config)

source code

getJobList(self)
Return a list of job descriptions and directories

source code

getJobInfo(self)
Return a list of job directories

source code

_existInList(self, stringList, pattern)

source code

onSetupTaskDirs(self)

source code

onCleanTaskDirs(self)

source code

onAssignTemplateName(self, templateString, taskName)

source code

onAssignTemplateId(self, templateString, taskId)

source code

onAssignTemplateSweepSize(self, templateString, sweepSize)

source code

onAssignTemplateValue(self, templateString, taskValue)

source code

onCalculateSweepValueFloat(self, taskId, sweepSize)

source code

onCalculateSweepValueInt(self, taskId, sweepSize)

source code

onCreateRunScript(self, taskName, taskId)
Abstract routine responsible for returning a run-script for the job.

source code

onSetupScripts(self)
Abstract routine responsible for creating the necessary files that make up the grid task, such as scripts, XRSL and input files.

source code

onClean(self)
Abstract routine responsible for cleaning any temporay files created by the setup() routine.

source code

onRefresh(self)
If any new attributes are added in new versions of a task the refresh method is responsible for checking for these and adding/removing them if they do not exist.

source code

onCreateJobDescription(self, taskName, taskId, taskDir)
Abstract routines responsible for returning a jobdescription for the job.

source code

getInputFiles(self)

source code

getOutputFiles(self)

source code

getRuntimeEnvironments(self)

source code

getClusters(self)

source code

getExecutables(self)

source code

getSweepParams(self)

source code

getSweepFiles(self)

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

inputFiles

outputFiles

runtimeEnvironments

clusters

executables

sweepParams

sweepFiles

jobList
Return a list of job descriptions and directories

jobInfo
Return a list of job directories

Inherited from object: __class__

Method Details

[hide private]

init(self, createRunScript=True)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

Property Details

[hide private]

inputFiles

Get Method:: getInputFiles(self)

outputFiles

Get Method:: getOutputFiles(self)

runtimeEnvironments

Get Method:: getRuntimeEnvironments(self)

clusters

Get Method:: getClusters(self)

executables

Get Method:: getExecutables(self)

sweepParams

Get Method:: getSweepParams(self)

sweepFiles

Get Method:: getSweepFiles(self)

jobList

Return a list of job descriptions and directories

Get Method:: getJobList(self) - Return a list of job descriptions and directories

jobInfo

Return a list of job directories

Get Method:: getJobInfo(self) - Return a list of job directories

Class BaseTask

__init__(self, createRunScript=True) (Constructor)

inputFiles

outputFiles

runtimeEnvironments

clusters

executables

sweepParams

sweepFiles

jobList

jobInfo

init(self, createRunScript=True)
(Constructor)