class WorkerTerminating
WorkerTerminating is a fundamental process that reads an inputObject, processes it and then writes the processed object to the next process in the process network. A Worker process may have a local workerClass instance of type workerClassName that stores intermediate results.
* The process has two parameters that govern its operation; outData and barrier
On termination of the process it outputs a UniversalTerminator object.
Methods required by inputObject:
function( [dataModifier, wc] ) where wc is the local, possibly null, worker class instance
Methods required by workerClass, if present:
initClass(workerInitData)
finalise(finaliseData)
input The
- channel from which the input object to be processed is readoutput The
- channel to which the processed object is writtenfunction The
- name of the method corresponding to the method in the data object that is to be employeddataModifier A
- list of any values to be used by the function method; it is polymorphic in type
and defaults to nulllDetails
- A LocalDetails object containing data pertaining to any local class used by the worker, defaults to null.outData
- If true the process will output each processed input object. If false the process will output
the workerClass once only, after it has processed all the input data objects. The output
only happens after the finalise method has been called. outData defaults to true.barrier
- If not null the worker process will synchronise on a Barrier with other Worker processes in the same Group;
barrier defaults to null, in which case no synchronisation between other Workers will take place.logPhaseName
- an optional string property, which if specified indicates that the process should be logged
otherwise the process will not be loggedlogPropertyName
- the name of a property in the input object that will uniquely identify an instance of the object.
LogPropertyName must be specified if logPhaseName is specifiedType | Name and description |
---|---|
Barrier |
barrier |
List |
dataModifier |
String |
function |
ChannelInput |
input |
LocalDetails |
lDetails |
String |
logPhaseName |
String |
logPropertyName |
boolean |
outData |
ChannelOutput |
output |
Constructor and description |
---|
WorkerTerminating
() |
GPP - Groovy Parallel Patterns generated 06112016 by Jon Kerridge, Edinburgh Napier University - j.kerridge@napier.ac.uk