@sdeverywhere/runtime / ModelScheduler

Class: ModelScheduler

A high-level interface that schedules the underlying ModelRunner.

When one or more input values are changed, this class will schedule a model run to be completed as soon as possible. When the model run has completed, onOutputsChanged is called to notify that new output data is available.

The ModelRunner is pluggable to allow for running the model synchronously (on the main JavaScript thread) or asynchronously (in a Web Worker or Node.js worker thread).

Constructors

constructor

new ModelScheduler(runner, userInputs, outputs)

Parameters

Name	Type	Description
runner	ModelRunner	The model runner.
userInputs	InputValue[]	The input values, in the same order as in the spec file passed to sde.
outputs	Outputs	The structure into which the model outputs will be stored.

Properties

onOutputsChanged

Optional onOutputsChanged: (outputs: Outputs) => void

Type declaration

(outputs): void

Called when outputs has been updated after a model run.

Parameters

Name	Type
outputs	Outputs

Returns

void