Timeline updated (executeUntil, setTimeFunction)
authorFabian Stemmler <stemmler@in.tum.de>
Wed, 29 May 2019 06:22:04 +0000 (08:22 +0200)
committerFabian Stemmler <stemmler@in.tum.de>
Wed, 29 May 2019 06:22:04 +0000 (08:22 +0200)
The timeline method executeUpto(timestamp, timeout), has been changed to
executeUntil(condition, timeout). The timeline method setTimeFunction
was added (e.g. to allow for real-time simulation). The timeFunction is
called whenever the timeline needs to find out the current simulation
time.

LogicUI/src/era/mi/gui/LogicUIStandalone.java
LogicUI/src/era/mi/gui/components/GUIManualSwitch.java
LogicUI/src/era/mi/gui/examples/RSLatchGUIExample.java
SampleERCP/src/sampleercp/parts/LogicUIPart.java
era.mi/src/era/mi/logic/tests/ComponentTest.java
era.mi/src/era/mi/logic/tests/GUITest.java
era.mi/src/era/mi/logic/timeline/Timeline.java

index c50af4a..db498ac 100644 (file)
@@ -54,7 +54,7 @@ public class LogicUIStandalone
                        while (running.get())\r
                        {\r
                                // always execute to keep timeline from "hanging behind" for too long\r
-                               timeline.executeUpTo(System.currentTimeMillis(), System.currentTimeMillis() + 10);\r
+                               timeline.executeUntil(timeline.laterThan(System.currentTimeMillis()), System.currentTimeMillis() + 10);\r
                                long sleepTime;\r
                                if (timeline.hasNext())\r
                                        sleepTime = timeline.nextEventTime() - System.currentTimeMillis();\r
index 5de11cc..ff674c5 100644 (file)
@@ -72,7 +72,7 @@ public class GUIManualSwitch extends ManualSwitch implements BasicGUIComponent
        @Override\r
        public boolean clicked(double x, double y)\r
        {\r
-               toggle();\r
+               timeline.addEvent((e) -> toggle(), (int) (System.currentTimeMillis() - timeline.getSimulationTime()));\r
                return true;\r
        }\r
 \r
index 49dadc8..405088d 100644 (file)
@@ -19,6 +19,7 @@ public class RSLatchGUIExample
        public static void main(String[] args)\r
        {\r
                Timeline t = new Timeline(11);\r
+               t.setTimeFunction(() -> System.currentTimeMillis()); // real time simulation\r
                LogicUIStandalone ui = new LogicUIStandalone(t);\r
                addComponentsAndWires(ui.getLogicUICanvas(), t);\r
                ui.run();\r
index f725d5b..ee1d775 100644 (file)
@@ -34,7 +34,7 @@ public class LogicUIPart
                        while (!ui.isDisposed())
                        {
                                // always execute to keep timeline from "hanging behind" for too long
-                               timeline.executeUpTo(System.currentTimeMillis(), System.currentTimeMillis() + 10);
+                               timeline.executeUntil(timeline.laterThan(System.currentTimeMillis()), System.currentTimeMillis() + 10);
                                long sleepTime;
                                if (timeline.hasNext())
                                        sleepTime = timeline.nextEventTime() - System.currentTimeMillis();
index 831349d..ffd6550 100644 (file)
@@ -1,5 +1,6 @@
 package era.mi.logic.tests;\r
 \r
+import static org.junit.Assert.assertTrue;\r
 import static org.junit.jupiter.api.Assertions.assertArrayEquals;\r
 import static org.junit.jupiter.api.Assertions.assertEquals;\r
 import static org.junit.jupiter.api.Assertions.fail;\r
@@ -284,6 +285,42 @@ class ComponentTest
                assertEquals(-1, a.getSignedValue());\r
        }\r
 \r
+       boolean flag = false;\r
+\r
+       @Test\r
+       void simpleTimelineTest()\r
+       {\r
+               Timeline t = new Timeline(3);\r
+               flag = false;\r
+               t.addEvent((e) ->\r
+               {\r
+                       if (!flag)\r
+                               fail();\r
+                       flag = false;\r
+               }, 15);\r
+               t.addEvent((e) ->\r
+               {\r
+                       if (flag)\r
+                               fail();\r
+                       flag = true;\r
+               }, 10);\r
+               t.addEvent((e) ->\r
+               {\r
+                       if (flag)\r
+                               fail();\r
+                       flag = true;\r
+               }, 20);\r
+               t.addEvent((e) ->\r
+               {\r
+                       fail("Only supposed to execute until timestamp 20, not 25");\r
+               }, 25);\r
+\r
+               t.executeUntil(t.laterThan(20), 100);\r
+\r
+               if (!flag)\r
+                       fail();\r
+       }\r
+\r
        @Test\r
        void multipleInputs()\r
        {\r
index 28798d4..0ff118a 100644 (file)
@@ -282,7 +282,7 @@ public class GUITest extends JPanel
 \r
                while (f.isVisible())\r
                {\r
-                       ExecutionResult er = gt.getTimeline().executeUpTo((lastFrame - begin) * 3, lastFrame + 14);\r
+                       ExecutionResult er = gt.getTimeline().executeUntil(gt.getTimeline().laterThan((lastFrame - begin) * 3), lastFrame + 14);\r
 //                             if (t.hasNext()) \r
 //                             t.executeNext();\r
                        if (er != ExecutionResult.NOTHING_DONE)\r
index c22e1a4..20af398 100644 (file)
@@ -3,7 +3,9 @@ package era.mi.logic.timeline;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.PriorityQueue;
+import java.util.function.BooleanSupplier;
 import java.util.function.Consumer;
+import java.util.function.LongSupplier;
 
 /**
  * Orders Events by the time they are due to be executed. Can execute Events individually.
@@ -14,7 +16,8 @@ import java.util.function.Consumer;
 public class Timeline
 {
        private PriorityQueue<InnerEvent> events;
-       private long currentTime = 0;
+       private LongSupplier time;
+       private long lastTimeUpdated = 0;
 
        private final List<Consumer<TimelineEvent>> eventAddedListener;
 
@@ -23,6 +26,16 @@ public class Timeline
                events = new PriorityQueue<InnerEvent>(initCapacity);
 
                eventAddedListener = new ArrayList<>();
+               time = () -> lastTimeUpdated;
+       }
+
+       /**
+        * @param timestamp exclusive
+        * @return true if the first event is later than the timestamp
+        */
+       public BooleanSupplier laterThan(long timestamp)
+       {
+               return () -> timeCmp(events.peek().getTiming(), timestamp) > 0;
        }
 
        public boolean hasNext()
@@ -30,11 +43,14 @@ public class Timeline
                return !events.isEmpty();
        }
 
+       /**
+        * Executes all events at the next timestamp, at which there are any
+        */
        public void executeNext()
        {
                InnerEvent first = events.peek();
                if (first != null)
-                       executeUpTo(first.getTiming(), -1);
+                       executeUntil(laterThan(first.getTiming()), -1);
        }
 
        public void executeAll()
@@ -44,40 +60,51 @@ public class Timeline
        }
 
        /**
-        * Executes all events up to a given simulation timestamp. The simulation process can be constrained by a real world timestamp.
+        * Executes all events until a given condition is met. The simulation process can be constrained by a real world timestamp.
         * 
-        * @param timestamp  the simulation timestamp up to which the events will be processed
+        * @param condition  the condition until which the events are be processed
         * @param stopMillis the System.currentTimeMillis() when simulation definitely needs to stop. A value of -1 means no timeout.
-        * @return if it was possible to fulfill the goal in the given real world time.
-        * @author Christian Femers
+        * @return State of the event execution
+        * @formatter:off
+        * <code>NOTHING_DONE</code> if the {@link Timeline} was already empty
+        * <code>EXEC_OUT_OF_TIME</code> if the given maximum time was reached
+        * <code>EXEC_UNTIL_CONDITION</code> if the condition was met
+        * <code>EXEC_UNTIL_EMPTY</code> if events were executed until the {@link Timeline} was empty
+        * @formatter:on
+        * @author Christian Femers, Fabian Stemmler
         */
-       public ExecutionResult executeUpTo(long timestamp, long stopMillis)
+       public ExecutionResult executeUntil(BooleanSupplier condition, long stopMillis)
        {
                if (events.isEmpty())
                {
-                       currentTime = timestamp;
+                       lastTimeUpdated = getSimulationTime();
                        return ExecutionResult.NOTHING_DONE;
                }
                int checkStop = 0;
                InnerEvent first = events.peek();
-               while (first != null && first.getTiming() <= timestamp)
+               while (hasNext() && !condition.getAsBoolean())
                {
                        events.remove();
-                       currentTime = first.getTiming();
+                       lastTimeUpdated = first.getTiming();
                        first.run();
                        // Don't check after every run
                        checkStop = (checkStop + 1) % 10;
                        if (checkStop == 0 && System.currentTimeMillis() >= stopMillis)
-                               return ExecutionResult.RAN_OUT_OF_TIME;
+                               return ExecutionResult.EXEC_OUT_OF_TIME;
                        first = events.peek();
                }
-               currentTime = timestamp;
-               return ExecutionResult.DONE_IN_TIME;
+               lastTimeUpdated = getSimulationTime();
+               return hasNext() ? ExecutionResult.EXEC_UNTIL_EMPTY : ExecutionResult.EXEC_UNTIL_CONDITION;
+       }
+
+       public void setTimeFunction(LongSupplier time)
+       {
+               this.time = time;
        }
 
        public long getSimulationTime()
        {
-               return currentTime;
+               return time.getAsLong();
        }
 
        public long nextEventTime()
@@ -90,7 +117,7 @@ public class Timeline
        public void reset()
        {
                events.clear();
-               currentTime = 0;
+               lastTimeUpdated = 0;
        }
 
        public void addEventAddedListener(Consumer<TimelineEvent> listener)
@@ -111,7 +138,7 @@ public class Timeline
         */
        public void addEvent(TimelineEventHandler function, int relativeTiming)
        {
-               long timing = currentTime + relativeTiming;
+               long timing = getSimulationTime() + relativeTiming;
                TimelineEvent event = new TimelineEvent(timing);
                events.add(new InnerEvent(function, event));
                eventAddedListener.forEach(l -> l.accept(event));
@@ -154,26 +181,23 @@ public class Timeline
                @Override
                public int compareTo(InnerEvent o)
                {
-                       long difference = getTiming() - o.getTiming();
-                       if (difference == 0)
-                               return 0;
-                       return difference < 0 ? -1 : 1;
+                       return timeCmp(getTiming(), o.getTiming());
                }
        }
 
-       @Override
-       public String toString()
+       private static int timeCmp(long a, long b)
        {
-               return "simulation time: " + currentTime + ", " + events.toString();
+               return Long.signum(a - b);
        }
 
-       public static long toNanoseconds(long ticks)
+       @Override
+       public String toString()
        {
-               return ticks; // TODO: Alter this when it has been determined how ticks should relate to real time.
+               return String.format("Simulation time: %s, Last update: %d, Events: %s", getSimulationTime(), lastTimeUpdated, events.toString());
        }
 
        public enum ExecutionResult
        {
-               NOTHING_DONE, DONE_IN_TIME, RAN_OUT_OF_TIME
+               NOTHING_DONE, EXEC_UNTIL_EMPTY, EXEC_UNTIL_CONDITION, EXEC_OUT_OF_TIME
        }
 }
\ No newline at end of file