-package era.mi.logic.timeline;
-
-import java.util.PriorityQueue;
-
-/**
- * Orders Events by the time they are due to be executed. Can execute Events individually.
- * @author Fabian Stemmler
- *
- */
-public class Timeline
-{
- private PriorityQueue<InnerEvent> events;
- private long currentTime = 0;
-
- public Timeline(int initCapacity)
- {
- events = new PriorityQueue<InnerEvent>(initCapacity, (a, b) -> {
- //Is this really necessary? If only ints are allowed as relative timing, the difference should always be an int
- long difference = a.getTiming() - b.getTiming();
- if(difference == 0)
- return 0;
- return difference < 0 ? -1 : 1;
- });
- }
-
- public boolean hasNext()
- {
- return !events.isEmpty();
- }
-
- public void executeNext()
- {
- InnerEvent first = events.poll();
- currentTime = first.getTiming();
- first.run();
- }
-
- public long getSimulationTime()
- {
- return currentTime;
- }
-
- public void reset()
- {
- events.clear();
- currentTime = 0;
- }
-
- /**
- * Adds an Event to the {@link Timeline}
- * @param function The {@link TimelineEventHandler} that will be executed, when the {@link InnerEvent} occurs on the timeline.
- * @param relativeTiming The amount of MI ticks in which the {@link InnerEvent} is called, starting from the current time.
- */
- public void addEvent(TimelineEventHandler function, int relativeTiming)
- {
- long timing = currentTime + relativeTiming;
- events.add(new InnerEvent(function, new TimelineEvent(timing), timing));
- }
-
- private class InnerEvent
- {
-
- private final long timing;
- private final TimelineEventHandler function;
- private final TimelineEvent event;
-
- /**
- * Creates an {@link InnerEvent}
- * @param function {@link TimelineEventHandler} to be executed when the {@link InnerEvent} occurs
- * @param timing Point in the MI simulation {@link Timeline}, at which the {@link InnerEvent} is executed;
- */
- InnerEvent(TimelineEventHandler function, TimelineEvent event, long timing)
- {
- this.function = function;
- this.event = event;
- this.timing = timing;
- }
-
- public long getTiming()
- {
- return timing;
- }
-
- public void run()
- {
- function.handle(event);
- }
-
- }
+package era.mi.logic.timeline;\r
+\r
+import java.util.ArrayList;\r
+import java.util.List;\r
+import java.util.PriorityQueue;\r
+import java.util.function.Consumer;\r
+\r
+/**\r
+ * Orders Events by the time they are due to be executed. Can execute Events individually.\r
+ * \r
+ * @author Fabian Stemmler\r
+ *\r
+ */\r
+public class Timeline\r
+{\r
+ private PriorityQueue<InnerEvent> events;\r
+ private long currentTime = 0;\r
+\r
+ private final List<Consumer<TimelineEvent>> eventAddedListener;\r
+\r
+ public Timeline(int initCapacity)\r
+ {\r
+ events = new PriorityQueue<InnerEvent>(initCapacity, (a, b) ->\r
+ {\r
+ long difference = a.getTiming() - b.getTiming();\r
+ if (difference == 0)\r
+ return 0;\r
+ return difference < 0 ? -1 : 1;\r
+ });\r
+\r
+ eventAddedListener = new ArrayList<>();\r
+ }\r
+\r
+ public boolean hasNext()\r
+ {\r
+ return !events.isEmpty();\r
+ }\r
+\r
+ public void executeNext()\r
+ {\r
+ InnerEvent first = events.poll();\r
+ currentTime = first.getTiming();\r
+ first.run();\r
+ }\r
+\r
+ public void executeAll()\r
+ {\r
+ while (hasNext())\r
+ executeNext();\r
+ }\r
+\r
+ /**\r
+ * Executes all events up to a given simulation timestamp. The simulation process can be constrained by a real world timestamp.\r
+ * \r
+ * @param timestamp the simulation timestamp up to which the events will be processed\r
+ * @param stopMillis the System.currentTimeMillis() when simulation definitely needs to stop.\r
+ * @return if it was possible to fulfil the goal in the given real world time.\r
+ * @author Christian Femers\r
+ */\r
+ public ExecutionResult executeUpTo(long timestamp, long stopMillis)\r
+ {\r
+ if (events.isEmpty())\r
+ {\r
+ currentTime = timestamp;\r
+ return ExecutionResult.NOTHING_DONE;\r
+ }\r
+ int checkStop = 0;\r
+ InnerEvent first = events.peek();\r
+ while (first != null && first.getTiming() <= timestamp)\r
+ {\r
+ events.remove();\r
+ currentTime = first.getTiming();\r
+ first.run();\r
+ // Don't check after every run\r
+ checkStop = (checkStop + 1) % 10;\r
+ if (checkStop == 0 && System.currentTimeMillis() >= stopMillis)\r
+ return ExecutionResult.RAN_OUT_OF_TIME;\r
+ first = events.peek();\r
+ }\r
+ currentTime = timestamp;\r
+ return ExecutionResult.DONE_IN_TIME;\r
+ }\r
+\r
+ public long getSimulationTime()\r
+ {\r
+ return currentTime;\r
+ }\r
+\r
+ public long nextEventTime()\r
+ {\r
+ if (!hasNext())\r
+ return -1;\r
+ return events.peek().timing;\r
+ }\r
+\r
+ public void reset()\r
+ {\r
+ events.clear();\r
+ currentTime = 0;\r
+ }\r
+\r
+ public void addEventAddedListener(Consumer<TimelineEvent> listener)\r
+ {\r
+ eventAddedListener.add(listener);\r
+ }\r
+\r
+ public void removeEventAddedListener(Consumer<TimelineEvent> listener)\r
+ {\r
+ eventAddedListener.remove(listener);\r
+ }\r
+\r
+ /**\r
+ * Adds an Event to the {@link Timeline}\r
+ * \r
+ * @param function The {@link TimelineEventHandler} that will be executed, when the {@link InnerEvent} occurs on the timeline.\r
+ * @param relativeTiming The amount of MI ticks in which the {@link InnerEvent} is called, starting from the current time.\r
+ */\r
+ public void addEvent(TimelineEventHandler function, int relativeTiming)\r
+ {\r
+ long timing = currentTime + relativeTiming;\r
+ TimelineEvent event = new TimelineEvent(timing);\r
+ events.add(new InnerEvent(function, event, timing));\r
+ eventAddedListener.forEach(l -> l.accept(event));\r
+ }\r
+\r
+ private class InnerEvent\r
+ {\r
+\r
+ final long timing;\r
+ private final TimelineEventHandler function;\r
+ private final TimelineEvent event;\r
+\r
+ /**\r
+ * Creates an {@link InnerEvent}\r
+ * \r
+ * @param function {@link TimelineEventHandler} to be executed when the {@link InnerEvent} occurs\r
+ * @param timing Point in the MI simulation {@link Timeline}, at which the {@link InnerEvent} is executed;\r
+ */\r
+ InnerEvent(TimelineEventHandler function, TimelineEvent event, long timing)\r
+ {\r
+ this.function = function;\r
+ this.event = event;\r
+ this.timing = timing;\r
+ }\r
+\r
+ public long getTiming()\r
+ {\r
+ return timing;\r
+ }\r
+\r
+ public void run()\r
+ {\r
+ function.handle(event);\r
+ }\r
+\r
+ @Override\r
+ public String toString()\r
+ {\r
+ return event.toString();\r
+ }\r
+ }\r
+\r
+ @Override\r
+ public String toString()\r
+ {\r
+ return "simulation time: " + currentTime + ", " + events.toString();\r
+ }\r
+\r
+ public static long toNanoseconds(long ticks)\r
+ {\r
+ return ticks; // TODO: Alter this when it has been determined how ticks should relate to real time.\r
+ }\r
+\r
+ public enum ExecutionResult\r
+ {\r
+ NOTHING_DONE, DONE_IN_TIME, RAN_OUT_OF_TIME\r
+ }\r
}
\ No newline at end of file
projects / Mograsim.git / blobdiff