Merge pull request #74 from FIUS/feature/sleep-method

Add sleep method in BasicEntity

ICGE-Simulation/src/main/java/de/unistuttgart/informatik/fius/icge/simulation/entity/BasicEntity.java

@@ -10,6 +10,7 @@
 package de.unistuttgart.informatik.fius.icge.simulation.entity;
 
 import java.lang.ref.WeakReference;
+import java.util.concurrent.CompletableFuture;
 
 import de.unistuttgart.informatik.fius.icge.simulation.Playfield;
 import de.unistuttgart.informatik.fius.icge.simulation.Position;
@@ -116,6 +117,24 @@ protected Simulation getSimulation() {
         return this.getPlayfield().getSimulation();
     }
 
+    /**
+     * Pause execution for {@code ticks} simulation ticks.
+     * 
+     * @param ticks
+     *     numberof simulation ticks to pause; must be > 0
+     * @throws IllegalArgumentException
+     *     if ticks is <= 0
+     */
+    public void sleep(int ticks) {
+        if (ticks <= 0) throw new IllegalArgumentException("The number of ticks must be > 0 !");
+        final CompletableFuture<Void> endOfOperation = new CompletableFuture<>();
+        try {
+            this.getSimulation().getSimulationClock().scheduleOperationInTicks(ticks, endOfOperation);
+        } finally {
+            endOfOperation.complete(null);
+        }
+    }
+
     @Override
     public String toString() {
         return getClass().getSimpleName() + "@" + Integer.toHexString(hashCode());