org.eclipse.ohf.stem.jobs.simulation
Interface ISimulation

All Known Implementing Classes:
Simulation

public interface ISimulation

This interface is implemented by classes that represent Simulations of Scenarios.


Field Summary
static int TOTAL_WORK
          The percentage of work that represents a complete simulation.
 
Method Summary
 void addSimulationListener(ISimulationListener simulationListener)
           
 java.lang.String getName()
           
 java.lang.String getNameWithSequenceNumber()
           
 Scenario getScenario()
           
 int getSequenceNumber()
           
 SimulationState getSimulationState()
           
 void pause()
          Pause the simulation
 void removeSimulationListener(ISimulationListener simulationListener)
           
 void reset()
          Reset the simulation.
 void run()
          Start running the simulation.
 void setSequenceNumber(int sequenceNumber)
           
 void step()
          Step the simulation one step/cycle if it hasn't already ended
 void stop()
          Stop the simulation;
 

Field Detail

TOTAL_WORK

static final int TOTAL_WORK
The percentage of work that represents a complete simulation. 100

See Also:
Constant Field Values
Method Detail

getSequenceNumber

int getSequenceNumber()
Returns:
the sequence number of the simulation.

setSequenceNumber

void setSequenceNumber(int sequenceNumber)
Parameters:
sequenceNumber - The sequence number of the simulation

getSimulationState

SimulationState getSimulationState()
Returns:
the state of the Simulation

run

void run()
Start running the simulation.


pause

void pause()
Pause the simulation


reset

void reset()
Reset the simulation.


step

void step()
Step the simulation one step/cycle if it hasn't already ended


stop

void stop()
Stop the simulation;


getScenario

Scenario getScenario()
Returns:
the Scenario being simulated

getName

java.lang.String getName()
Returns:
the name of the simulation

getNameWithSequenceNumber

java.lang.String getNameWithSequenceNumber()
Returns:
the name of the simulation prefixed by the sequence number. (e.g., : "[12] Some Simulation")
See Also:
getSequenceNumber(), getName()

addSimulationListener

void addSimulationListener(ISimulationListener simulationListener)
Parameters:
simulationListener -

removeSimulationListener

void removeSimulationListener(ISimulationListener simulationListener)
Parameters:
simulationListener -