KSLCore/ksl.observers/ResponseTraceDataIfc

ResponseTraceDataIfc

The read-only query surface needed to report a response trace.

Both the live capture observer ResponseTrace and the disk-backed reader ResponseTraceData implement this, so the responseTrace reporting DSL (in ksl.utilities.io.report.extensions) can render a trace either from a running model or reloaded from a finished run's trace file.

Inheritors

ResponseTrace

ResponseTraceData

Properties

isTimeWeighted

abstract val isTimeWeighted: Boolean

true when the traced response is time-weighted (step-function semantics) and false for observation-based responses. Reporting selects a state-variable sample-path plot vs. an observations plot based on this.

name

abstract val name: String

The name of the traced response.

replicationNumbers

abstract val replicationNumbers: List<Int>

The distinct replication numbers present in the trace, in ascending order. Replications that were not recorded are not included.

Functions

traceDataMap

abstract fun traceDataMap(repNum: Int, startTime: Double = 0.0, endTime: Double = Double.MAX_VALUE): Map<String, DoubleArray>

The times and values for replication repNum within the time window [startTime, endTime]. Element "times" holds the simulation times at which the variable changed; element "values" holds the corresponding values.