KSLCore/ksl.observers.welch/AbstractWelchDataCollector

AbstractWelchDataCollector

abstract class AbstractWelchDataCollector(statisticType: StatisticType, name: String, batchSize: Double) : WelchDataCollectorIfc

An abstract base class for building collectors of Welch data

Parameters

statisticType

the type of statistic TALLY or TIME_PERSISTENT

name

the name of the observations being collected

batchSize

the amount of batching to perform on the observations within a replication

Inheritors

Constructors

Link copied to clipboard
constructor(statisticType: StatisticType, name: String, batchSize: Double)

Properties

Link copied to clipboard
open override val avgTimeBtwObservationsForEachReplication: DoubleArray

The average time between observations in each replication returned as an array. 0 element is the first replication observed. If no replications have been observed then the array will be empty.

Link copied to clipboard
override val batchSize: Double

The size associated with batching the within replication observations. If the data is tally based, then it is the number of observations per batch. If the data is observation-based, then it is the time period over which the time average is computed.

Link copied to clipboard
open override var lastTime: Double

The time that the last observation occurred. The last observed time.

Link copied to clipboard
open override var lastValue: Double

The observation at the last observed time.

open val minNumberOfObservationsAcrossReplications: Long

If there have been no replications, then this returns 0

Link copied to clipboard
open override val numberOfObservationsForEachReplication: LongArray

The number of observations in each replication returned as an array. 0 element is the first replication count. If no replications have been observed then the array will be empty.

Link copied to clipboard
open override val numberOfReplications: Int

The number of full replications observed

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open override fun beginReplication()

Should be executed prior to each replication

Link copied to clipboard
abstract fun cleanUpCollector()

Should be executed once after all replications have been observed

Link copied to clipboard
abstract fun collect(time: Double, value: Double)
Link copied to clipboard
open override fun endReplication()

Should be executed after each replication

Link copied to clipboard
open override fun setUpCollector()

Should be executed once prior to any collection and should be used to clear any statistical collection and prepare the collector for collecting data.