TimeSeriesResponse

This class addresses the problem of collecting simulation responses by period. A typical use case involves the reporting of statistics over fixed time periods, such as hourly, daily, monthly, yearly, etc. A time series response divides the simulated time horizon into sequential periods, with the periods marking the time frame over which performance is observed. Users specify which responses will be tabulated by providing Response, TWResponse, or Counter instances. Then for each period during the simulation horizon, the response over the period is recorded into a series of records, constituting a time series for the response. For Response and TWResponse instances, the recorded response represents the average of the variable during the period. For Counter instances, the total count during the period is recorded. This data is recorded for every response, for every period, for each replication. The response or counter information is recorded at the end of each completed period. The number of periods to collect must be supplied.

This class does not react to warm up events. That is, periods observed prior to the warmup event will contain data that was observed during the warmup period. The standard usage for this class is likely not within an infinite horizon (steady-state) context. However, if you do not want data collected during warmup periods, then specify the default start time for the time series to be greater than or equal to the specified warmup period length using the defaultStartTime property. The default starting time of the first period is at time 0.0.

The collected responses are not automatically shown in console output. However, the data can be accessed via a reference to the class or by using a KSLDatabase.

Parameters