Package com.amalgamasimulation.studies.core

Class ReplicationStudyStep

java.lang.Object

com.amalgamasimulation.studies.core.StudyStep

com.amalgamasimulation.studies.core.ScenarioStudyStep

com.amalgamasimulation.studies.core.ReplicationStudyStep

public class ReplicationStudyStep
extends ScenarioStudyStep

Field Summary

Fields

Modifier and Type	Field	Description
static final ShortId	ZERO_ID

Constructor Summary

Constructors

Constructor	Description
ReplicationStudyStep(ScenarioStudyStep parent, int seed)	Called for a new step added at runtime, and also for a step loaded from a study file which had not been launched before the study was saved to a file.
ReplicationStudyStep(ScenarioStudyStep parent, int seed, ShortId id)	Called for a ReplicationStudyStep loaded from a study file.
ReplicationStudyStep(ScenarioStudyStep parent, int seed, ShortId id, SimulationRunResult result)	Called for a ReplicationStudyStep loaded from a study file. The run id is known, because this step had been launched before its study was saved to a file. The study step also has simulation results. The 'run' field is initialized with a LoadedRun instance.

Method Summary

Modifier and Type	Method	Description
void	addChild(StudyStep childToAdd)
void	changeReplicationsCount(int newReplicationsCount)
List<ReplicationStudyStep>	childrenReplicationSteps()
double	completedFraction()
int	elapsedTimeMillis()
int	errorsCount()
double	errorsFraction()
boolean	hasCorrectResult()
ShortId	id()
ShortId	loadedId()
String	name()
int	replicationsCount()
void	reset()
List<SimulationRunResult>	results()
void	run(BiFunction<org.eclipse.emf.ecore.EObject,Integer,Run<?>> runSupplier, Supplier<Boolean> cancellationMonitor, Runnable runCompletionHandler)
Run.Status	runStatus()
org.eclipse.emf.ecore.EObject	scenario()
int	seed()
void	setCancellationMonitor(Supplier<Boolean> cancellationMonitor)
void	setCompletionActionHandler(Runnable completionActionHandler)
void	setCompletionHandled()
void	setInExecutionQueue(boolean isInExecutionQueue)
void	stop()
void	tryReattachToServerRun(BiFunction<ShortId,Integer,Run<?>> runSupplier, Supplier<Boolean> cancellationMonitor, Runnable runCompletionHandler)

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

addChild, children, correctChildrenResults, descendants, estimatedRemainingTimeMillis, hasReattachableRemoteRuns, isRunning, parent, parentScenarioStudyStep, parentStudy, reattachToRemoteRuns, removeChild

Methods inherited from class java.lang.Object

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

Field Details

ZERO_ID

public static final ShortId ZERO_ID

Constructor Details

ReplicationStudyStep

public ReplicationStudyStep(ScenarioStudyStep parent,
 int seed)

Called for a new step added at runtime, and also for a step loaded from a study file which had not been launched before the study was saved to a file.

ReplicationStudyStep

public ReplicationStudyStep(ScenarioStudyStep parent,
 int seed,
 ShortId id)

Called for a ReplicationStudyStep loaded from a study file.
The run id is known, because this step had been launched before its study was saved to a file.
The study step has no result yet.

The 'run' field will be initialized later in the tryReattachToServerRun(BiFunction, Supplier, Runnable) method.

ReplicationStudyStep

public ReplicationStudyStep(ScenarioStudyStep parent,
 int seed,
 ShortId id,
 SimulationRunResult result)

Called for a ReplicationStudyStep loaded from a study file.
The run id is known, because this step had been launched before its study was saved to a file.
The study step also has simulation results.
The 'run' field is initialized with a LoadedRun instance.

Method Details

setCancellationMonitor

public void setCancellationMonitor(Supplier<Boolean> cancellationMonitor)

setCompletionActionHandler

public void setCompletionActionHandler(Runnable completionActionHandler)

id

public ShortId id()

loadedId

public ShortId loadedId()

seed

public int seed()

stop

public void stop()

reset

public void reset()

childrenReplicationSteps

public List<ReplicationStudyStep> childrenReplicationSteps()

Overrides:

childrenReplicationSteps in class StudyStep

errorsCount

public int errorsCount()

Overrides:

errorsCount in class StudyStep

results

public List<SimulationRunResult> results()

Overrides:

results in class ScenarioStudyStep

elapsedTimeMillis

public int elapsedTimeMillis()

Overrides:

elapsedTimeMillis in class StudyStep

errorsFraction

public double errorsFraction()

Overrides:

errorsFraction in class StudyStep

completedFraction

public double completedFraction()

Overrides:

completedFraction in class StudyStep

addChild

public void addChild(StudyStep childToAdd)

Overrides:

addChild in class StudyStep

replicationsCount

public int replicationsCount()

Overrides:

replicationsCount in class ScenarioStudyStep

run

public void run(BiFunction<org.eclipse.emf.ecore.EObject,Integer,Run<?>> runSupplier,
 Supplier<Boolean> cancellationMonitor,
 Runnable runCompletionHandler)

Overrides:

run in class StudyStep

tryReattachToServerRun

public void tryReattachToServerRun(BiFunction<ShortId,Integer,Run<?>> runSupplier,
 Supplier<Boolean> cancellationMonitor,
 Runnable runCompletionHandler)

hasCorrectResult

public boolean hasCorrectResult()

setCompletionHandled

public void setCompletionHandled()

setInExecutionQueue

public void setInExecutionQueue(boolean isInExecutionQueue)

runStatus

public Run.Status runStatus()

scenario

public org.eclipse.emf.ecore.EObject scenario()

Specified by:

scenario in class ScenarioStudyStep

name

public String name()

Specified by:

name in class StudyStep

changeReplicationsCount

public void changeReplicationsCount(int newReplicationsCount)

Overrides:

changeReplicationsCount in class ScenarioStudyStep