Undocumented

The simulation diverged before reaching its end.

An action scheduled by the sequence threw an exception, which prevented the sequence from continuing. The exceptions themselves are collected separately and reported by whoever runs the sequence.

The client or some other party interrupted the sequence abruptly.

The simulation never commenced, for instance because the solver and the model are incompatible, a required file or library is missing, or a license is not available.

The sequence stopped itself, which is the normal ending. Every other reason marks a failure to complete the sequence.

The sequence execute action is an instantious sequence that executes the operation action in the simulator.

The sequence executeWhenStopped handler is an instantious sequence that registers handler to be run when the sequence stops, with the reason it stopped.

The sequence fork seq is an instantious sequence that creates a new sequence thread behaving like the sequence seq.

Returns the current value of a variable

Reads a simulator variable with an explicitly given binding. getVar is the usual way to call this.

The sequence halt ends the current sequence thread and the sequence .

scheduleAt time continuation schedules a continuation to run once the simulation time reaches time. A time at or before the current time schedules it for the current step, as scheduleNow does.

Schedules a continuation to run at the beginning of the next simulation step.

Schedules a continuation to run during the current simulation step, before the simulator advances time.

Schedules a handler to run once when the sequence stops, receiving the reason it stopped. All handlers registered so far run at that point and are then forgotten.

Sets the value of a variable

Writes a simulator variable with an explicitly given binding. setVar is the usual way to call this.

The sequence stop stops all sequence threads, stopping the simulation completely.

Stops the sequence running in the given context from outside it, as STOPPED. Use stop or stop_ to do the same from inside a sequence.

Stops the sequence as STOPPED. The continuations that were scheduled for a later step or a later time are discarded and the handlers registered with scheduleWhenStopped run. stop is the sequence-valued form of this.

Gives the current simulation time.

The sequence wait duration waits that duration seconds elapses from the current simulation time.

The sequence waitCondition condition waits until the condition is satisfied.

The sequence waitStep waits that the simulator takes one simulation step. It is a primitive mechanism that can be used to implement other events by inspecting the simulator state after each time step.

The sequence waitUntil time waits until the simulation time is at least the given time.