-package era.mi.logic.timeline;\r
-\r
-import java.util.PriorityQueue;\r
-\r
-/**\r
- * Orders Events by the time they are due to be executed. Can execute Events individually.\r
- * @author Fabian Stemmler\r
- *\r
- */\r
-public class Timeline\r
-{\r
- private PriorityQueue<InnerEvent> events;\r
- private long currentTime = 0;\r
- \r
- public Timeline(int initCapacity)\r
- {\r
- events = new PriorityQueue<InnerEvent>(initCapacity, (a, b) -> {\r
- long difference = a.getTiming() - b.getTiming();\r
- if(difference == 0)\r
- return 0;\r
- return difference < 0 ? -1 : 1;\r
- });\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
- public long getSimulationTime()\r
- {\r
- return currentTime;\r
- }\r
- \r
- public void reset()\r
- {\r
- events.clear();\r
- currentTime = 0;\r
- }\r
- \r
- /**\r
- * Adds an Event to the {@link Timeline}\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
- events.add(new InnerEvent(function, new TimelineEvent(timing), timing));\r
- }\r
- \r
- private class InnerEvent\r
- {\r
-\r
- private final long timing;\r
- private final TimelineEventHandler function;\r
- private final TimelineEvent event;\r
- \r
- /**\r
- * Creates an {@link InnerEvent}\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
+package era.mi.logic.timeline;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.PriorityQueue;
+import java.util.function.Consumer;
+
+/**
+ * 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;
+
+ private final List<Consumer<TimelineEvent>> eventAddedListener;
+
+ public Timeline(int initCapacity)
+ {
+ events = new PriorityQueue<InnerEvent>(initCapacity);
+
+ eventAddedListener = new ArrayList<>();
+ }
+
+ public boolean hasNext()
+ {
+ return !events.isEmpty();
+ }
+
+ public void executeNext()
+ {
+ InnerEvent first = events.peek();
+ if (first != null)
+ executeUpTo(first.getTiming(), -1);
+ }
+
+ public void executeAll()
+ {
+ while (hasNext())
+ executeNext();
+ }
+
+ /**
+ * Executes all events up to a given simulation timestamp. 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 stopMillis the System.currentTimeMillis() when simulation definitely needs to stop. A value of -1 means no timeout.
+ * @return if it was possible to fulfil the goal in the given real world time.
+ * @author Christian Femers
+ */
+ public ExecutionResult executeUpTo(long timestamp, long stopMillis)
+ {
+ if (events.isEmpty())
+ {
+ currentTime = timestamp;
+ return ExecutionResult.NOTHING_DONE;
+ }
+ int checkStop = 0;
+ InnerEvent first = events.peek();
+ while (first != null && first.getTiming() <= timestamp)
+ {
+ events.remove();
+ currentTime = 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;
+ first = events.peek();
+ }
+ currentTime = timestamp;
+ return ExecutionResult.DONE_IN_TIME;
+ }
+
+ public long getSimulationTime()
+ {
+ return currentTime;
+ }
+
+ public long nextEventTime()
+ {
+ if (!hasNext())
+ return -1;
+ return events.peek().getTiming();
+ }
+
+ public void reset()
+ {
+ events.clear();
+ currentTime = 0;
+ }
+
+ public void addEventAddedListener(Consumer<TimelineEvent> listener)
+ {
+ eventAddedListener.add(listener);
+ }
+
+ public void removeEventAddedListener(Consumer<TimelineEvent> listener)
+ {
+ eventAddedListener.remove(listener);
+ }
+
+ /**
+ * 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;
+ TimelineEvent event = new TimelineEvent(timing);
+ events.add(new InnerEvent(function, event));
+ eventAddedListener.forEach(l -> l.accept(event));
+ }
+
+ private class InnerEvent implements Comparable<InnerEvent>
+ {
+ 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)
+ {
+ this.function = function;
+ this.event = event;
+ }
+
+ public long getTiming()
+ {
+ return event.getTiming();
+ }
+
+ public void run()
+ {
+ function.handle(event);
+ }
+
+ @Override
+ public String toString()
+ {
+ return event.toString();
+ }
+
+ @Override
+ public int compareTo(InnerEvent o)
+ {
+ long difference = getTiming() - o.getTiming();
+ if (difference == 0)
+ return 0;
+ return difference < 0 ? -1 : 1;
+ }
+ }
+
+ @Override
+ public String toString()
+ {
+ return "simulation time: " + currentTime + ", " + events.toString();
+ }
+
+ public static long toNanoseconds(long ticks)
+ {
+ return ticks; // TODO: Alter this when it has been determined how ticks should relate to real time.
+ }
+
+ public enum ExecutionResult
+ {
+ NOTHING_DONE, DONE_IN_TIME, RAN_OUT_OF_TIME
+ }
}
\ No newline at end of file
projects / Mograsim.git / blobdiff