Package net.simplace.pipe.processors

Klasse LoopScenarioProcessor

java.lang.Object

net.simplace.pipe.control.FWProcessor

net.simplace.pipe.control.FWLoopProcessor

net.simplace.pipe.processors.LoopScenarioProcessor

public final class LoopScenarioProcessor
extends FWLoopProcessor

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. Loops the pipeline ${PipeID} through configurations given in Configuration tag. Example: 1 1 6 2 1 10 0.5 1 1 6 2 1 10 0.5 set ${runCount} with sum of all scenarios for giving progressbar possibility to loop it through (in above example 56!. use ${Count} for getting the Count of the scenario use ${runInfo} for getting information of the changed parameter-key.

Autor:

Andreas Enders

Feldübersicht

Von Klasse geerbte Felder net.simplace.pipe.control.FWLoopProcessor

iLoopCount, iLoopMap, iLoopPipeId, iSeparateRuns

Von Klasse geerbte Felder net.simplace.pipe.control.FWProcessor

iAllreadyLoopedCount, iContainer, iInObservable, iObservable, iProgressTasks

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
LoopScenarioProcessor()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected boolean	checkInParameterMap()	Can be overridden to perform semantic checks on the pipeline Input.
protected boolean	checkOutParameterMap()	Can be overridden to perform semantic checks on the pipeline Input.
void	initLoop(Map<String,Object> aParameterMap)
protected boolean	interveneRunLoop(FWObservable aObservable)	overwrite this method to work on parameters before loop running
boolean	process()	Must be overridden to implement concrete pipe procedure.

Von Klasse geerbte Methoden net.simplace.pipe.control.FWLoopProcessor

clone, getLoopCount, getLoopMap, getLoopPipeID, runLoop

Von Klasse geerbte Methoden net.simplace.pipe.control.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

Von Klasse geerbte Methoden java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Konstruktordetails

LoopScenarioProcessor

public LoopScenarioProcessor()

Methodendetails

process

public boolean process()
                throws PipeLineException

Must be overridden to implement concrete pipe procedure.

Angegeben von:

process in Klasse FWProcessor

Gibt zurück:

success

Löst aus:

PipeLineException

interveneRunLoop

protected boolean interveneRunLoop(FWObservable aObservable)

Beschreibung aus Klasse kopiert: FWLoopProcessor

overwrite this method to work on parameters before loop running

Setzt außer Kraft:

interveneRunLoop in Klasse FWLoopProcessor

Parameter:

aObservable -

Gibt zurück:

success

checkInParameterMap

protected boolean checkInParameterMap()

Beschreibung aus Klasse kopiert: FWProcessor

Can be overridden to perform semantic checks on the pipeline Input.

Setzt außer Kraft:

checkInParameterMap in Klasse FWLoopProcessor

Gibt zurück:

true if not overridden by implementations

checkOutParameterMap

protected boolean checkOutParameterMap()

Beschreibung aus Klasse kopiert: FWProcessor

Can be overridden to perform semantic checks on the pipeline Input.

Setzt außer Kraft:

checkOutParameterMap in Klasse FWLoopProcessor

Gibt zurück:

true if not overridden

initLoop

public void initLoop(Map<String,Object> aParameterMap)

Setzt außer Kraft:

initLoop in Klasse FWLoopProcessor

Parameter:

aParameterMap -