KSLCore/ksl.observers.welch/WelchDataFileCollector

WelchDataFileCollector

class WelchDataFileCollector(pathToDirectory: Path, statisticType: StatisticType, name: String, batchSize: Double) : AbstractWelchDataCollector

Constructors

WelchDataFileCollector

constructor(pathToDirectory: Path, statisticType: StatisticType, name: String, batchSize: Double)

Properties

avgTimeBtwObservationsForEachReplication

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.

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.

var dataFile: File

The file made for the raw data

val directory: File

The directory for the files

val fileName: String

The base file name for the files

open override var lastTime: Double

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

open override var lastValue: Double

The observation at the last observed time.

var metaDataFile: File

The file handle for the meta-data file. The meta-data file contains the number of replications as the first line, and the number of observations in each of the replications as the subsequent lines

minNumberOfObservationsAcrossReplications

open val minNumberOfObservationsAcrossReplications: Long

If there have been no replications, then this returns 0

numberOfObservationsForEachReplication

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.

numberOfReplications

open override val numberOfReplications: Int

The number of full replications observed

replicationAverages

val replicationAverages: DoubleArray

timeOfLastObservationForReps

val timeOfLastObservationForReps: DoubleArray

welchFileMetaDataBeanAsJson

val welchFileMetaDataBeanAsJson: String

Functions

beginReplication

open override fun beginReplication()

Should be executed prior to each replication

cleanUpCollector

open override fun cleanUpCollector()

Should be executed once after all replications have been observed

open override fun collect(time: Double, value: Double)

open override fun endReplication()

Should be executed after each replication

makeWelchDataFileAnalyzer

fun makeWelchDataFileAnalyzer(): WelchDataFileAnalyzer

Makes a WelchDataFileAnalyzer based on the file in this collector

makeWelchFileMetaDataBean

fun makeWelchFileMetaDataBean(): WelchFileMetaDataBean

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.

open override fun toString(): String