Package com.amalgamasimulation.studies.core

Class LocalRun<S extends org.eclipse.emf.ecore.EObject,M extends Model>

java.lang.Object

com.amalgamasimulation.studies.core.Run<S>

com.amalgamasimulation.studies.core.LocalRun<S,M>

public class LocalRun<S extends org.eclipse.emf.ecore.EObject,M extends Model>
extends Run<S>

Nested Class Summary

Nested classes/interfaces inherited from class com.amalgamasimulation.studies.core.Run

Run.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected Engine	engine
protected double	engineEndTime
protected ModelCreator<S,M>	modelCreator
protected Function<M,SimulationRunResult>	resultGenerator

Fields inherited from class com.amalgamasimulation.studies.core.Run

completionActionHandler, result, scenario, seed

Constructor Summary

Constructors

Constructor	Description
LocalRun(ShortId id, S scenario, int seed, ModelCreator<S,M> modelCreator, Function<M,SimulationRunResult> resultGenerator)
LocalRun(S scenario, int seed, ModelCreator<S,M> modelCreator, Function<M,SimulationRunResult> resultGenerator)	Creates a new instance of a run and assigns a unique id to it.

Method Summary

Modifier and Type	Method	Description
double	completedFraction()	Returns the current simulation completion fraction as a number between 0.0 and 1.0;
protected Engine	engine()
Optional<SimulationRunResult>	result()	Returns the run result, if any, or an empty Optional.
void	run()	Starts the run and blocks until the run is completed.

Methods inherited from class com.amalgamasimulation.studies.core.Run

elapsedTimeMillis, errorsCount, id, isStopRequested, runCompletionActionHandlerOnce, setCompletionActionHandler, setStatus, setStopMonitor, status, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

engineEndTime

protected double engineEndTime

engine

protected Engine engine

modelCreator

protected ModelCreator<S extends org.eclipse.emf.ecore.EObject,M extends Model> modelCreator

resultGenerator

protected Function<M extends Model,SimulationRunResult> resultGenerator

Constructor Details

LocalRun

public LocalRun(S scenario,
 int seed,
 ModelCreator<S,M> modelCreator,
 Function<M,SimulationRunResult> resultGenerator)

Creates a new instance of a run and assigns a unique id to it. Upon creation, the run's status is Run.Status.NOT_STARTED.

Parameters:

scenario - EMF scenario (instance inherited from EObject that parameterizes the simulation model.

seed - random number seed used to initialize random number sequences of the simulation model.

modelCreator - functional interface used to create an instance of simulation model. Might be called inside run() method.

resultGenerator - function that creates a result by the model instance when the simulation is correctly or erroneously completed.

LocalRun

public LocalRun(ShortId id,
 S scenario,
 int seed,
 ModelCreator<S,M> modelCreator,
 Function<M,SimulationRunResult> resultGenerator)

Method Details

engine

protected Engine engine()

run

public void run()

Description copied from class: Run

Starts the run and blocks until the run is completed.

Specified by:

run in class Run<S extends org.eclipse.emf.ecore.EObject>

result

public Optional<SimulationRunResult> result()

Description copied from class: Run

Returns the run result, if any, or an empty Optional.

Can be called from any external thread, including RCP UI thread

Specified by:

result in class Run<S extends org.eclipse.emf.ecore.EObject>

Returns:

run result

completedFraction

public double completedFraction()

Description copied from class: Run

Returns the current simulation completion fraction as a number between 0.0 and 1.0;

Can be called from any external thread, including RCP UI thread

Specified by:

completedFraction in class Run<S extends org.eclipse.emf.ecore.EObject>

Returns:

simulation completion fraction