Merge branch 'calculate-time' into 'master'

Calculate time



See merge request !10

src/main/java/seng302/App.java

@@ -15,7 +15,6 @@ public class App
 		for (Map<String, Object> team : teams) {
 			boatNames.add((String) team.get("team-name"));
 		}
-		System.out.println(boatNames.toString());
 
 		// Shuffle team names
 		long seed = System.nanoTime();

src/main/java/seng302/Boat.java

@@ -9,10 +9,15 @@ public class Boat
 {
 	// The name of the team, this is also the name of the boat
 	private String teamName = null;
+	private float velocity = 70; // please set this one to a reasonable num!!!!!, i set it just for testing ;)
 
 	public Boat(String teamName) {
 		this.teamName = teamName;
 	}
+	public Boat(String teamName, float boatVelocity) {
+		this.teamName = teamName;
+		this.velocity = boatVelocity;
+	}
 
 	/*
 		Returns the name of the team sailing the boat
@@ -29,4 +34,20 @@ public class Boat
 	public void setTeamName(String teamName){
 		this.teamName = teamName;
 	}
+
+	/**
+	 * Sets velocity of the boat
+	 * @param velocity The velocity of boat
+	 */
+	public void setVelocity(float velocity) {
+		this.velocity = velocity;
+	}
+
+	/**
+	 * Gets velocity of the boat
+	 * @return a float number of the boat velocity
+	 */
+	public float getVelocity() {
+		return this.velocity;
+	}
 }

src/main/java/seng302/Event.java

@@ -0,0 +1,77 @@
+package seng302;
+
+import java.text.SimpleDateFormat;
+import java.util.Date;
+
+/**
+ * Event class containing the time of specific event, related team/boat, and
+ * event location such as leg.
+ */
+public class Event {
+
+	private long time;
+	private Boat boat;
+	private Leg leg;
+
+	public Event(long eventTime, Boat eventBoat, Leg eventLeg) {
+		this.time = eventTime;
+		this.boat = eventBoat;
+		this.leg = eventLeg;
+	}
+
+	/**
+	 * Sets the time for the event
+	 * @param eventTime the time for event in millisecond
+	 */
+	public void setTime(long eventTime) {
+		this.time = eventTime;
+	}
+
+	/**
+	 * Gets the time for the event
+	 * @return the time for event in millisecond
+	 */
+	public long getTime() {
+		return this.time;
+	}
+
+	/**
+	 * Gets the time in a formatted string
+	 * @return the string of time
+	 */
+	public String getTimeString() {
+		return (new SimpleDateFormat("mm:ss:SSS")).format(new Date(time));
+	}
+
+	/**
+	 * Sets the involved boat
+	 * @param eventBoat the involved boat
+	 */
+	public void setBoat(Boat eventBoat) {
+		this.boat = eventBoat;
+	}
+
+	/**
+	 * Gets the involved boat
+	 * @return the boat involved in the event
+	 */
+	public Boat getBoat() {
+		return this.boat;
+	}
+
+	/**
+	 * Sets the involved location/leg
+	 * @param eventLeg the involved leg
+	 */
+	public void setLeg(Leg eventLeg) {
+		this.leg = eventLeg;
+	}
+
+	/**
+	 * Gets the involved location/leg
+	 * @return the leg involved in the event
+	 */
+	public Leg getLeg() {
+		return this.leg;
+	}
+}

src/main/java/seng302/Race.java

@@ -1,26 +1,41 @@
 package seng302;
 
-import java.util.ArrayList;
+import java.util.*;
-import java.util.Random;
-import java.util.Collections;
-import java.util.List;
 
 
 public class Race {
 	private ArrayList<Boat> boats;
 	private ArrayList<Leg> legs;
+	private PriorityQueue<Event> events;
 	private int numberOfBoats = 0;
+	private long startTime = 0;
+	private int timeScale = 1;
 
-	public Race(){
+	public Race() {
-		boats = new ArrayList<Boat>();
+		this.boats = new ArrayList<Boat>();
-		legs = new ArrayList<Leg>();
+		this.legs = new ArrayList<Leg>();
+		// create a priority queue within custom Comparator to order events
+		this.events = new PriorityQueue<Event>(new Comparator<Event>() {
+			@Override
+			public int compare(Event o1, Event o2) {
+				Long time1 = o1.getTime();
+				Long time2 = o2.getTime();
+				// order event asc. by time. if tie appears, then order team
+				// name alphabetically.
+				if (time1 != time2) {
+					return time1.compareTo(time2);
+				} else {
+					return o1.getBoat().getTeamName().compareTo(o2.getBoat().getTeamName());
+				}
+			}
+		});
 	}
 
 	/*
 		Add a boat to the race
 		@param boat, the boat to add
 	*/
-	public void addBoat(Boat boat){
+	public void addBoat(Boat boat) {
 		boats.add(boat);
 		numberOfBoats += 1;
 	}
@@ -30,7 +45,7 @@ public class Race {
 
 		@returns a list of boats
 	*/
-	public Boat[] getShuffledBoats(){
+	public Boat[] getShuffledBoats() {
 		// Shuffle the list of boats
 		long seed = System.nanoTime();
 		Collections.shuffle(this.boats, new Random(seed));
@@ -44,7 +59,7 @@ public class Race {
 
 		@returns a list of boats
 	*/
-	public Boat[] getFinishedBoats(){
+	public Boat[] getFinishedBoats() {
 		return getShuffledBoats();
 	}
 
@@ -53,7 +68,7 @@ public class Race {
 
 		@returns the number of boats in the race
 	*/
-	public int getNumberOfBoats(){
+	public int getNumberOfBoats() {
 		return numberOfBoats;
 	}
 
@@ -62,28 +77,28 @@ public class Race {
 
 		@returns a list of the boats competing in the race
 	*/
-	public Boat[] getBoats(){
+	public Boat[] getBoats() {
 		return boats.toArray(new Boat[boats.size()]);
 	}
 
 	/*
 		Prints the order in which the boats finished
 	*/
-	public void displayFinishingOrder(){
+	public void displayFinishingOrder() {
 		int numberOfBoats = this.getNumberOfBoats();
 		Boat[] boats = this.getFinishedBoats();
 
 		System.out.println("--- Finishing Order ---");
 
 		for (int i = 0; i < numberOfBoats; i++) {
-			System.out.println("#" + Integer.toString(i+1) + " - " + boats[i].getTeamName());
+			System.out.println("#" + Integer.toString(i + 1) + " - " + boats[i].getTeamName());
 		}
 	}
 
 	/*
 		Prints the list of boats competing in the race
 	*/
-	private void displayStartingBoats(){
+	private void displayStartingBoats() {
 		int numberOfBoats = this.getNumberOfBoats();
 		Boat[] boats = this.getBoats();
 
@@ -99,23 +114,86 @@ public class Race {
 
 		@param leg, the leg to add to the race
 	*/
-	public void addLeg(Leg leg){
+	public void addLeg(Leg leg) {
 		this.legs.add(leg);
 	}
 
+	/**
+	 * Gets legs array
+	 *
+	 * @return an array of legs
+	 */
+	public ArrayList<Leg> getLegs() {
+		return this.legs;
+	}
+
+	/**
+	 * Temporary method used to generated all the events.
+	 */
+	private void generateEvents() {
+
+		//calculate the time for every boat passes each leg, and create an event
+		for (Boat boat : this.boats) {
+			long totalDistance = 0;
+			for (Leg leg : this.legs) {
+				totalDistance += leg.getDistance();
+				long time = (long) (1000 * totalDistance / (boat.getVelocity() * this.timeScale));
+				Event event = new Event(time, boat, leg);
+				events.add(event);
+			}
+		}
+	}
+
+	/**
+	 * Note: this function is useless so far
+	 * Calculates how far a boat has travelled in meter
+	 *
+	 * @param velocity the velocity of boat
+	 * @return a float number of distance the boat has been travelled
+	 */
+	public float getDistanceTravelled(long velocity) {
+		long timeDiff = System.currentTimeMillis() - this.startTime;
+		long timeElapse = timeDiff / 1000 * this.timeScale;
+		return timeElapse * velocity;
+	}
+
+	/**
+	 * Micheal, here is a demo function shows you how to iterate all events
+	 */
+	public void iterateEvents() {
+		// iterates all events. ends when no event in events.
+		while (!events.isEmpty()) {
+			Event peekEvent = events.peek();
+			long currentTime = System.currentTimeMillis() - this.startTime;
+			if (currentTime > peekEvent.getTime()) {
+				// pull out the event
+				Event nextEvent = events.poll();
+				// I just simply print it out for testing
+				System.out.println(nextEvent.getTimeString() + ", " +
+						nextEvent.getBoat().getTeamName() + " passed " +
+						nextEvent.getLeg().getMarkerLabel());
+			}
+		}
+	}
+
 	/*
 		Start the race and print each marker with the order
 		in which the boats passed that marker
 	*/
-	public void startRace(){
+	public void startRace() {
-		for (Leg leg : this.legs.toArray(new Leg[legs.size()])){
+		// record start time.
+		generateEvents();
+		this.startTime = System.currentTimeMillis();
+		iterateEvents();
+
+		for (Leg leg : this.legs) {
 			Boat[] boats = this.getShuffledBoats();
 
 			System.out.println("--- " + leg.getMarkerLabel() + " ---");
 
 			// Print the order in which the boats passed the marker
 			for (int i = 0; i < this.getNumberOfBoats(); i++) {
-				System.out.println("#" + Integer.toString(i+1) + " - " + boats[i].getTeamName());
+				System.out.println("#" + Integer.toString(i + 1) + " - " + boats[i].getTeamName());
 			}
 
 			System.out.println("");

src/test/java/seng302/EventTest.java

@@ -0,0 +1,21 @@
+package seng302;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import static org.junit.Assert.*;
+
+/**
+ * Test for Event class
+ * Created by Haoming on 7/03/17.
+ */
+public class EventTest {
+
+	@Test
+	public void getTimeString() throws Exception {
+		Leg leg = new Leg(035, 100, "Start");
+		Boat boat = new Boat("testBoat");
+		Event event = new Event(1231242, boat, leg);
+		assertEquals("20:31:242", event.getTimeString());
+	}
+}