Simulation

The environment of this simulation. It is not a copy, but the actual environment used in the simulation: manipulate it carefully.

The exception that made the simulation fail, or arrow.core.None if the simulation is ongoing or has terminated successfully.

The OutputMonitors currently attached to this simulation.

The current SimulationState of the simulation.

The current simulation step.

The current simulation time.

Adds an OutputMonitor to this simulation.

Executes the simulation up to steps steps, then pauses it. The returned future completes when the steps are executed.

Executes the simulation until the target time time is reached, then pauses it. The returned future completes when the target time is reached.

Sends a pause command to the simulation. There is no guarantee on when this command will be actually processed. The returned future completes when the simulation is paused.

Sends a play command to the simulation. There is no guarantee on when this command will be actually processed. The returned future completes when the simulation is played.

Notifies the simulation that a reaction host has registered reactionToAdd. Model code should register the reaction through its host; the host invokes this callback after membership actually changes. Adding a node invokes this callback once for each reaction already hosted by that node; node and topology changes have no separate simulation callback.

Marks reactionToUpdate as a reaction whose observed scheduling inputs changed. The notification is synchronous and must originate on the simulation thread. The engine refreshes each affected reaction once when the enclosing model mutation completes.

Notifies the simulation that a reaction host has unregistered reactionToRemove. Model code should unregister the reaction through its host; the host invokes this callback after membership actually changes. Removing a node invokes this callback once for each hosted reaction before disposing it.

Removes an OutputMonitor from this simulation. If monitor was not among those already added, nothing happens.

Schedules action to be executed by the simulation thread, useful for synchronization purposes (e.g., make sure that the environment is not being changed while the requested operation is being executed). An exception thrown by action makes the simulation terminate.

Sends a terminate command to the simulation. There is no guarantee on when this command will be actually processed. The returned future completes when the simulation is terminated.

Suspends the caller until the simulation reaches the selected SimulationState, or the timeout, expressed in timeunit, expires. Waiting for a status does not mean that every OutputMonitor has already been notified of the update.