R1.2.2

KSLCore/ksl.modeling.variable/ResponseBatchingElement

ResponseBatchingElement

class ResponseBatchingElement @JvmOverloads constructor(modelElement: ModelElement, name: String? = null) : ModelElement(source)

Controls the batching of Response variables within the Model. Used by StatisticalBatchingElement.

Author

rossetti

Constructors

ResponseBatchingElement

constructor(modelElement: ModelElement, name: String? = null)

Properties

allBatchStatistics

val allBatchStatistics: List<BatchStatisticIfc>

Returns a list of summary statistics on all ResponseVariable variables The list is a copy of originals.

allBatchStatisticsAsMap

val allBatchStatisticsAsMap: Map<ResponseCIfc, BatchStatisticIfc>

Functions

fun add(response: ResponseCIfc, minNumBatches: Int = BatchStatistic.MIN_NUM_BATCHES, minBatchSize: Int = BatchStatistic.MIN_NUM_OBS_PER_BATCH, maxNBMultiple: Int = BatchStatistic.MAX_BATCH_MULTIPLE, name: String = response.name): BatchStatisticObserver

Adds the supplied Response variable to the batching

fun asString(): String

batchStatisticFor

fun batchStatisticFor(response: ResponseCIfc): BatchStatisticIfc

Returns a statistical summary BatchStatistic on the Response variable across the observed batches.

batchStatisticObserverFor

fun batchStatisticObserverFor(response: ResponseCIfc): BatchStatisticObserver?

Look up the BatchStatisticObserver for the Response

fun getCSVHeader(response: ResponseCIfc): String

Gets the CSV Header for the ResponseVariable

fun getCSVRow(response: ResponseCIfc): String

Gets the CSV row for the Response

fun remove(response: ResponseCIfc)

Removes the supplied Response variable from the batching

fun removeAll()

Removes all previously added ResponseVariable from the batching