KSLCore/ksl.observers/ResponseTrace

ResponseTrace

class ResponseTrace @JvmOverloads constructor(theResponse: Response, val pathToFile: Path = theResponse.myModel.outputDirectory.outDir.resolve( theResponse.name.replace(':', '_') + "_Trace")) : ModelElementObserver

Provides the ability to trace the values of a response during replications.

Parameters

theResponse

the response to trace

pathToFile

the path to the file to store the trace

Constructors

ResponseTrace

constructor(theResponse: ResponseCIfc, pathToFile: Path = (theResponse as Response).myModel.outputDirectory.outDir.resolve( theResponse.name.replace(':', '_') + "_Trace"))

@JvmOverloads

constructor(theResponse: Response, pathToFile: Path = theResponse.myModel.outputDirectory.outDir.resolve( theResponse.name.replace(':', '_') + "_Trace"))

Properties

open override val id: Int

label

open override var label: String?

maxNumObservations

var maxNumObservations: Double

The maximum number of observations to collect across all replications. Once the maximum is reached no further collection occurs.

maxNumObsPerReplication

var maxNumObsPerReplication: Long

The maximum number of observations to trace within each replication. Once the maximum is reached no further collection occurs within the replication.

maxNumReplications

var maxNumReplications: Int

The maximum number of replications to include in the trace. Once the maximum is reached no further replications are traced.

maxRepObsTime

var maxRepObsTime: Double

name

open override val name: String

pathToFile

val pathToFile: Path

Functions

asDatabase

fun asDatabase(): DatabaseIfc

asDataFrame

fun asDataFrame(): AnyFrame

asTabularInputFile

fun asTabularInputFile(): TabularInputFile

traceDataMap

fun traceDataMap(repNum: Double, time: Double = Double.MAX_VALUE): Map<String, DoubleArray>

Returns a map that has the times and values for the provided replication repNum up to and including the time. The default value of time is Double.MAX_VALUE, which will result in all values for the replication. Element "times" holds the times that the variable changed Element "values" holds the values associated with each time change.