de.cau.cs.kieler.sim.kiem
Interface IDataComponent

All Known Implementing Classes:
AbstractAutomatedComponent, AbstractAutomatedProducer, AbstractDataComponent, AbstractTransformationDataComponent, AutoTestComponent, Backhoe, ConfigDataComponent, DataComponent, DataComponent, DataComponentModelCheck, DataComponentSim, DataObserver, DataProducer, Elevator, EsterelToSyncChartDataComponent, Example_01, Example_02, InputDataComponent, JSONObjectDataComponent, JSONObjectSimulationDataComponent, JSONStringDataComponent, KaomSimDataComponent, KEVDataObserver, KEVExampleDataProducer, KiemCsvDataProvider, KiemDataProvider, KiViDataComponent, KlotsEditorNXTDataObserver, NXTDataDistributor, OutputDataComponent, SCDataComponent, SJInstructionsViewNXTDataObserver, SJValidationSimulatorDataComponent, StateMachineDataComponent, StateMachineKiViDataComponent, SyncChartsDataComponent, SyncChartsOptimizationDataComponent, SyncchartsSimDataComponent, TraceReader, TraceValidator

public interface IDataComponent

The Interface IDataComponent that a AbstractDataComponent implements.

Rating yellow
(2009-01-15)

Method Summary
 void initialize()
          Initialize.
 boolean isObserver()
          To check whether the DataComponent is an observer.
 boolean isProducer()
          To check whether the DataComponent is a producer.
 void wrapup()
          Wrap-up.
 

Method Detail

initialize

void initialize()
                throws KiemInitializationException
Initialize. Do some initializing prior to execution. If an error occurs during initialization, the DataComponent should raise a KiemInitializationException.

Throws:
KiemInitializationException - a KiemInitializationException

wrapup

void wrapup()
            throws KiemInitializationException
Wrap-up. Do some wrapping-up after execution has finished. If an error occurs during wrap up, the DataComponent should raise a KiemInitializationException.

Throws:
KiemInitializationException - a KiemInitializationException

isProducer

boolean isProducer()
To check whether the DataComponent is a producer. If the DataComponent is a producer it should return != null in its step() method.

Returns:
true, if is producer

isObserver

boolean isObserver()
To check whether the DataComponent is an observer. If the DataComponent is an observer the arguments in its step() method will be != null.

Returns:
true, if is observer