net.simplace.pipe.control.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 find the total run count ${runCount} and the run count ${Count} This looping processor takes the parameter in ${looplist} converted to list or map to loop the pipeline. Additionally to Count and runCount you can find the actual looplistentry in parametername: "${looplist}.loop", for maps the actual looplistvalue in parametername: "${looplist}.loopvalue" as a special the looplist can be a String too. Format: comma-separated for lists: "first,next,last" or Format: comma-separated with = and leading and ending brace for maps: "{first=firstvalue,next=nextvalue,last=lastvalue} further parameter: ${startIndex} gives the first index of ${Count}-Parameter in looping pipeline.


public abstract class FWLoopProcessor extends FWProcessor {
// Public Constructors
public FWLoopProcessor();

// Protected Instance Variables
protected int iLoopCount;
protected String iLoopPipeId;
protected boolean iSeparateRuns;
protected Map iLoopMap;

// Public Instance Methods
public FWProcessor clone(); // Defines FWProcessor

public int getLoopCount();


returns the the count of loops, invoked by this processor
public String getLoopPipeID();


returns the the count of loops, invoked by this processor
public void initLoop(Map aParameterMap);

public Map getLoopMap();


returns the LoopMap

// Protected Instance Methods
protected final FWObservable runLoop(String aLoopListParam, Map
aLoopObjectMap, FWObservable aObservable) throws PipeLineException;

Must be overwritten to implement concrete pipe procedure.
returns FWObservable
protected boolean interveneRunLoop(FWObservable observable);

overwrite this method to work on parameters before loop running
returns success
protected boolean checkInParameterMap(); // Defines FWProcessor

protected boolean checkOutParameterMap(); // Defines FWProcessor



}



Hierarchy: java.lang.Object - FWProcessor - FWLoopProcessor



Extended by: net.simplace.pipe.processors.LoopCounterProcessor, net.simplace.pipe.processors.LoopListProcessor, net.simplace.pipe.processors.LoopParameterProcessor, net.simplace.pipe.processors.LoopScenarioProcessor, net.simplace.client.sim.processors.LoopSimModelRunProcessor, net.simplace.pipe.processors.LoopSystemscenarioProcessor, net.simplace.pipe.processors.LoopXMLChildProcessor