diff --git a/visualiser/src/main/java/seng302/Controllers/RaceController.java b/visualiser/src/main/java/seng302/Controllers/RaceController.java index 61a2e6b0..143fbc7a 100644 --- a/visualiser/src/main/java/seng302/Controllers/RaceController.java +++ b/visualiser/src/main/java/seng302/Controllers/RaceController.java @@ -95,6 +95,13 @@ public class RaceController extends Controller { }); } + /** + * Creates and sets initial display for Sparkline for race positions. + * A data series for each boat in the race is added. + * Position numbers are displayed. + * + * @param boats boats to display on the sparkline + */ public void createSparkLine(ObservableList boats){ // NOTE: Y axis is in negatives to display correct positions @@ -221,6 +228,12 @@ public class RaceController extends Controller { }); } + /** + * Updates the sparkline to display current boat positions. + * New points are plotted to represent each boat when required. + * + * @param boatsInRace used for current boat positions. + */ public void updateSparkline(ObservableList boatsInRace){ int placingVal = boatsInRace.size(); sparkLineNumber++;