1 package org.simantics.simulation.project;
3 import java.util.concurrent.atomic.AtomicReference;
4 import java.util.function.Consumer;
6 import org.simantics.databoard.Bindings;
7 import org.simantics.db.Resource;
8 import org.simantics.db.Session;
9 import org.simantics.db.VirtualGraph;
10 import org.simantics.db.WriteGraph;
11 import org.simantics.db.common.request.WriteRequest;
12 import org.simantics.db.common.request.WriteResultRequest;
13 import org.simantics.db.common.utils.NameUtils;
14 import org.simantics.db.exception.DatabaseException;
15 import org.simantics.db.service.VirtualGraphSupport;
16 import org.simantics.layer0.Layer0;
17 import org.simantics.scl.runtime.function.Function2;
18 import org.simantics.simulation.experiment.ExperimentState;
19 import org.simantics.simulation.experiment.IExperiment;
20 import org.simantics.simulation.experiment.IExperimentListener;
21 import org.simantics.simulation.ontology.SimulationResource;
22 import org.simantics.utils.ui.ErrorLogger;
25 * Facade for handling experiment run modeling and experiment activation
28 * @author Tuukka Lehtonen
30 public class ExperimentRuns {
34 * @param experimentResource
38 public static void createRun(Session session, Resource experimentResource, IExperiment experiment,
39 IExperimentActivationListener listener, Consumer<Resource> successCallback) {
40 VirtualGraphSupport support = session.getService(VirtualGraphSupport.class);
41 createRun(session, support.getWorkspacePersistent("experiments"), experimentResource, experiment, listener, successCallback);
45 * Create new experiment run in a selected virtual graph.
49 * @param experimentResource
53 public static void createRun(final Session session, VirtualGraph graph, final Resource experimentResource,
54 final IExperiment experiment, final IExperimentActivationListener listener,
55 final Consumer<Resource> successCallback)
57 createRun(session, graph, experimentResource, experiment, SimulationResource.URIs.Run, listener, successCallback);
60 public static void createRun(final Session session, VirtualGraph vg, final Resource experimentResource,
61 final IExperiment experiment, final String experimentRunTypeURI,
62 final IExperimentActivationListener listener, final Consumer<Resource> successCallback)
64 createRun(session, vg, experimentResource, experiment, experimentRunTypeURI, listener, null, successCallback);
68 * Create new experiment run in a selected virtual graph.
72 * @param experimentResource
74 * @param experimentRunTypeURI
76 * @param successCallback if non-null invoked with the created run resource
77 * as an argument, just before invoking
78 * listener.onExperimentActivated(experiment)
80 public static void createRun(final Session session, VirtualGraph vg, final Resource experimentResource,
81 final IExperiment experiment, final String experimentRunTypeURI,
82 final IExperimentActivationListener listener,
83 final Function2<WriteGraph, Resource, Object> externalWrite,
84 final Consumer<Resource> successCallback)
86 createRun(session, vg,
87 experimentResource, experiment, experimentRunTypeURI,
88 listener, externalWrite, successCallback, true);
92 * Create new experiment run in a selected virtual graph.
96 * @param experimentResource
98 * @param experimentRunTypeURI
100 * @param successCallback if non-null invoked with the created run resource
101 * as an argument, just before invoking
102 * listener.onExperimentActivated(experiment)
103 * @param attachDeactivationListener <code>true</code> to run for the created run-resource
104 * {@link #attachStateListener(Session, IExperiment, Resource)}
106 public static void createRun(
109 Resource experimentResource,
110 IExperiment experiment,
111 String experimentRunTypeURI,
112 IExperimentActivationListener listener,
113 Function2<WriteGraph, Resource, Object> externalWrite,
114 Consumer<Resource> successCallback,
115 boolean attachDeactivationListener)
117 final AtomicReference<Resource> run = new AtomicReference<>();
118 session.asyncRequest(new WriteRequest(vg) {
120 public void perform(WriteGraph graph) throws DatabaseException {
121 // System.out.println("ExperimentActivator " + experimentResource + " " + experiment.getIdentifier());
122 run.set( createRun(graph, experimentResource, experiment, experimentRunTypeURI, externalWrite) );
126 if (listener != null)
127 listener.onFailure(e);
129 ErrorLogger.defaultLogError(e);
131 if (attachDeactivationListener)
132 attachStateListener(session, experiment, run.get());
133 if (successCallback != null)
134 successCallback.accept(run.get());
135 if (listener != null)
136 listener.onExperimentActivated(experiment);
142 * Create new experiment run in a selected virtual graph.
146 * @param experimentResource
148 * @param experimentRunTypeURI
150 * @param successCallback if non-null invoked with the created run resource
151 * as an argument, just before invoking
152 * listener.onExperimentActivated(experiment)
154 public static Resource createRun(WriteGraph graph,
156 Resource experimentResource,
157 IExperiment experiment,
158 String experimentRunTypeURI,
159 Function2<WriteGraph, Resource, Object> externalWrite)
160 throws DatabaseException
162 return graph.syncRequest(new WriteResultRequest<Resource>(vg) {
164 public Resource perform(WriteGraph graph) throws DatabaseException {
165 return createRun(graph, experimentResource, experiment, experimentRunTypeURI, externalWrite);
170 public static Resource createRun(WriteGraph graph,
171 Resource experimentResource,
172 IExperiment experiment,
173 String experimentRunTypeURI,
174 Function2<WriteGraph, Resource, Object> externalWrite)
175 throws DatabaseException
177 Layer0 L0 = Layer0.getInstance(graph);
178 SimulationResource SIMU = SimulationResource.getInstance(graph);
180 Resource run = graph.newResource();
181 String label = NameUtils.findFreshLabel(graph, "Experiment", experimentResource);
182 graph.claim(run, L0.InstanceOf, null, graph.getResource(experimentRunTypeURI));
183 graph.addLiteral(run, L0.HasName, L0.NameOf, L0.String, experiment.getIdentifier(), Bindings.STRING);
184 graph.addLiteral(run, L0.HasLabel, L0.HasLabel_Inverse, L0.String, label, Bindings.STRING);
185 graph.addLiteral(run, SIMU.HasActivationTime, SIMU.HasActivationTime_Inverse, L0.Long, System.currentTimeMillis(), Bindings.LONG);
186 graph.claim(experimentResource, L0.ConsistsOf, L0.PartOf, run);
188 markRunActive(graph, run, externalWrite);
194 * Mark the run active in the transient virtual graph.
198 * @param externalWrite
199 * @throws DatabaseException
201 private static void markRunActive(
204 Function2<WriteGraph, Resource, Object> externalWrite)
205 throws DatabaseException
207 SimulationResource SIMU = SimulationResource.getInstance(graph);
208 VirtualGraph runtime = graph.getService(VirtualGraph.class);
209 graph.syncRequest(new WriteRequest(runtime) {
211 public void perform(WriteGraph graph) throws DatabaseException {
212 graph.claim(run, SIMU.IsActive, run);
213 if(externalWrite != null)
214 externalWrite.apply(graph, run);
220 * Add listener for tracking run IsActive state in the graph.
226 private static void attachStateListener(final Session session, IExperiment experiment, final Resource run) {
227 experiment.addListener(new IExperimentListener() {
229 public void stateChanged(ExperimentState state) {
230 if (state == ExperimentState.DISPOSED) {
231 VirtualGraph runtime = session.getService(VirtualGraph.class);
232 session.asyncRequest(new WriteRequest(runtime) {
234 public void perform(WriteGraph graph) throws DatabaseException {
235 SimulationResource SIMU = SimulationResource.getInstance(graph);
236 graph.denyStatement(run, SIMU.IsActive, run);
240 ErrorLogger.defaultLogError(e);