X-Git-Url: https://mograsim.net/gitweb/?a=blobdiff_plain;f=era.mi%2Fsrc%2Fera%2Fmi%2Flogic%2Ftimeline%2FTimeline.java;h=63d739500d125c2edf9c4525ffcc2f0db26dbb88;hb=c1d0ddc342c482051fa6c455bb286617135bd3c3;hp=3e3b9f6d94248edc6349bc8d062de7eeb3ecbf39;hpb=de79184d60c80d6775b368e61d3368de032952e8;p=Mograsim.git

diff --git a/era.mi/src/era/mi/logic/timeline/Timeline.java b/era.mi/src/era/mi/logic/timeline/Timeline.java
index 3e3b9f6d..63d73950 100644
--- a/era.mi/src/era/mi/logic/timeline/Timeline.java
+++ b/era.mi/src/era/mi/logic/timeline/Timeline.java
@@ -7,6 +7,7 @@ import java.util.function.Consumer;
 
 /**
  * Orders Events by the time they are due to be executed. Can execute Events individually.
+ * 
  * @author Fabian Stemmler
  *
  */
@@ -14,21 +15,22 @@ 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, (a, b) -> {
+		events = new PriorityQueue<InnerEvent>(initCapacity, (a, b) ->
+		{
 			long difference = a.getTiming() - b.getTiming();
-			if(difference == 0)
+			if (difference == 0)
 				return 0;
 			return difference < 0 ? -1 : 1;
 		});
-		
+
 		eventAddedListener = new ArrayList<>();
 	}
-	
+
 	public boolean hasNext()
 	{
 		return !events.isEmpty();
@@ -40,21 +42,18 @@ public class Timeline
 		currentTime = first.getTiming();
 		first.run();
 	}
-	
+
 	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.
+	 * 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.
+	 * @param timestamp  the simulation timestamp up to which the events will be processed
+	 * @param stopMillis the System.currentTimeMillis() when simulation definitely needs to stop.
 	 * @return if it was possible to fulfil the goal in the given real world time.
 	 * @author Christian Femers
 	 */
@@ -89,12 +88,12 @@ public class Timeline
 
 	public long nextEventTime()
 	{
-		if(!hasNext())
+		if (!hasNext())
 			return -1;
 		else
 			return events.peek().timing;
 	}
-	
+
 	public void reset()
 	{
 		events.clear();
@@ -105,14 +104,16 @@ public class Timeline
 	{
 		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 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)
@@ -122,18 +123,19 @@ public class Timeline
 		events.add(new InnerEvent(function, event, timing));
 		eventAddedListener.forEach(l -> l.accept(event));
 	}
-	
+
 	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;
+		 * @param timing   Point in the MI simulation {@link Timeline}, at which the {@link InnerEvent} is executed;
 		 */
 		InnerEvent(TimelineEventHandler function, TimelineEvent event, long timing)
 		{
@@ -146,32 +148,32 @@ public class Timeline
 		{
 			return timing;
 		}
-		
+
 		public void run()
 		{
 			function.handle(event);
 		}
-		
+
 		@Override
 		public String toString()
 		{
 			return event.toString();
 		}
 	}
-	
+
 	@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.
+		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 
+		NOTHING_DONE, DONE_IN_TIME, RAN_OUT_OF_TIME
 	}
 }
\ No newline at end of file