KSLCore/ksl.observers

Package-level declarations

Types

class AcrossReplicationHalfWidthChecker @JvmOverloads constructor(response: ResponseCIfc, desiredHalfWidth: Double = 1.0, name: String? = null) : ModelElementObserver

This class will stop the simulation when the desired half-width criterion is met for the supplied response variable.

AcrossReplicationRelativePrecisionChecker

class AcrossReplicationRelativePrecisionChecker(response: ResponseCIfc, desiredRelativePrecision: Double = 1.0, name: String? = null) : ModelElementObserver

This class will stop the simulation when the desired relative precision half-width criterion is met for the supplied response variable.

BatchStatisticObserver

open class BatchStatisticObserver @JvmOverloads constructor(minNumBatches: Int = BatchStatistic.MIN_NUM_BATCHES, minBatchSize: Int = BatchStatistic.MIN_NUM_OBS_PER_BATCH, maxNBMultiple: Int = BatchStatistic.MAX_BATCH_MULTIPLE, name: String? = null) : ModelElementObserver

An observer for batching of statistics on Response variable The user can control the collection rule and the batching criteria of the underlying BatchStatistic

ControlVariateDataCollector

class ControlVariateDataCollector @JvmOverloads constructor(model: Model, name: String? = null) : ModelElement

Defines responses and controls for a control variate experiment. Collects the replication responses for the responses and for the controls. Must be created prior to running the simulation to actually collect any data. Uses a ReplicationDataCollector

CounterTrace

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

Provides the ability to trace the value of a counter during replications.

CounterTraceCSV

class CounterTraceCSV @JvmOverloads constructor(theCounter: Counter, pathToFile: Path = theCounter.myModel.outputDirectory.outDir.resolve( theCounter.name.replace(':', '_') + "_Trace.csv"), header: Boolean = true) : ModelElementObserver

Provides the ability to trace the value of a counter during replications.

ExperimentDataCollector

class ExperimentDataCollector @JvmOverloads constructor(model: Model, autoAttach: Boolean = true)

The purpose of this class is to store replication data across a set of experiments

ModelElementObserver

abstract class ModelElementObserver(name: String? = null) : IdentityIfc

Base class for reacting to status changes that occur on a model element. This observer is meant to observe 1 and only 1 model element. However, a model element may have many observers.

ReplicationDataCollector

class ReplicationDataCollector @JvmOverloads constructor(model: Model, addAll: Boolean = false, autoAttach: Boolean = true)

Collects and stores the replication average for each specified response or final value for each counter. Must be created prior to running the simulation for any data to be collected. The added responses or counters must already be part of the model. This is important. Only those responses or counters that already exist in the model hierarchy will be added automatically if you use the automatic add option.

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.

ResponseTraceCSV

class ResponseTraceCSV @JvmOverloads constructor(theResponse: Response, val pathToFile: Path = theResponse.myModel.outputDirectory.csvDir.resolve( theResponse.name.replace(':', '_') + "_Trace.csv"), header: Boolean = true) : ModelElementObserver

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

SimulationTimer

class SimulationTimer(model: Model)

Provides the ability to time the execution of a model.