Package net.simplace.pipe.processors
Class SaveScenarioProcessor
java.lang.Object
net.simplace.pipe.control.FWProcessor
net.simplace.pipe.processors.SaveScenarioProcessor
Saves the actual scenario within the scenario result database. After doing this the result tree
is updated automatically.
Parameter
Description
comma-separated list of parameters to save additionally to the automatic parameters
required Parameter read from PipeLine Map
required Parameter read from PipeLine Map
required Parameter read from PipeLine Map
parameterlist
scenarioname
scenariodesc
scenarioOID
- Author:
- Andreas Enders
-
Field Summary
Fields inherited from class net.simplace.pipe.control.FWProcessor
iAllreadyLoopedCount, iContainer, iInObservable, iObservable, iProgressTasks
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
Checks that all required parameters have been specified.protected boolean
Can be overridden to perform semantic checks on the pipeline Input.boolean
process()
Saves a selected subset of the input parameter map as scenario.Methods inherited from class net.simplace.pipe.control.FWProcessor
clone, 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
-
SaveScenarioProcessor
public SaveScenarioProcessor()
-
-
Method Details
-
process
Saves a selected subset of the input parameter map as scenario.- Specified by:
process
in classFWProcessor
- Returns:
- success
- Throws:
PipeLineException
-
checkInParameterMap
protected boolean checkInParameterMap()Checks that all required parameters have been specified. In this case, the only required parameter is 'parameterlist'.- Overrides:
checkInParameterMap
in classFWProcessor
- Returns:
- true if not overridden by implementations
-
checkOutParameterMap
protected boolean checkOutParameterMap()Description copied from class:FWProcessor
Can be overridden to perform semantic checks on the pipeline Input.- Overrides:
checkOutParameterMap
in classFWProcessor
- Returns:
- true if not overridden
-