Class LoopSystemscenarioProcessor
java.lang.Object
net.simplace.pipe.control.FWProcessor
net.simplace.pipe.control.FWLoopProcessor
net.simplace.pipe.processors.LoopSystemscenarioProcessor
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.
further parameter: ${other_SystemID} Loops over scenarios of the given System.
further parameter: ${other_scenarioOID} Loops only once over given Scenario.
further information: ${resultFolderMap} will contain resultFolders of the different scenarios
which have been saved in each scenario within parameter resultFolder
- 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.voidInitialises the loop count (fromrunCount, with parameter tokens replaced) and theseparateLoopsflag.protected booleaninterveneRunLoop(net.simplace.core.FWObservable aObservable) Can be overridden to change the parameters of a run before it is started.booleanprocess()Must be overridden to implement concrete pipe procedure.Methods inherited from class FWLoopProcessor
checkOutParameterMap, clone, getLoopCount, getLoopMap, getLoopPipeID, 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
-
LoopSystemscenarioProcessor
public LoopSystemscenarioProcessor()
-
-
Method Details
-
process
Must be overridden to implement concrete pipe procedure.- Specified by:
processin classFWProcessor- Returns:
trueon success;falsemakesFWProcessor.pipe(FWObservable, Integer)fail- Throws:
PipeLineException- if processing fails
-
interveneRunLoop
protected boolean interveneRunLoop(net.simplace.core.FWObservable aObservable) Description copied from class:FWLoopProcessorCan be overridden to change the parameters of a run before it is started.- Overrides:
interveneRunLoopin classFWLoopProcessor- Parameters:
aObservable- the parameters of the run- Returns:
trueto run the pipeline,falseto skip this run; the default returnstrue
-
checkInParameterMap
protected boolean checkInParameterMap()Description copied from class:FWLoopProcessorChecks that the loop pipeline (PipeID, defaultcounterPipe) exists.- Overrides:
checkInParameterMapin classFWLoopProcessor- Returns:
trueif the pipeline exists
-
initLoop
Description copied from class:FWLoopProcessorInitialises the loop count (fromrunCount, with parameter tokens replaced) and theseparateLoopsflag. Called when the processor is created.- Overrides:
initLoopin classFWLoopProcessor- Parameters:
aParameterMap- parameters of the container plus the initial parameters of the processor
-