simudyne.core.runner

Interface ModelRunner

public interface ModelRunner

ModelRunner is used to setup and run a simulation to run for multiple runs. forTicks(int) and forRuns(long) need to be set in order for the model to run.

Multi run results are returned in a RunResult object

Start the runner with run() or runAsync()

Method Summary

Modifier and Type	Method and Description
void	cancelRun() If an async simulation is running, stop it.
ModelRunner	forRuns(long runs) Set number of times to run the simulation.
ModelRunner	forTicks(int ticks) Set number of ticks to run simulation for.
RunResult	getCompletedResults() Wait for an async simulation to complete and get results.
java.lang.String	getExportPath() Get sub directory where to export this models data.
float	getProgress() Get the progress of an async running simulation
long	getRuns()
int	getTicks()
RunResult	run() Start running the multi run simulation
scala.concurrent.Future<RunResult>	runAsync() Start running the multi run simulation in the background, allowing you to track the progress with getProgress()
ModelRunner	withCustomMetadata(java.lang.String metadata) Set metadata to be exported.
ModelRunner	withExportPath(java.lang.String exportPath) Set sub directory to export this models data to.
ModelRunner	withInput(java.lang.String jsonInput) Set values of model fields marked Input or Constant
ModelRunner	withScenario(simudyne.core.runner.scenario.ScenarioRunRequest scenario, java.lang.String runId)

Method Detail

forTicks

ModelRunner forTicks(int ticks)

Set number of ticks to run simulation for.

Parameters:

ticks - to run simulation for. If not set, defaults to zero.

Returns:

The same ModelRunner instance

getTicks

int getTicks()

Returns:

The number of ticks the simulation has been set to run for

forRuns

ModelRunner forRuns(long runs)

Set number of times to run the simulation.

Parameters:

runs - Number of times to run the simulation. If not set, defaults to zero.

Returns:

The same ModelRunner instance

getRuns

long getRuns()

Returns:

The number of times the simulation has to set to run.

withInput

ModelRunner withInput(java.lang.String jsonInput)

Set values of model fields marked Input or Constant

Parameters:

jsonInput - A json string with the field names and values

Returns:

The same ModelRunner instance

withExportPath

ModelRunner withExportPath(java.lang.String exportPath)

Set sub directory to export this models data to. If not set the value for the config field core.parquet-export-path will be used.

Parameters:

exportPath -

Returns:

getExportPath

java.lang.String getExportPath()

Get sub directory where to export this models data.

Returns:

String

withCustomMetadata

ModelRunner withCustomMetadata(java.lang.String metadata)

Set metadata to be exported. If not set, the metadata should be an empty String

Parameters:

metadata -

Returns:

run

RunResult run()

Start running the multi run simulation

Returns:

RunResult with aggregated simulation data

runAsync

scala.concurrent.Future<RunResult> runAsync()

Start running the multi run simulation in the background, allowing you to track the progress with getProgress()

Returns:

Future of RunResult with aggregated simulation data

getProgress

float getProgress()

Get the progress of an async running simulation

Returns:

percent of simulation run complete as a float between 0 and 1

getCompletedResults

RunResult getCompletedResults()

Wait for an async simulation to complete and get results.

Returns:

RunResult with aggregated simulation data

cancelRun

void cancelRun()

If an async simulation is running, stop it.

withScenario

ModelRunner withScenario(simudyne.core.runner.scenario.ScenarioRunRequest scenario,
                         java.lang.String runId)