alchemist-api/it.unibo.alchemist.model.observation/Observable

Observable

interface Observable<T> : Disposable(source)

Represents an observable object that emits updates to registered observers when its value changes. Registration changes take effect on later emissions.

Observers are notified as soon as the value changes, while other observables depending on the same change may not have been updated yet. A callback must therefore not rely on state it does not observe: a result depending on several observables must observe all of them, so that it is recomputed once each is updated.

Type Parameters

The type of the value being observed.

Inheritors

Properties

current

abstract val current: T

The current state or value of the observable.

isObserved

open val isObserved: Boolean

Whether any callback is currently registered.

observerCount

abstract val observerCount: Int

How many callbacks are currently registered.

Functions

dispose

abstract override fun dispose()

Unregisters every callback registered with this observable.

map

abstract fun <S> map(transform: (T) -> S): Observable<S>

Transforms the current observable into a new observable by applying the specified transformation function to its emitted values.

mergeWith

abstract fun <O, R> mergeWith(other: Observable<O>, merge: (T, O) -> R): Observable<R>

Combines the current observable with another observable, producing a new observable that emits values derived by applying the provided merge function to the current values of both observables.

onChange

abstract fun onChange(notifyOnRegistration: Boolean = true, callback: (T) -> Unit): Disposable

Registers callback to be invoked with every new value of this observable, and right away with the current one if notifyOnRegistration.