KSLCore/ksl.controls.experiments/ScenarioRunner

ScenarioRunner

class ScenarioRunner(name: String, scenarioList: List<Scenario> = emptyList(), val pathToOutputDirectory: Path = KSL.createSubDirectory(name.replace(" ", "_") + "_OutputDir"), val kslDb: KSLDatabase = KSLDatabase("${name}.db".replace(" ", "_"), pathToOutputDirectory)) : Identity

Facilitates the running of many scenarios in a sequence. A KSLDatabase is used to capture the statistics for each scenario. Each scenario is treated like a different experiment. The scenarios can be based on the same or different models. The scenarios also capture the inputs and results via a SimulationRun.

Parameters

name

of the scenario runner. By default, this name is used as the name of the database

scenarioList

a list of scenarios to execute

kslDb

the KSLDatabase that will hold the results from the scenarios

Constructors

ScenarioRunner

constructor(name: String, scenarioList: List<Scenario> = emptyList(), pathToOutputDirectory: Path = KSL.createSubDirectory(name.replace(" ", "_") + "_OutputDir"), kslDb: KSLDatabase = KSLDatabase("${name}.db".replace(" ", "_"), pathToOutputDirectory))

Properties

dbObservers

val dbObservers: List<KSLDatabaseObserver>

The database observers that were attached to the models. This property could be used to turn off all or some of the observers

override val id: Int

kslDb

val kslDb: KSLDatabase

label

open override var label: String?

name

override val name: String

pathToOutputDirectory

val pathToOutputDirectory: Path

scenarioList

val scenarioList: List<Scenario>

A read only list of the scenarios to be run.

scenariosByName

val scenariosByName: Map<String, Scenario>

Functions

addScenario

fun addScenario(model: Model, inputs: Map<String, Double>, name: String, numberReplications: Int = model.numberOfReplications, lengthOfReplication: Double = model.lengthOfReplication, lengthOfReplicationWarmUp: Double = model.lengthOfReplicationWarmUp): Scenario

Adds a scenario to the possible scenarios to simulate. The name of the scenario (based on the model's experiment) must be unique within the context of the list of scenarios to run.

databaseObserverByName

fun databaseObserverByName(name: String): KSLDatabaseObserver?

Gets the database observer by the scenario name or null if not there.

numReplicationsPerScenario

fun numReplicationsPerScenario(numReps: Int)

Sets the number replications for each scenario to a common number of replications.

scenarioByName

fun scenarioByName(name: String): Scenario?

Gets the scenario by its name or null if not there.

simulate

fun simulate(scenarios: IntProgression = myScenarios.indices, clearAllData: Boolean = true)

Interprets the integer progression as the indices of the contained scenarios that should be simulated. If the progression is not a valid index then no scenario is simulated.

toString

open override fun toString(): String