|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.cau.cs.kieler.sim.kiem.internal.AbstractDataComponent
de.cau.cs.kieler.sim.kiem.JSONObjectDataComponent
de.cau.cs.kieler.sim.kiem.automated.AbstractAutomatedComponent
de.cau.cs.kieler.sim.kiem.automated.AbstractAutomatedProducer
de.cau.cs.kieler.krep.sim.DataComponent
public final class DataComponent
Integrates the KReP execution into KIELER.
Field Summary |
---|
Fields inherited from class de.cau.cs.kieler.sim.kiem.internal.AbstractDataComponent |
---|
MASTER_CMD_MACROSTEP, MASTER_CMD_PAUSE, MASTER_CMD_RUN, MASTER_CMD_STEP, MASTER_CMD_STEPBACK, MASTER_CMD_STOP |
Fields inherited from interface de.cau.cs.kieler.sim.kiem.automated.IAutomatedComponent |
---|
ITERATION, MODEL_FILE |
Constructor Summary | |
---|---|
DataComponent()
|
Method Summary | |
---|---|
String |
getDataComponentId()
Gets the String representation id of a DataComponent. |
String[] |
getSupportedExtensions()
This component doesn't support any files. |
void |
initialize()
Initialize. |
boolean |
isObserver()
To check whether the DataComponent is an observer. |
boolean |
isProducer()
To check whether the DataComponent is a producer. |
List<KiemProperty> |
produceInformation()
The default implementation produces no information. |
JSONObject |
provideInitialVariables()
Provide (local) interface variables and possible initial values. |
KiemProperty[] |
provideProperties()
Provide properties for this component. |
void |
setParameters(List<KiemProperty> properties)
The default implementation only retrieves the model file and the current iteration index. |
JSONObject |
step(JSONObject data)
Step method for a DataObserver and a DataPrroducer. |
int |
wantsMoreRuns()
The default implementation doesn't need any runs. |
int |
wantsMoreSteps()
The default implementation doesn't need any steps. |
void |
wrapup()
Wrap-up. |
Methods inherited from class de.cau.cs.kieler.sim.kiem.automated.AbstractAutomatedProducer |
---|
produceModelFileInformation |
Methods inherited from class de.cau.cs.kieler.sim.kiem.automated.AbstractAutomatedComponent |
---|
getIteration, getModelFile |
Methods inherited from class de.cau.cs.kieler.sim.kiem.JSONObjectDataComponent |
---|
getInitialVariables, provideFilterKeysJSON, setInitialVariables |
Methods inherited from class de.cau.cs.kieler.sim.kiem.internal.AbstractDataComponent |
---|
checkProperties, finalize, getConfigurationElement, getName, getPluginId, getProperties, isDeltaObserver, isHistoryObserver, isHistoryStep, isInvisible, isMacroStepDone, isMaster, isMasterImplementingGUI, isMultiInstantiable, masterCommand, masterGetAimedStepDuration, masterGUI, masterGUIisEnabled, masterIsPaused, masterIsRunning, masterSetAimedStepDuration, masterSetKIEMInstance, notifyEvent, provideEventOfInterest, provideFilterKeys, setConfigurationElemenet, setHistoryStep, setInitializationData, setProperties |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DataComponent()
Method Detail |
---|
public String getDataComponentId()
AbstractDataComponent
getDataComponentId
in class AbstractDataComponent
public JSONObject step(JSONObject data) throws KiemExecutionException
KiemExecutionException
that is then catched by the execution manager an brought to
the user's attention.
data
- the concrete JSONObject of input data (if observer)
KiemExecutionException
- a KiemExecutionExceptionpublic void initialize() throws KiemInitializationException
KiemInitializationException
.
KiemInitializationException
- a KiemInitializationExceptionpublic boolean isObserver()
public boolean isProducer()
public void wrapup() throws KiemInitializationException
KiemInitializationException
.
KiemInitializationException
- a KiemInitializationExceptionpublic KiemProperty[] provideProperties()
AbstractDataComponent
provideProperties
in class AbstractDataComponent
public JSONObject provideInitialVariables() throws KiemInitializationException
JSONObjectDataComponent
JSONObjectDataComponent.getInitialVariables()
method.
provideInitialVariables
in class JSONObjectDataComponent
KiemInitializationException
- if a property prevents the execution of this DataComponent this error should be
thrownpublic List<KiemProperty> produceInformation()
produceInformation
in interface IAutomatedProducer
produceInformation
in class AbstractAutomatedProducer
public void setParameters(List<KiemProperty> properties)
setParameters
in interface IAutomatedComponent
setParameters
in class AbstractAutomatedComponent
properties
- the properties passed before each executionpublic int wantsMoreRuns()
wantsMoreRuns
in interface IAutomatedComponent
wantsMoreRuns
in class AbstractAutomatedComponent
public int wantsMoreSteps()
wantsMoreSteps
in interface IAutomatedComponent
wantsMoreSteps
in class AbstractAutomatedComponent
public String[] getSupportedExtensions()
getSupportedExtensions
in interface IAutomatedComponent
getSupportedExtensions
in class AbstractAutomatedComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |