Merge remote-tracking branch 'origin/fix/86-clockmanager-behavior' into develop

Author: remikey

CHANGELOG.md

@@ -4,6 +4,28 @@ This file lists modifications introduced by each version.
 
 ## [Unreleased]
 
+###  ClockManager class modifications
+
+**Bug fixes in ClockManager:**
+
+[[issue 86]][issue: #86]
+
+* The modification of the `ClockManager`'s internal time value (the one actually used by the `Topology`) now coincides 
+  with the ticking of the `Clock`.
+  
+  Now, the clock is first incremented and then the `Scheduler` is called. 
+  It was previously swapped, resulting in some user interactions happening before the call to the `Scheduler` (and thus 
+  the `MessageEngine` and all `Node.onClock()`).
+  Everything is now properly synchronized.
+
+**Symbol modification in ClockManager**
+
+* `ClockManager.currentTime()` now returns an `int` instead of an `Integer`
+
+  This value could never be `null`. The return value being an object was a remnant of previous versions. 
+  
+[issue: #86]: https://github.com/jbotsim/JBotSim/issues/86
+
 ### New icon in the jbotsim-icons module
 
 `jbotsim-icons`/`io.jbotsim.ui.icons`

apps/test-classes/src/main/java/io/jbotsim/core/ClockManagerTestMain.java

@@ -0,0 +1,102 @@
+/*
+ * Copyright 2008 - 2019, Arnaud Casteigts and the JBotSim contributors <contact@jbotsim.io>
+ *
+ *
+ * This file is part of JBotSim.
+ *
+ * JBotSim is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * JBotSim is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with JBotSim.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+package io.jbotsim.core;
+
+import io.jbotsim.core.event.ClockListener;
+import io.jbotsim.ui.JViewer;
+
+/**
+ * This class purpose is to check/showcase behaviors linked to the ClockManager
+ */
+public class ClockManagerTestMain {
+    public static void main(String[] args) {
+        Topology topology = new Topology();
+        topology.setDefaultNodeModel(ClockNode.class);
+        topology.setTimeUnit(2000);
+
+        topology.addClockListener(new MyClockListener(topology));
+
+        topology.addNode(100, 100);
+
+        new JViewer(topology);
+
+//        topology.start();
+    }
+
+    public static class ClockNode extends Node {
+        public ClockNode() {
+//            msg("constructor");
+        }
+
+        @Override
+        public void onStart() {
+            msg("onStart");
+        }
+
+        @Override
+        public void onStop() {
+            msg("onStop");
+        }
+
+        @Override
+        public void onPreClock() {
+            msg("onPreClock");
+        }
+
+        @Override
+        public void onClock() {
+            msg("onClock");
+        }
+
+        @Override
+        public void onPostClock() {
+            msg("onPostClock");
+        }
+
+        @Override
+        public void onSelection() {
+            msg("onSelection");
+        }
+
+        private void msg(String methodName) {
+            System.out.println("Id=" + getID() + " " + methodName + ": " + getTime());
+        }
+    }
+
+    private static class MyClockListener implements ClockListener {
+        private final Topology topology;
+
+        public MyClockListener(Topology topology) {
+            this.topology = topology;
+            printTime();
+        }
+
+        @Override
+        public void onClock() {
+            printTime();
+        }
+
+        private void printTime() {
+            System.out.println("listener.printTime: " + topology.getTime());
+        }
+    }
+}

build.gradle

@@ -59,6 +59,9 @@ subprojects {
 
 
     dependencies{
+        testCompile(
+                'org.mockito:mockito-core:+'
+        )
         testImplementation(
                 'org.junit.jupiter:junit-jupiter-api:5.1.0',
                 'org.junit.jupiter:junit-jupiter-params:5.1.0',

lib/jbotsim-core/src/main/java/io/jbotsim/core/ClockManager.java

@@ -31,20 +31,40 @@
  * <p>The {@link ClockManager} is used by the {@link Topology} object to implement its clock mechanism.</p>
  */
 public class ClockManager {
+    final static int CLOCK_INITIAL_VALUE = 0;
+
     Topology tp;
     HashMap<ClockListener, Integer> listeners = new HashMap<>();
     HashMap<ClockListener, Integer> countdown = new HashMap<>();
     Class<? extends Clock> clockModel = null;
     Clock clock = null;
-    Integer time = 0;
-    Integer timeUnit = 10; // duration of a round in ms
+    int time = CLOCK_INITIAL_VALUE;
+    int timeUnit = 10; // duration of a round in ms
     int nbPauses = 0;
+    private boolean firstRound = true;
 
     ClockManager(Topology topology) {
         this.tp = topology;
     }
 
     public void onClock() {
+        incrementTime();
+        callScheduler();
+    }
+
+    private void incrementTime() {
+        /*
+         * The time is not incremented after resets in order to be sure that:
+         * - the first onClock() calls match the CLOCK_INITIAL_VALUE and,
+         * - the value of the clock match for first onStart() and onClock() calls
+         */
+        if(firstRound)
+            firstRound = false;
+        else
+            time++;
+    }
+
+    private void callScheduler() {
         List<ClockListener> expiredListeners = new ArrayList<>();
         for (ClockListener cl : listeners.keySet()) {
             countdown.put(cl, countdown.get(cl) - 1);
@@ -54,7 +74,6 @@ public void onClock() {
             }
         }
         tp.getScheduler().onClock(tp, expiredListeners);
-        time++;
     }
 
     /**
@@ -138,7 +157,7 @@ public void setTimeUnit(int timeUnit){
      * Returns the current round number.
      * @return the current time.
      */
-    public Integer currentTime() {
+    public int currentTime() {
         return time;
     }
 
@@ -200,9 +219,10 @@ public void resume() {
     }
 
     /**
-     * Sets the clock time to 0.
+     * Sets the clock time back to 0.
      */
     public void reset() {
-        time = 0;
+        firstRound = true;
+        time = CLOCK_INITIAL_VALUE;
     }
 }