Merge branch 'develop' of https://eng-git.canterbury.ac.nz/seng302-2017/team-13 into develop

# Conflicts:
#	src/test/java/seng302/models/BoatGroupTest.java

src/main/java/seng302/models/Boat.java

@@ -1,147 +0,0 @@
-package seng302.models;
-
-import javafx.geometry.Point2D;
-import javafx.scene.paint.Color;
-import javafx.scene.shape.Polygon;
-import javafx.scene.text.Text;
-import javafx.scene.transform.Rotate;
-import javafx.scene.transform.Translate;
-import javafx.util.Pair;
-
-/**
-* Represents a boat in the race.
-*/
-public class Boat {
-
-    private String teamName;
-    private double velocity;
-    private double lat;
-    private double lon;
-    private double heading;
-    private int markLastPast;
-    private String shortName;
-    private int id;
-
-    /**
-     * For testing only.
-     * @param teamName Boat team name.
-     */
-    public Boat(String teamName) {
-        this.teamName = teamName;
-        this.velocity = 10; // Default velocity
-        this.lat = 0.0;
-        this.lon = 0.0;
-        this.shortName = "";
-    }
-
-
-    /**
-     * Represents a boat in the race.
-     *
-     * @param teamName     The name of the team sailing the boat
-     * @param boatVelocity The speed of the boat in meters/second
-     * @param shortName    A shorter version of the teams name
-     */
-    public Boat(String teamName, double boatVelocity, String shortName, int id) {
-        this.teamName = teamName;
-        this.velocity = boatVelocity;
-        this.shortName = shortName;
-        this.id = id;
-    }
-
-    /**
-     * Returns the name of the team sailing the boat
-     *
-     * @return The name of the team
-     */
-    public String getTeamName() {
-        return this.teamName;
-    }
-
-    /**
-     * Sets the name of the team sailing the boat
-     *
-     * @param teamName The name of the team
-     */
-    public void setTeamName(String teamName) {
-        this.teamName = teamName;
-    }
-
-    /**
-     * Gets velocity of the boat
-     *
-     * @return a float number of the boat velocity
-     */
-    public double getVelocity() {
-        return this.velocity;
-    }
-
-    /**
-     * Sets velocity of the boat
-     *
-     * @param velocity The velocity of boat
-     */
-    public void setVelocity(double velocity) {
-        this.velocity = velocity;
-    }
-
-    /**
-     * Sets the boats location
-     *
-     * @param lat, the boats latitude
-     * @param lon, the boats longitude
-     */
-    public void setLocation(double lat, double lon) {
-        this.lat = lat;
-        this.lon = lon;
-    }
-
-    public Pair<Double, Double> getLocation ()
-    {
-        return new Pair<>(this.lat, this.lon);
-    }
-
-    public double getLatitude(){
-        return this.lat;
-    }
-
-    public double getLongitude(){
-        return this.lon;
-    }
-
-    public void setLatitude (double latitude) {
-        this.lat = latitude;
-    }
-
-    public void setlongitude (double longitude) {
-        this.lon =longitude;
-    }
-
-    public double getSpeedInKnots(){
-        return Math.round((this.velocity * 1.94384) * 100d) / 100d;
-    }
-
-    public void setMarkLastPast(int markLastPast) {
-        this.markLastPast = markLastPast;
-    }
-
-    public int getMarkLastPast() {
-        return markLastPast;
-    }
-
-    public double getHeading(){
-        return this.heading;
-    }
-
-    public void setHeading(double heading) {
-        this.heading = heading;
-    }
-
-    public String getShortName(){
-        return this.shortName;
-    }
-
-    public int getId() {
-        return id;
-    }
-}

src/main/java/seng302/models/BoatGroup.java

@@ -33,7 +33,7 @@ public class BoatGroup extends RaceObject{
     private int wakeGenerationDelay = 10;
     private double distanceTravelled;
     //Graphical objects
-    private Boat boat;
+    private Yacht boat;
     private Group lineGroup = new Group();
     private Polygon boatPoly;
     private Text teamNameObject;
@@ -54,7 +54,7 @@ public class BoatGroup extends RaceObject{
      *             BoatGroup to update.
      * @param color The colour of the boat polygon and the trailing line.
      */
-    public BoatGroup (Boat boat, Color color){
+    public BoatGroup (Yacht boat, Color color){
         this.boat = boat;
         initChildren(color);
     }
@@ -66,7 +66,7 @@ public class BoatGroup extends RaceObject{
      * @param color The colour of the boat polygon and the trailing line.
      * @param points An array of co-ordinates x1,y1,x2,y2,x3,y3... that will make up the boat polygon.
      */
-    public BoatGroup (Boat boat, Color color, double... points)
+    public BoatGroup (Yacht boat, Color color, double... points)
     {
         this.boat = boat;
         initChildren(color, points);
@@ -295,7 +295,7 @@ public class BoatGroup extends RaceObject{
         wake.setVisible(visible);
     }
 
-    public Boat getBoat() {
+    public Yacht getBoat() {
         return boat;
     }
 
@@ -307,7 +307,7 @@ public class BoatGroup extends RaceObject{
      */
     public boolean hasRaceId (int... raceIds) {
         for (int id : raceIds) {
-            if (id == boat.getId())
+            if (id == boat.getSourceID())
                 return true;
         }
         return false;
@@ -319,7 +319,7 @@ public class BoatGroup extends RaceObject{
      * @return An array containing all ID's associated with this RaceObject.
      */
     public int[] getRaceIds () {
-        return new int[] {boat.getId()};
+        return new int[] {boat.getSourceID()};
     }
 
     /**

src/main/java/seng302/models/Event.java

@@ -11,7 +11,7 @@ import java.util.Date;
 */
 public class Event {
     private Double time; // Time the event occurs
-    private Boat boat;
+    private Yacht boat;
     private boolean isFinishingEvent = false; // This event occurs when a boat finishes the race
     private Mark mark1; // This mark
     private Mark mark2; // Next mark
@@ -28,7 +28,7 @@ public class Event {
      * @param eventTime, what time the event happens
      * @param eventBoat, the boat that the event belongs to
      */
-    public Event(Double eventTime, Boat eventBoat, Mark mark1, Mark mark2, int markPosInRace) {
+    public Event(Double eventTime, Yacht eventBoat, Mark mark1, Mark mark2, int markPosInRace) {
         this.time = eventTime;
         this.boat = eventBoat;
         this.mark1 = mark1;
@@ -45,7 +45,7 @@ public class Event {
      * @param eventTime, what time the event happens
      * @param eventBoat, the boat that the event belongs to
      */
-    public Event(Double eventTime, Boat eventBoat, Mark mark1, int markPosInRace) {
+    public Event(Double eventTime, Yacht eventBoat, Mark mark1, int markPosInRace) {
         this.time = eventTime;
         this.boat = eventBoat;
         this.mark1 = mark1;
@@ -70,11 +70,11 @@ public class Event {
         return (new SimpleDateFormat("mm:ss:SSS")).format(new Date(time.longValue()));
     }
 
-    public Boat getBoat() {
+    public Yacht getBoat() {
         return this.boat;
     }
 
-    public void setBoat(Boat eventBoat) {
+    public void setBoat(Yacht eventBoat) {
         this.boat = eventBoat;
     }
 
@@ -90,10 +90,10 @@ public class Event {
     public String getEventString() {
         // This event is a boat finishing the race
         if (this.isFinishingEvent) {
-            return (this.getTimeString() + ", " + this.getBoat().getTeamName() + " finished the race");
+            return (this.getTimeString() + ", " + this.getBoat().getBoatName() + " finished the race");
         }
 //        System.out.println(this.getDistanceBetweenMarks());
-        return (this.getTimeString() + ", " + this.getBoat().getTeamName() + " passed " + this.mark1.getName() + " going heading " + this.getBoatHeading() + "°");
+        return (this.getTimeString() + ", " + this.getBoat().getBoatName() + " passed " + this.mark1.getName() + " going heading " + this.getBoatHeading() + "°");
     }
 
     /**

src/main/java/seng302/models/Race.java

@@ -10,9 +10,9 @@ import java.util.*;
  */
 public class Race {
 
-    private ArrayList<Boat> boats; // The boats in the race
-    private ArrayList<Boat> finishingOrder; // The order in which the boats finish the race
-    private HashMap<Boat, List> events = new HashMap<>(); // The events that occur in the race
+    private ArrayList<Yacht> boats; // The boats in the race
+    private ArrayList<Yacht> finishingOrder; // The order in which the boats finish the race
+    private HashMap<Yacht, List> events = new HashMap<>(); // The events that occur in the race
     private List<Mark> course; // Marks in the race
     private long startTime = 0;
     private double timeScale = 1;
@@ -33,7 +33,7 @@ public class Race {
      *
      * @param boat, the boat to add
      */
-    public void addBoat(Boat boat) {
+    public void addBoat(Yacht boat) {
         boats.add(boat);
     }
 
@@ -42,12 +42,12 @@ public class Race {
      *
      * @return a list of boats
      */
-    public Boat[] getShuffledBoats() {
+    public Yacht[] getShuffledBoats() {
         // Shuffle the list of boats
         long seed = System.nanoTime();
         Collections.shuffle(this.boats, new Random(seed));
 
-        return boats.toArray(new Boat[boats.size()]);
+        return boats.toArray(new Yacht[boats.size()]);
     }
 
     /**
@@ -56,8 +56,8 @@ public class Race {
      *
      * @return a list of boats
      */
-    public Boat[] getFinishedBoats() {
-        return this.finishingOrder.toArray(new Boat[this.finishingOrder.size()]);
+    public Yacht[] getFinishedBoats() {
+        return this.finishingOrder.toArray(new Yacht[this.finishingOrder.size()]);
     }
 
 
@@ -66,8 +66,8 @@ public class Race {
      *
      * @return a list of the boats competing in the race
      */
-    public Boat[] getBoats() {
-        return boats.toArray(new Boat[boats.size()]);
+    public Yacht[] getBoats() {
+        return boats.toArray(new Yacht[boats.size()]);
     }
 
     /**
@@ -84,7 +84,7 @@ public class Race {
      */
     private void generateEvents() {
 
-        for (Boat boat : this.boats) {
+        for (Yacht boat : this.boats) {
             double totalDistance = 0;
             int numberOfMarks = this.course.size();
 
@@ -146,7 +146,7 @@ public class Race {
      * Get a map of the events in the race
      * @return
      */
-    public HashMap<Boat, List> getEvents() {
+    public HashMap<Yacht, List> getEvents() {
         return events;
     }
 
@@ -154,7 +154,7 @@ public class Race {
      * Set a boat as finished
      * @param boat The boat that has finished the race/home/cosc/student/wmu16
      */
-    public void setBoatFinished(Boat boat){
+    public void setBoatFinished(Yacht boat){
         this.finishingOrder.add(boat);
     }
 

src/main/java/seng302/models/Yacht.java

@@ -1,5 +1,7 @@
 package seng302.models;
 
+import javafx.scene.paint.Color;
+
 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
 
@@ -10,6 +12,10 @@ import java.text.SimpleDateFormat;
  *  also done outside Boat class because some old variables are not used anymore.
  */
 public class Yacht {
+    private Color colour;
+    private double velocity;
+    private Integer markLastPast;
+
     private String boatType;
     private Integer sourceID;
     private String hullID; //matches HullNum in the XML spec.
@@ -25,6 +31,29 @@ public class Yacht {
     private Long estimateTimeAtFinish;
     private String position;
 
+    /**
+     * Used in EventTest and RaceTest.
+     *
+     * @param boatName Create a yacht object with name.
+     */
+    public Yacht (String boatName) {
+        this.boatName = boatName;
+    }
+
+    /**
+     * Used in BoatGroupTest.
+     *
+     * @param boatName     The name of the team sailing the boat
+     * @param boatVelocity The speed of the boat in meters/second
+     * @param shortName    A shorter version of the teams name
+     */
+    public Yacht(String boatName, double boatVelocity, String shortName, int id) {
+        this.boatName = boatName;
+        this.velocity = boatVelocity;
+        this.shortName = shortName;
+        this.sourceID = id;
+    }
+
     public Yacht(String boatType, Integer sourceID, String hullID, String shortName, String boatName, String country) {
         this.boatType = boatType;
         this.sourceID = sourceID;
@@ -111,4 +140,28 @@ public class Yacht {
     public void setPosition(String position) {
         this.position = position;
     }
+
+    public Color getColour() {
+        return colour;
+    }
+
+    public void setColour(Color colour) {
+        this.colour = colour;
+    }
+
+    public double getVelocity() {
+        return velocity;
+    }
+
+    public void setVelocity(double velocity) {
+        this.velocity = velocity;
+    }
+
+    public Integer getMarkLastPast() {
+        return markLastPast;
+    }
+
+    public void setMarkLastPast(Integer markLastPast) {
+        this.markLastPast = markLastPast;
+    }
 }

src/main/java/seng302/models/parsers/StreamParser.java

@@ -32,7 +32,7 @@ public class StreamParser extends Thread{
      private String threadName;
      private Thread t;
      private static boolean raceStarted = false;
-     public static XMLParser xmlObject;
+     private static XMLParser xmlObject;
      private static boolean raceFinished = false;
      private static boolean streamStatus = false;
      private static long timeSinceStart = -1;
@@ -40,6 +40,7 @@ public class StreamParser extends Thread{
      private static Map<Long, Yacht> boatsPos = new TreeMap<>();
      private static double windDirection = 0;
      private static String currentTimeString;
+     private static boolean appRunning;
 
     /**
      * Used to initialise the thread name and stream parser object so a thread can be executed
@@ -56,6 +57,7 @@ public class StreamParser extends Thread{
      *
      */
     public void run(){
+        appRunning = true;
          try {
              System.out.println("[CLIENT] Start of stream");
              streamStatus = true;
@@ -63,7 +65,7 @@ public class StreamParser extends Thread{
              while (StreamReceiver.packetBuffer == null || StreamReceiver.packetBuffer.size() < 1) {
                  Thread.sleep(1);
              }
-             while (true){
+             while (appRunning){
                  StreamPacket packet = StreamReceiver.packetBuffer.peek();
                  //this code adds a delay to reading from the packetBuffer so
                  //out of order packets have time to order themselves in the queue
@@ -105,7 +107,7 @@ public class StreamParser extends Thread{
      * Looks at the type of the packet then sends it to the appropriate parser to extract the
      * specific data associated with that packet type
      *
-     * @param packet the packet to be looked at
+     * @param packet the packet to be looked at and processed
      */
      private static void parsePacket(StreamPacket packet) {
          try{
@@ -229,10 +231,16 @@ public class StreamParser extends Thread{
 //            boatStatus += "\nEstTimeAtFinish: " + bytesToLong(Arrays.copyOfRange(payload,37 + (i * 20),43+ (i * 20)));
 //            boatStatuses.add(boatStatus);
         }
-        int pos = 1;
-        for (Yacht yacht : boatsPos.values()) {
-            yacht.setPosition(String.valueOf(pos));
-            pos++;
+        if (isRaceStarted()) {
+            int pos = 1;
+            for (Yacht yacht : boatsPos.values()) {
+                yacht.setPosition(String.valueOf(pos));
+                pos++;
+            }
+        } else {
+            for (Yacht yacht : boatsPos.values()) {
+                yacht.setPosition("-");
+            }
         }
     }
 
@@ -370,6 +378,7 @@ public class StreamParser extends Thread{
         //type 1 is a racing yacht and type 3 is a mark, needed for updating positions of the mark and boat
         if (deviceType == 1 || deviceType == 3){
             BoatPositionPacket boatPacket = new BoatPositionPacket(boatId, timeValid, lat, lon, heading, groundSpeed);
+
             //add a new priority que to the boatPositions HashMap
             if (!boatPositions.containsKey(boatId)){
                 boatPositions.put(boatId, new PriorityBlockingQueue<BoatPositionPacket>(256, new Comparator<BoatPositionPacket>() {
@@ -379,6 +388,7 @@ public class StreamParser extends Thread{
                     }
                 }));
             }
+            //Adding the boatPacket to the priority que
             boatPositions.get(boatId).put(boatPacket);
         }
     }
@@ -543,5 +553,10 @@ public class StreamParser extends Thread{
     public static Map<Long, Yacht> getBoatsPos() {
         return boatsPos;
     }
+
+    public static void appClose(){
+        appRunning = false;
+        System.out.println("[CLIENT] Shutting down stream parser");
+    }
 }
 

src/main/java/seng302/models/parsers/StreamReceiver.java

@@ -21,6 +21,7 @@ public class StreamReceiver extends Thread {
     private Thread t;
     private String threadName;
     public static PriorityBlockingQueue<StreamPacket> packetBuffer;
+    private static boolean moreBytes;
 
     public StreamReceiver(String hostAddress, int hostPort, String threadName) {
         this.threadName = threadName;
@@ -69,7 +70,7 @@ public class StreamReceiver extends Thread {
 
         int sync1;
         int sync2;
-        boolean moreBytes = true;
+        moreBytes = true;
         while(moreBytes) {
             try {
                 crcBuffer = new ByteArrayOutputStream();
@@ -121,7 +122,6 @@ public class StreamReceiver extends Thread {
         return bytes;
     }
 
-
     private void skipBytes(long n) throws Exception{
         for (int i=0; i < n; i++){
             readByte();
@@ -147,7 +147,6 @@ public class StreamReceiver extends Thread {
         return partialLong;
     }
 
-
     public static void main(String[] args) {
 
         StreamReceiver sr = new StreamReceiver("csse-s302staff.canterbury.ac.nz", 4941,"TestThread1");
@@ -155,4 +154,9 @@ public class StreamReceiver extends Thread {
         sr.start();
 
     }
+
+    public static void noMoreBytes(){
+        moreBytes = false;
+        System.out.println("[CLIENT] Shutting down stream receiver");
+    }
 }

src/main/java/seng302/models/parsers/TeamsParser.java

@@ -1,64 +1,64 @@
-package seng302.models.parsers;
-
-import org.w3c.dom.*;
-import seng302.models.Boat;
-
-import java.util.ArrayList;
-import java.util.NoSuchElementException;
-
-public class TeamsParser extends FileParser {
-
-	private Document doc;
-
-	public TeamsParser(String path) {
-		super(path);
-		this.doc = this.parseFile();
-	}
-
-	/**
-	 * Create a boat instance by a given team node
-	 * @param node a boat node containing name, alias and velocity
-	 * @return an instance of Boat
-	 */
-	private Boat parseBoat(Node node) {
-		try {
-			if (node.getNodeType() == Node.ELEMENT_NODE) {
-				Element element = (Element) node;
-				String name = element.getElementsByTagName("name").item(0).getTextContent();
-				String alias = element.getElementsByTagName("alias").item(0).getTextContent();
-				double velocity = Double.valueOf(element.getElementsByTagName("velocity").item(0).getTextContent());
-				int id = Integer.valueOf(element.getElementsByTagName("id").item(0).getTextContent());
-				Boat boat = new Boat(name, velocity, alias, id);
-				return boat;
-			} else {
-				throw new NoSuchElementException("Cannot generate a boat by given node");
-			}
-		} catch (Exception e) {
-			e.printStackTrace();
-			return null;
-		}
-	}
-
-	/**
-	 * Create an arraylist of boats instance.
-	 * @return an arraylist of boats in teams file
-	 */
-	public ArrayList<Boat> getBoats() {
-		ArrayList<Boat> boats = new ArrayList<>();
-
-		try {
-			NodeList nodes = this.doc.getElementsByTagName("team");
-			for (int i = 0; i < nodes.getLength(); i++) {
-				Node node = nodes.item(i);
-				boats.add(parseBoat(node));
-			}
-			return boats;
-		} catch (Exception e) {
-			e.printStackTrace();
-			return null;
-		}
-	}
-
-
-}
-
+//package seng302.models.parsers;
+//
+//import org.w3c.dom.*;
+//import seng302.models.Yacht;
+//
+//import java.util.ArrayList;
+//import java.util.NoSuchElementException;
+//
+//public class TeamsParser extends FileParser {
+//
+//	private Document doc;
+//
+//	public TeamsParser(String path) {
+//		super(path);
+//		this.doc = this.parseFile();
+//	}
+//
+//	/**
+//	 * Create a boat instance by a given team node
+//	 * @param node a boat node containing name, alias and velocity
+//	 * @return an instance of Boat
+//	 */
+//	private Yacht parseBoat(Node node) {
+//		try {
+//			if (node.getNodeType() == Node.ELEMENT_NODE) {
+//				Element element = (Element) node;
+//				String name = element.getElementsByTagName("name").item(0).getTextContent();
+//				String alias = element.getElementsByTagName("alias").item(0).getTextContent();
+//				double velocity = Double.valueOf(element.getElementsByTagName("velocity").item(0).getTextContent());
+//				int id = Integer.valueOf(element.getElementsByTagName("id").item(0).getTextContent());
+//				Yacht boat = new Yacht(name, velocity, alias, id);
+//				return boat;
+//			} else {
+//				throw new NoSuchElementException("Cannot generate a boat by given node");
+//			}
+//		} catch (Exception e) {
+//			e.printStackTrace();
+//			return null;
+//		}
+//	}
+//
+//	/**
+//	 * Create an arraylist of boats instance.
+//	 * @return an arraylist of boats in teams file
+//	 */
+//	public ArrayList<Yacht> getBoats() {
+//		ArrayList<Yacht> boats = new ArrayList<>();
+//
+//		try {
+//			NodeList nodes = this.doc.getElementsByTagName("team");
+//			for (int i = 0; i < nodes.getLength(); i++) {
+//				Node node = nodes.item(i);
+//				boats.add(parseBoat(node));
+//			}
+//			return boats;
+//		} catch (Exception e) {
+//			e.printStackTrace();
+//			return null;
+//		}
+//	}
+//
+//
+//}
+//