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

Class Transform

source code

          object --+        
                   |        
   Base.Objects.Node --+    
                       |    
Base.Objects.GangaObject --+
                           |
                          Transform
Known Subclasses:

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

Nested Classes [hide private]
  _proxyClass
Documentation missing.

Inherited from Base.Objects.GangaObject: __metaclass__

Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
_readonly(self)
A transform is read-only if the status is not new.
source code
 
check(self) source code
 
checkCompletedApp(self, app)
Can be overriden to improve application completeness checking
source code
 
checkTaskApplication(self, app)
warns the user if the application is not compatible
source code
 
createNewJob(self, partition)
Returns a new job initialized with the transforms application, backend and name
source code
 
finalise(self)
Finalise the transform - no-op by default
source code
 
fix(self)
This function fixes inconsistencies in application status
source code
 
fqn(self) source code
 
getJobs(self)
Get the job slice of all jobs for this transform
source code
 
getJobsForPartitions(self, partitions)
This is only an example, this class should be overridden by derived classes
source code
 
getNewAppID(self, partition)
Returns a new application ID and associates this ID with the partition given.
source code
 
getNextPartitions(self, n)
Returns the N next partitions to process
source code
 
getPartitionApps(self) source code
 
getPartitionFailures(self, partition)
Return the number of failures for this partition
source code
 
getPartitionJobs(self, partition)
Get the job slice that processed the given partition.
source code
 
getPartitionStatus(self, partition) source code
 
info(self) source code
 
initialize(self) source code
 
n_all(self) source code
 
n_status(self, status) source code
 
notifyNextTransform(self, partition)
Notify any dependant transforms of the input update
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
 
retryFailed(self)
Retry all failed partitions (forget about failed jobs)
source code
 
run(self, check=True)
Sets this transform to running status
source code
 
setAppStatus(self, app, new_status)
Reports status changes in application jobs possible status values: normal : (new, submitting,) submitted, running, completing, completed failures : killed, failed transient: incomplete (->new), unknown, removed
source code
 
setFailed(self, partition)
Tells Tasks that all Applications that have executed this partition have actually failed.
source code
 
setPartitionStatus(self, partition, status)
Set the Status of the given partition to "ready", "hold", "bad" or "completed".
source code
 
setPartitionsLimit(self, limitpartition)
Set all partitions from and including limitpartition to ignored
source code
 
setPartitionsStatus(self, partitions, status)
Set the Status of the partitions to "ready", "hold", "bad" or "completed".
source code
 
setRunlimit(self, newRL)
Set the number of times a job should be resubmitted before the transform is paused
source code
 
startup(self)
This function is used to set the status after restarting Ganga
source code
 
submitJobs(self, n)
Create Ganga Jobs for the next N partitions that are ready and submit them.
source code
 
updateInputStatus(self, ltf, partition)
Is called my the last transform (ltf) if the partition 'partition' changes status
source code
 
updatePartitionStatus(self, partition)
Calculate the correct status of the given partition.
source code
 
updateStatus(self, status)
Update the transform status
source code

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

Inherited from Base.Objects.Node: __copy__, __eq__, __ne__, clone, 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]
  _app_partition = <Ganga.GPIDev.Base.Objects.Descriptor object ...
  _app_status = <Ganga.GPIDev.Base.Objects.Descriptor object at ...
  _category = 'transforms'
  _exportmethods = ['run', 'pause', 'setPartitionStatus', 'setRu...
  _name = 'Transform'
  _next_app_id = <Ganga.GPIDev.Base.Objects.Descriptor object at...
  _partition_apps = None
hash(x)
  _partition_status = <Ganga.GPIDev.Base.Objects.Descriptor obje...
  _schema = <Ganga.GPIDev.Schema.Schema.Schema instance at 0x1cb...
  application = <Ganga.GPIDev.Base.Objects.Descriptor object at ...
  backend = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x1c...
  inputdata = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x...
  inputsandbox = <Ganga.GPIDev.Base.Objects.Descriptor object at...
  name = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x1cba1d0>
  outputdata = <Ganga.GPIDev.Base.Objects.Descriptor object at 0...
  outputsandbox = <Ganga.GPIDev.Base.Objects.Descriptor object a...
  run_limit = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x...
  status = <Ganga.GPIDev.Base.Objects.Descriptor object at 0x1cb...

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]

__init__(self)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

_readonly(self)

source code 

A transform is read-only if the status is not new.

Overrides: Base.Objects.GangaObject._readonly

getPartitionJobs(self, partition)

source code 

Get the job slice that processed the given partition. Iterates over the job list.

overview(self)

source code 

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

setPartitionStatus(self, partition, status)

source code 

Set the Status of the given partition to "ready", "hold", "bad" or "completed". The status is then updated to the status indicated by the applications

setPartitionsStatus(self, partitions, status)

source code 

Set the Status of the partitions to "ready", "hold", "bad" or "completed". The status is then updated to the status indicated by the applications "bad" and "completed" is never changed except to "ignored", "hold" is only changed to "completed".

updatePartitionStatus(self, partition)

source code 

Calculate the correct status of the given partition. "completed" and "bad" is never changed here "hold" is only changed to "completed" here.


Class Variable Details [hide private]

_app_partition

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

_app_status

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

_exportmethods

Value:
['run',
 'pause',
 'setPartitionStatus',
 'setRunlimit',
 'setFailed',
 'getPartitionStatus',
 'getJobs',
 'getPartitionJobs',
...

_next_app_id

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

_partition_status

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

_schema

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

application

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

backend

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

inputdata

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

inputsandbox

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

outputdata

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

outputsandbox

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

run_limit

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

status

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