de.cau.cs.kieler.sim.kiem.automated
Interface IAutomatedComponent

All Known Subinterfaces:
IAutomatedProducer
All Known Implementing Classes:
AbstractAutomatedComponent, AbstractAutomatedProducer, AutoTestComponent, SCDataComponent, TraceReader, TraceValidator

public interface IAutomatedComponent

Interface for components that want to interact with the automated execution plugin.

Rating yellow
(2010-03-16) ctr, tam

Field Summary
static String ANY_TYPE
          Identifier for any file type support.
static String[] ANY_TYPE_ARRAY
          Identifier for any file type support.
static String ITERATION
          Identifier for the iteration.
static String MODEL_FILE
          Identifier for the model file.
 
Method Summary
 int getNumberOfAdditionalIterations()
          Ask the component if it wants to do more runs.
 int getNumberOfAdditionalSteps()
          Ask the component if it wants to do more steps.
 String[] getSupportedExtensions()
          Getter for the list of model file extensions that are supported by the component.
 void setParameters(List<KiemProperty> properties)
          Give the component information.
 int wantsMoreRuns()
          Deprecated. use getNumberOfAdditionalIterations()
 int wantsMoreSteps()
          Deprecated. use getNumberOfAdditionalSteps()
 

Field Detail

MODEL_FILE

static final String MODEL_FILE
Identifier for the model file.

See Also:
Constant Field Values

ITERATION

static final String ITERATION
Identifier for the iteration.

See Also:
Constant Field Values

ANY_TYPE

static final String ANY_TYPE
Identifier for any file type support.

See Also:
Constant Field Values

ANY_TYPE_ARRAY

static final String[] ANY_TYPE_ARRAY
Identifier for any file type support.

Method Detail

setParameters

void setParameters(List<KiemProperty> properties)
                   throws KiemInitializationException
Give the component information. This at least contains the following properties: MODEL_FILE gotten from IPath.toOSString() ITERATION as an integer starting with 0 of course

Parameters:
properties - some info
Throws:
KiemInitializationException - if something went wrong while initializing the component

getSupportedExtensions

String[] getSupportedExtensions()
Getter for the list of model file extensions that are supported by the component. Combinations of model files with execution files that don't have at least one supporting component will not be executed. If the component returns null or an empty list it will not be taken into consideration for determining which model file should be executed. However it will still be part of the execution. Thus it isn't necessary for components to return something here if another component in the schedule returns a list of extensions. Example: types = {"kixs", "strl}; types = IAutomatedComponent.ANY_TYPE;

Returns:
the list of supported model file extensions

getNumberOfAdditionalIterations

int getNumberOfAdditionalIterations()
Ask the component if it wants to do more runs. This causes the entire execution to be executed again as many times as the components specified.

Returns:
the number of additional iterations

getNumberOfAdditionalSteps

int getNumberOfAdditionalSteps()
Ask the component if it wants to do more steps. This causes the entire execution to perform at least as many steps as the components specified.

Returns:
the number of additional steps

wantsMoreRuns

@Deprecated
int wantsMoreRuns()
Deprecated. use getNumberOfAdditionalIterations()

Ask the component if it wants to do more runs. This causes the entire execution to be executed again as many times as the components specified.

Returns:
the number of additional runs

wantsMoreSteps

@Deprecated
int wantsMoreSteps()
Deprecated. use getNumberOfAdditionalSteps()

Ask the component if it wants to do more steps. This causes the entire execution to perform at least as many steps as the components specified.

Returns:
the number of additional steps