KSLCore/ksl.utilities.io.dbutil/SimulationSnapshot/ExperimentCompleted

ExperimentCompleted

data class ExperimentCompleted(val simulationRun: SimulationRunTableData, val acrossRepStats: List<AcrossRepStatTableData>, val histograms: List<HistogramTableData>, val frequencies: List<FrequencyTableData>, val timeSeries: List<TimeSeriesResponseTableData>, val experiment: ExperimentTableData = ExperimentTableData()) : SimulationSnapshot(source)

Emitted once after all replications of an experiment complete successfully.

Carries the experiment identity record, the finalized simulation run record (with end timestamp and final replication count), and all across-replication aggregates, histogram data, frequency data, and time-series response data.

The experiment field mirrors the same record in ExperimentStarted so that consumers receiving only the completion snapshot can still identify which experiment produced the results without having to retain the earlier start snapshot. In particular, experiment.exp_name is the authoritative experiment / scenario identifier; the SimulationRunTableData.run_name field on simulationRun is a separate, usually-empty per-run label and should not be used as an experiment id.

Constructors

ExperimentCompleted

constructor(simulationRun: SimulationRunTableData, acrossRepStats: List<AcrossRepStatTableData>, histograms: List<HistogramTableData>, frequencies: List<FrequencyTableData>, timeSeries: List<TimeSeriesResponseTableData>, experiment: ExperimentTableData = ExperimentTableData())

Properties

acrossRepStats

val acrossRepStats: List<AcrossRepStatTableData>

experiment

val experiment: ExperimentTableData

Identity record for the experiment that produced this snapshot. Mirrors ExperimentStarted.experiment. Defaults to an empty ExperimentTableData so callers constructing ExperimentCompleted outside the lifecycle bridge (e.g. in test fixtures) stay source-compatible.

frequencies

val frequencies: List<FrequencyTableData>

histograms

val histograms: List<HistogramTableData>

simulationRun

val simulationRun: SimulationRunTableData

timeSeries

val timeSeries: List<TimeSeriesResponseTableData>

Functions

toReport

fun SimulationSnapshot.ExperimentCompleted.toReport(title: String = defaultSnapshotTitle(this), showPlots: Boolean = true, showTimeSeries: Boolean = true, showDiagnostics: Boolean = false, timeSeriesConfidenceLevel: Double = 0.95, outputDirectory: OutputDirectory? = null, block: ReportBuilder.() -> Unit = { snapshotSimulationResults( this@toReport, showPlots = showPlots, showTimeSeries = showTimeSeries, showDiagnostics = showDiagnostics, timeSeriesConfidenceLevel = timeSeriesConfidenceLevel ) }): ReportNode.Document

Builds a report document for a completed simulation snapshot.