bundles/org.simantics.simulation/src/org/simantics/simulation/project/ExperimentRuns.java

   1 package org.simantics.simulation.project;
   2
   3 import java.util.concurrent.atomic.AtomicReference;
   4 import java.util.function.Consumer;
   5
   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.CommentMetadata;
  12 import org.simantics.db.common.request.WriteRequest;
  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;
  23
  24 /**
  25  * Facade for handling experiment run modeling and experiment activation
  26  * related tasks.
  27  *
  28  * @author Tuukka Lehtonen
  29  */
  30 public class ExperimentRuns {
  31
  32     /**
  33      * @param session
  34      * @param experimentResource
  35      * @param experiment
  36      * @param listener
  37      */
  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);
  42     }
  43
  44     /**
  45      * Create new experiment run in a selected virtual graph.
  46      *
  47      * @param session
  48      * @param graph
  49      * @param experimentResource
  50      * @param experiment
  51      * @param listener
  52      */
  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)
  56     {
  57         createRun(session, graph, experimentResource, experiment, SimulationResource.URIs.Run, listener, successCallback);
  58     }
  59
  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)
  63     {
  64         createRun(session, vg, experimentResource, experiment, experimentRunTypeURI, listener, null, successCallback);
  65     }
  66
  67     /**
  68      * Create new experiment run in a selected virtual graph.
  69      *
  70      * @param session
  71      * @param vg
  72      * @param experimentResource
  73      * @param experiment
  74      * @param experimentRunTypeURI
  75      * @param listener
  76      * @param successCallback if non-null invoked with the created run resource
  77      *        as an argument, just before invoking
  78      *        listener.onExperimentActivated(experiment)
  79      */
  80     public static void createRun(final Session session, VirtualGraph vg, final Resource experimentResource,
  81             final IExperiment experiment, final String experimentRunTypeURI,
  82             final IExperimentActivationListener listener, final Function2<WriteGraph, Resource, Object> external, final Consumer<Resource> successCallback)
  83     {
  84         final AtomicReference<Resource> _run = new AtomicReference<Resource>();
  85         session.asyncRequest(new WriteRequest(vg) {
  86             @Override
  87             public void perform(WriteGraph graph) throws DatabaseException {
  88 //                System.out.println("ExperimentActivator " + experimentResource + " " + experiment.getIdentifier());
  89
  90                 final Layer0 L0 = Layer0.getInstance(graph);
  91                 final SimulationResource SIMU = SimulationResource.getInstance(graph);
  92
  93                 final Resource run = graph.newResource();
  94                 String label = NameUtils.findFreshLabel(graph, "Experiment", experimentResource);
  95                 graph.claim(run, L0.InstanceOf, null, graph.getResource(experimentRunTypeURI));
  96                 graph.addLiteral(run, L0.HasName, L0.NameOf, L0.String, experiment.getIdentifier(), Bindings.STRING);
  97                 graph.addLiteral(run, L0.HasLabel, L0.HasLabel_Inverse, L0.String, label, Bindings.STRING);
  98                 graph.addLiteral(run, SIMU.HasActivationTime, SIMU.HasActivationTime_Inverse, L0.Long, System.currentTimeMillis(), Bindings.LONG);
  99                 graph.claim(experimentResource, L0.ConsistsOf, L0.PartOf, run);
 100
 101                 // Mark the run active in the transient virtual graph.
 102                 VirtualGraph runtime = graph.getService(VirtualGraph.class);
 103                 graph.syncRequest(new WriteRequest(runtime) {
 104                     @Override
 105                     public void perform(WriteGraph graph) throws DatabaseException {
 106                         graph.claim(run, SIMU.IsActive, run);
 107                         if(external != null)
 108                                 external.apply(graph, run);
 109                     }
 110                 });
 111
 112                 _run.set(run);
 113             }
 114         }, e -> {
 115             if (e != null) {
 116                 if (listener != null)
 117                     listener.onFailure(e);
 118                 else
 119                     ErrorLogger.defaultLogError(e);
 120             } else {
 121                 attachStateListener(session, experiment, _run.get());
 122                 if (successCallback != null)
 123                     successCallback.accept(_run.get());
 124                 if (listener != null)
 125                     listener.onExperimentActivated(experiment);
 126             }
 127         });
 128     }
 129
 130     /**
 131      * Add listener for tracking run IsActive state in the graph.
 132      *
 133      * @param session
 134      * @param experiment
 135      * @param run
 136      */
 137     private static void attachStateListener(final Session session, IExperiment experiment, final Resource run) {
 138         experiment.addListener(new IExperimentListener() {
 139             @Override
 140             public void stateChanged(ExperimentState state) {
 141                 if (state == ExperimentState.DISPOSED) {
 142                     VirtualGraph runtime = session.getService(VirtualGraph.class);
 143                     session.asyncRequest(new WriteRequest(runtime) {
 144                         @Override
 145                         public void perform(WriteGraph graph) throws DatabaseException {
 146                             SimulationResource SIMU = SimulationResource.getInstance(graph);
 147                             graph.denyStatement(run, SIMU.IsActive, run);
 148
 149                             CommentMetadata cm = graph.getMetadata(CommentMetadata.class);
 150                             graph.addMetadata(cm.add("Attaching state listener to track isActive for run"));
 151                         }
 152                     }, e -> {
 153                         if (e != null)
 154                             ErrorLogger.defaultLogError(e);
 155                     });
 156                 }
 157             }
 158         });
 159     }
 160
 161 }