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

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

Properties

Link copied to clipboard
val cacheSize: Int = 512
Link copied to clipboard
open override val histogram: HistogramIfc
Link copied to clipboard
open override val response: ResponseCIfc

Functions

Link copied to clipboard

Causes the histogram response to start observing the underlying response

Link copied to clipboard

Causes the histogram response to stop observing the underlying response.