Class LoopCounterProcessor
java.lang.Object
net.simplace.pipe.control.FWProcessor
net.simplace.pipe.control.FWLoopProcessor
net.simplace.pipe.processors.LoopCounterProcessor
Looping processors are running a given Pipeline ${PipeID} several times. The number of loops
is given by the central value (see parameterlist). Loops are separated by default
(${separateLoops} (TRUE|FALSE)). For non separated loops all parameter values created in the
pipeline process are written to parameter map.
Within the looped pipeline you can finde the total run count ${runCount} and the run count ${Count}
This looping processor takes the parameter in ${runCount} to get the number of loop couts pipeline.
further parameter: ${startIndex} gives the first index of ${Count}-Parameter in looping pipeline.
- Author:
- Andreas Enders
-
Field Summary
Fields inherited from class FWLoopProcessor
iLoopCount, iLoopMap, iLoopPipeId, iSeparateRunsFields inherited from class FWProcessor
iAllreadyLoopedCount, iContainer, iInObservable, iObservable, iProgressTasks -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanChecks that the loop pipeline (PipeID, defaultcounterPipe) exists.booleanprocess()Must be overidden to implemnt concrete pipe procedure.Methods inherited from class FWLoopProcessor
checkOutParameterMap, clone, getLoopCount, getLoopMap, getLoopPipeID, initLoop, interveneRunLoop, runLoopMethods inherited from class FWProcessor
containsParameter, createProcessor, createProcessor, fireTaskEvent, getAllStringInParameters, getConfiguration, getInitialParameters, getInParameter, getInParameter, getInParameters, getNewProgressTask, getOutParameter, getOutParameterKeys, getPipeLine, getProgressTask, getStringInParameter, getStringInParameter, getSystemID, hasConfiguration, isEndOfPipe, pipe, removeOutParameter, setConfiguration, setEndOfPipeFlag, setInitialParameters, setInParameterMap, setLoopedCount, setOutParameter, setStateOfTask, setStateProgressing, toXML
-
Constructor Details
-
LoopCounterProcessor
public LoopCounterProcessor()
-
-
Method Details
-
process
Must be overidden to implemnt concrete pipe procedure.- Specified by:
processin classFWProcessor- Returns:
trueon success;falsemakesFWProcessor.pipe(FWObservable, Integer)fail- Throws:
PipeLineException- if processing fails
-
checkInParameterMap
protected boolean checkInParameterMap()Description copied from class:FWLoopProcessorChecks that the loop pipeline (PipeID, defaultcounterPipe) exists.- Overrides:
checkInParameterMapin classFWLoopProcessor- Returns:
trueif the pipeline exists
-