ResponseCIfc

While Response instances should in general be declared as private within model elements, this interface provides the modeler the ability to declare a public property that returns an instance with limited ability to change and use the underlying Response, prior to running the model.

For example:

private val myR = Response(this, "something cool") val response: ResponseCIfc get() = myR

Then users of the public property can change the response and do other controlled changes without fully exposing the private variable. The implementer of the model element that contains the private response does not have to write additional functions to control the response and can use this strategy to expose what is needed. This is most relevant to setting up the model elements prior to running the model or accessing information after the model has been executed. Changes or use during a model run is readily available through the general interface presented by Response.

The naming convention "CIfc" is used to denote controlled interface.

Inheritors

Properties

Link copied to clipboard

The across replication statistics for the response

Link copied to clipboard

Returns the default reporting option. True means that the response should appear on the default reports

Link copied to clipboard
abstract override val domain: Interval

The legal range of values for the response

Link copied to clipboard
abstract val emissionsOn: Boolean

If true, the response will emit pairs Pair(time, value) every time a new value is assigned

Link copied to clipboard
abstract val id: Int
Link copied to clipboard

Sets the initial value of the count limit. Only relevant prior to each replication. Changing during a replication has no effect until the next replication.

Link copied to clipboard
abstract var label: String?
Link copied to clipboard
abstract val name: String
Link copied to clipboard
Link copied to clipboard
abstract val previousValue: Double

The previous value from the sequence of values a double representing the last value in the sequence

Link copied to clipboard
abstract val timeOfChange: Double
Link copied to clipboard
abstract val value: Double
Link copied to clipboard

The within replication statistics associated with the response

Functions

Link copied to clipboard
abstract fun addCountLimitAction(action: CountActionIfc)

Add an action that will occur when the count limit is achieved

Link copied to clipboard
abstract fun addCountLimitStoppingAction(initialCountLimit: Int): CountActionIfc

Adds an action that will stop the replication when the count limit is reached.

Link copied to clipboard

Remove an action associated with a count limit