R1.2.2

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

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

Functions

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.

fun observeAll(responses: Collection<TWResponse>)

Causes all the responses to be observed

fun remove(response: TWResponse)

fun remove(response: TWResponseCIfc)

The response will stop being observed by the aggregate.

fun removeAll(responses: Collection<TWResponse>)

Causes all the responses to stop being observed