KSLCore/ksl.modeling.variable/HistogramResponse

HistogramResponse

class HistogramResponse @JvmOverloads constructor(theResponse: Response, val cacheSize: Int = 512, name: String? = ":Histogram") : ModelElement, HistogramResponseCIfc(source)

Tabulates a histogram for the indicated response.

The cacheSize represents the amount of data used to configure the break points of the histogram CachedHistogram.

If the amount of data observed is less than cache size and greater than or equal to 2, the returned histogram will be configured on whatever data was available in the cache. Thus, bin settings may change as more data is collected until the cache is full. Once the cache is full the returned histogram is permanently configured based on all data in the cache. The default cache size is 512 observations.

The histogram tabulates all within replication observations regardless of replication. That is, the histogram is based on every observation for every replication. It observes observations that may have been within a warmup period even if the modeler specifies a warmup period.

Parameters

theResponse

the response variable to form a histogram on

cacheSize

the minimum amount of data needed to configure the break points

name

the name of the model element

Constructors

HistogramResponse

@JvmOverloads

constructor(theResponse: Response, cacheSize: Int = 512, name: String? = ":Histogram")

Properties

cacheSize

val cacheSize: Int

histogram

open override val histogram: HistogramIfc

response

open override val response: ResponseCIfc

Functions

afterExperiment

protected open override fun afterExperiment()

This method should be overridden by subclasses that need actions performed after an experiment has been completed It is called after all replications are done and can be used to collect data from the model element, etc.

beforeExperiment

protected open override fun beforeExperiment()

This method should be overridden by subclasses that need logic to be performed prior to an experiment. The beforeExperiment method allows model elements to be set up prior to the first replication within an experiment. It is called once before any replications occur.

startCollecting

fun startCollecting()

Causes the histogram response to start observing the underlying response

stopCollecting

fun stopCollecting()

Causes the histogram response to stop observing the underlying response.