KSLCore/ksl.app.session/RunSummary

RunSummary

data class RunSummary(val runId: String, val modelIdentifier: String, val experimentName: String, val requestedReplications: Int, val completedReplications: Int, val endingStatus: IterativeProcessIfc.EndingStatus, val beginTime: Instant, val endTime: Instant)(source)

Lightweight in-memory summary of a completed (or terminated) simulation run.

RunSummary is a summary, not a results container. Per-replication observations and across-replication statistics live in whatever output sinks the user configured on the model (database, CSV files, in-memory responses, etc.) and are accessed through the normal KSL APIs after the run completes.

An instance is attached to the terminal RunEvent (RunEvent.RunCompleted) and is also available via RunResult.Completed.

Constructors

RunSummary

constructor(runId: String, modelIdentifier: String, experimentName: String, requestedReplications: Int, completedReplications: Int, endingStatus: IterativeProcessIfc.EndingStatus, beginTime: Instant, endTime: Instant)

Properties

beginTime

val beginTime: Instant

wall-clock instant at which Runner called model.initializeReplications()

completedReplications

val completedReplications: Int

how many replications actually finished; may be less than requestedReplications on cancellation or if the execution-time limit was reached

endingStatus

val endingStatus: IterativeProcessIfc.EndingStatus

the IterativeProcessIfc.EndingStatus value that describes why the replication loop terminated; derived from the model's public status properties after the loop exits

endTime

val endTime: Instant

wall-clock instant at which the run finished; set by model.endSimulation() on the normal path, or by Runner on the cancellation and error paths

experimentName

val experimentName: String

the experiment name from the model at run time

modelIdentifier

val modelIdentifier: String

the ksl.simulation.Model.modelIdentifier of the model that was executed

requestedReplications

val requestedReplications: Int

the number of replications that were requested (model.numberOfReplications)