Package Ganga :: Package GPIDev :: Package Lib :: Package Tasks :: Module Task' :: Class Task
[hide private]
[frames] | no frames]

Class Task

source code

          object --+        
                   |        
   Base.Objects.Node --+    
                       |    
Base.Objects.GangaObject --+
                           |
                          Task

This is a Ganga.GPI.Task implementation class. Refer to Ganga.GPI.Task.__doc__ for documentation.

Nested Classes [hide private]
  _proxyClass
This is a Task without special properties

Inherited from Base.Objects.GangaObject: __metaclass__

Instance Methods [hide private]
 
_auto__init__(self, registry=None) source code
 
appendTransform(self, tf)
Append transform
source code
 
check(self)
This function is called by run() or manually by the user
source code
 
clone(self) source code
 
finaliseTransforms(self)
Check for any things needing doing after a transform has completed
source code
 
getJobs(self, transform=None, partition=None, only_master_jobs=True)
Get the job slice of all jobs that process this task
source code
 
help(self) source code
 
info(self) source code
 
initialize(self) source code
 
insertTransform(self, id, tf)
Insert transfrm tf before index id (counting from 0)
source code
 
n_all(self) source code
 
n_status(self, status) source code
 
overview(self)
Get an ascii art overview over task status.
source code
 
pause(self)
Pause the task - the background thread will not submit new jobs from this task
source code
 
remove(self, remove_jobs='do_nothing')
Delete the task
source code
 
removeTransform(self, id)
Remove the transform with the index id (counting from 0)
source code
 
run(self)
Confirms that this task is fully configured and ready to be run.
source code
 
setBackend(self, backend)
Sets the backend on all transforms
source code
 
setParameter(self, **args)
Use: setParameter(processName="HWW") to set the processName in all applications to "HWW" Warns if applications are not affected because they lack the parameter
source code
 
startup(self)
Startup function on Ganga startup
source code
 
submitJobs(self)
Submits as many jobs as necessary to maintain the float.
source code
 
updateStatus(self)
Updates status based on transform status.
source code

Inherited from Base.Objects.GangaObject: __construct__, __deepcopy__, __getstate__, __init__, __setstate__, _attribute_filter__set__, accept, getJobObject

Inherited from Base.Objects.Node: __copy__, __eq__, __ne__, copyFrom, printSummaryTree, printTree

Inherited from Base.Objects.Node (private): _getParent, _getRoot, _setParent

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

Class Methods [hide private]

Inherited from Base.Objects.GangaObject (private): _declared_property

Class Variables [hide private]
  _category = 'tasks'
  _exportmethods = ['setBackend', 'setParameter', 'insertTransfo...
  _name = 'Task'
  _schema = <Ganga.GPIDev.Schema.Schema.Schema instance at 0x1c9...
  creation_date = <Ganga.GPIDev.Base.Objects.Descriptor object a...
  default_registry = 'tasks'
  float = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x1c93...
  id = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x1c93610>
  name = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x1c933d0>
  resub_limit = <Ganga.GPIDev.Base.Objects.Descriptor object at ...
  status = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x1c9...
  transforms = <Ganga.GPIDev.Base.Objects.Descriptor object at 0...

Inherited from Base.Objects.GangaObject (private): _hidden, _registry

Inherited from Base.Objects.Node (private): _index_cache, _parent

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

_auto__init__(self, registry=None)

source code 
Overrides: Base.Objects.GangaObject._auto__init__

clone(self)

source code 
Overrides: Base.Objects.Node.clone

overview(self)

source code 

Get an ascii art overview over task status. Can be overridden

submitJobs(self)

source code 

Submits as many jobs as necessary to maintain the float. Internal

updateStatus(self)

source code 

Updates status based on transform status. Called from check() or if status of a transform changes


Class Variable Details [hide private]

_exportmethods

Value:
['setBackend',
 'setParameter',
 'insertTransform',
 'appendTransform',
 'removeTransform',
 'check',
 'run',
 'pause',
...

_schema

Value:
<Ganga.GPIDev.Schema.Schema.Schema instance at 0x1c90908>

creation_date

Value:
<Ganga.GPIDev.Base.Objects.Descriptor object at 0x1c934d0>

float

Value:
<Ganga.GPIDev.Base.Objects.Descriptor object at 0x1c93450>

resub_limit

Value:
<Ganga.GPIDev.Base.Objects.Descriptor object at 0x1c93510>

status

Value:
<Ganga.GPIDev.Base.Objects.Descriptor object at 0x1c93350>

transforms

Value:
<Ganga.GPIDev.Base.Objects.Descriptor object at 0x1c93590>