KSLCore/ksl.app.session

Package-level declarations

Types

Filesystem-path conventions for multi-document UI applications (Scenario, Experiment, Simopt today; any future non-Swing host tomorrow) that group all their per-app artefacts under a single subdirectory of the user's active workspace.

KSLRuntimeError

sealed class KSLRuntimeError

Typed representation of errors that can occur during a simulation run.

OrchestratorSummary

data class OrchestratorSummary(val runId: String, val orchestratorName: String, val totalItems: Int, val completedItems: Int, val failedItems: Int, val beginTime: Instant, val endTime: Instant)

Lightweight aggregate summary for an orchestrated multi-run execution (scenario sweep, designed experiment, or simulation-optimization).

ReplicationDataAttachment

class ReplicationDataAttachment : RunAttachmentIfc

Opt-in attachment that captures per-replication observation arrays for all ksl.modeling.variable.Response and ksl.modeling.variable.Counter elements present in the model at the time onAttach is called.

RunAttachmentIfc

interface RunAttachmentIfc

Plugin slot for observers that need lifecycle-safe access to a running model.

RunEvent

sealed class RunEvent

Sealed lifecycle event hierarchy emitted on RunHandle.events during a simulation run.

RunHandle

interface RunHandle

Live reference to a simulation run submitted via Runner.submit.

Runner

class Runner

Entry point for asynchronous simulation execution.

RunRequest

sealed class RunRequest

Describes a simulation run to be submitted to Runner.

RunResult

sealed class RunResult

Terminal outcome of a simulation run, returned by RunHandle.result.await().

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)

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

RunWarningType

sealed class RunWarningType

Typed warning conditions that Runner can detect before or during a run.

Functions

withoutScenario

fun RunResult.BatchCompleted.withoutScenario(scenarioName: String): RunResult.BatchCompleted?

Return a copy of this with the snapshot for scenarioName removed, alongside the matching entry in RunResult.BatchCompleted.replicationsByItem. Returns null when the filter empties RunResult.BatchCompleted.snapshots — callers treat that as "the result is now empty; drop it".