1 /*******************************************************************************
2 * Copyright (c) 2019 Association for Decentralized Information Management
4 * All rights reserved. This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License v1.0
6 * which accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Semantum Oy - initial API and implementation
11 *******************************************************************************/
12 package org.simantics.simulation.sequences.action;
15 * Reasons for why a simulation sequence stops.
18 * {@link ActionContext#scheduleWhenStopped(org.simantics.scl.runtime.function.Function1)}
19 * allows sequences to handle stop reasons.
21 * @author Tuukka Lehtonen
22 * @since 1.41.0, 1.35.2
24 public enum StopReason {
26 * Appropriately stopped by the sequence itself. This is the normal course of
27 * action if the everything works as intended. All the other enumerated cases
28 * are exceptional situations marking some kind of failure to complete the
34 * Means simulation did not commence at all for some reason.
35 * A few possible reasons for failure are:
37 * <li>Incompatible solver and model</li>
38 * <li>Missing required files or other dependencies such as dynamic libraries</li>
39 * <li>License issues</li>
42 SIMULATION_DID_NOT_START,
45 * Simulation diverged before reaching its specified end.
50 * Client or some other party abruptly interrupted the sequence.