KSLCore/ksl.modeling.variable/AggregateTWResponse

AggregateTWResponse

class AggregateTWResponse @JvmOverloads constructor(parent: ModelElement, name: String? = null) : TWResponse(source)

An aggregate time-weighted response observes many other time-weighted response variables. Whenever any variable that it observes changes, it is incremented by or decremented by the amount of the change. Thus, the resulting response is the total (aggregate) of all the underlying observed responses at any time.

Parameters

parent

the parent model element

name

the name of the aggregate response

Constructors

AggregateTWResponse

@JvmOverloads

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

Functions

initialize

protected open override fun initialize()

At the start of each replication, KSL's beforeReplication has already reset every TWResponse (including this aggregate and every observed source) to its initialValue. But the aggregate's initialValue is independent of its sources, so the aggregate restarts at 0 (or its declared value) even when sources start positive — and the first delta-tracking observation on a source's decrement then takes the aggregate negative, violating TWResponse's [0, ∞) domain.

observe

fun observe(response: TWResponse)

fun observe(response: TWResponseCIfc)

The response will be observed by the aggregate such that whenever the response changes, the aggregate will be assigned the same value.

observeAll

fun observeAll(responses: Collection<TWResponse>)

Causes all the responses to be observed

remove

fun remove(response: TWResponse)

fun remove(response: TWResponseCIfc)

The response will stop being observed by the aggregate.

removeAll

fun removeAll(responses: Collection<TWResponse>)

Causes all the responses to stop being observed