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

All Known Implementing Classes:
AbstractAutomationListener, AutomationListener

public interface IAutomationListener

This interface is for plugins who want to listen to the automated execution.

Rating red

Method Summary
 void doPostAutomationProcessing()
          This method is called immediately after the entire automation has finished.
 void doPreAutomationProcessing()
          This method is called immediately before the automation starts and gives listeners a chance to perform some action like opening views or loading plugins.
 void executionFileStarted(IPath executionFile, Exception exception)
          This method indicates that the automation tried to start a new execution file.
 void receiveIterationResult(IterationResult result)
          Publishes the result of the currently running iteration.
 void receiveIterationResult(List<IterationResult> results)
          Publishes a list of results of the last couple of iterations.
 void receiveModelFileResults(IPath executionFile, List<AbstractResult> results)
          This method will pass all summarized model file results produced by the given execution file.
 void refresh()
          Notifies the listeners that information in the already produced results may have changed and that the listeners should re-check the values.
 

Method Detail

executionFileStarted

void executionFileStarted(IPath executionFile,
                          Exception exception)
This method indicates that the automation tried to start a new execution file. If starting the file failed the exception will be passed.

Parameters:
executionFile - the path to the execution file
exception - an exception that caused the file to fail, null if the file was started successfully

receiveModelFileResults

void receiveModelFileResults(IPath executionFile,
                             List<AbstractResult> results)
This method will pass all summarized model file results produced by the given execution file. It will be called once the execution file was completely simulated.

Parameters:
executionFile - the execution file
results - the list of model file results

receiveIterationResult

void receiveIterationResult(IterationResult result)
Publishes the result of the currently running iteration. This result might NOT be complete yet and some information in it might be changed or updated until the iteration finishes. All listeners should re-check the iteration results when the refresh method is called.

Parameters:
result - the result

receiveIterationResult

void receiveIterationResult(List<IterationResult> results)
Publishes a list of results of the last couple of iterations. The results might NOT be complete yet and some information in them might be changed or updated until the model file finishes. All listeners should re-check the iteration results when the refresh method is called.

Parameters:
results - the results

refresh

void refresh()
Notifies the listeners that information in the already produced results may have changed and that the listeners should re-check the values. A change should only happen in the results connected to the currently simulated execution file.


doPreAutomationProcessing

void doPreAutomationProcessing()
This method is called immediately before the automation starts and gives listeners a chance to perform some action like opening views or loading plugins.


doPostAutomationProcessing

void doPostAutomationProcessing()
This method is called immediately after the entire automation has finished.