michael/Party-Parrots-At-Sea
1
0
Fork 0
mirror of https://github.com/michaelrausch/Party-Parrots-At-Sea.git synced 2026-05-09 14:28:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reformatted doctring and import statements

Browse Source
This commit is contained in:
Haoming Yin
2017-03-08 14:45:06 +13:00
parent 245fbc75c2
commit b0cd7c8c08
17 changed files with 773 additions and 722 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/examples/config.json
+25 -7
View File
@@ -1,13 +1,31 @@
{ {
"race-name": "AC35", "race-name": "AC35",
"time-scale": 1.0, "time-scale": 1.0,
"race-size": 4, "race-size": 6,
"teams": [ "teams": [
{"team-name": "Oracle Team USA", "velocity": 20.9}, {
{"team-name": "Artemis Racing", "velocity": 18.3}, "team-name": "Oracle Team USA",
{"team-name": "Emirates Team New Zealand", "velocity": 21.5}, "velocity": 20.9
{"team-name": "Groupama Team France","velocity": 19.9}, },
{"team-name": "Land Rover BAR", "velocity": 17.6}, {
{"team-name": "SoftBank Team Japan", "velocity": 16.6} "team-name": "Artemis Racing",
"velocity": 18.3
},
{
"team-name": "Emirates Team New Zealand",
"velocity": 21.5
},
{
"team-name": "Groupama Team France",
"velocity": 19.9
},
{
"team-name": "Land Rover BAR",
"velocity": 17.6
},
{
"team-name": "SoftBank Team Japan",
"velocity": 16.6
}
] ]
} }
pom.xml
+3 -2
View File
@@ -1,4 +1,4 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" <project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<groupId>seng302</groupId> <groupId>seng302</groupId>
@@ -40,7 +40,8 @@
<version>2.4.3</version> <version>2.4.3</version>
<configuration> <configuration>
<transformers> <transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"> <transformer
implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<manifestEntries> <manifestEntries>
<Main-Class>seng302.App</Main-Class> <Main-Class>seng302.App</Main-Class>
<X-Compile-Source-JDK>${maven.compiler.source}</X-Compile-Source-JDK> <X-Compile-Source-JDK>${maven.compiler.source}</X-Compile-Source-JDK>
src/main/java/seng302/App.java
+64 -65
View File
@@ -1,87 +1,86 @@
package seng302; package seng302;
import java.util.*;
import java.lang.reflect.Array; import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Map;
import java.util.Random;
public class App public class App {
{ /**
/** * Builds a race object for the AC35 course
* Builds a race object for the AC35 course */
*/ public static Race createRace() throws Exception {
public static Race createRace() throws Exception{ Race race = new Race();
Race race = new Race();
// Read team names from file // Read team names from file
FileParser fp = new FileParser("doc/examples/config.json"); FileParser fp = new FileParser("doc/examples/config.json");
ArrayList<String> boatNames = new ArrayList<>(); ArrayList<String> boatNames = new ArrayList<>();
ArrayList<Map<String, Object>> teams = fp.getTeams(); ArrayList<Map<String, Object>> teams = fp.getTeams();
//get race size //get race size
int numberOfBoats = (int) fp.getRaceSize(); int numberOfBoats = (int) fp.getRaceSize();
//get time scale //get time scale
double timeScale = fp.getTimeScale(); double timeScale = fp.getTimeScale();
race.setTimeScale(timeScale); race.setTimeScale(timeScale);
for (Map<String, Object> team : teams) { for (Map<String, Object> team : teams) {
boatNames.add((String) team.get("team-name")); boatNames.add((String) team.get("team-name"));
} }
// Shuffle team names // Shuffle team names
long seed = System.nanoTime(); long seed = System.nanoTime();
Collections.shuffle(boatNames, new Random(seed)); Collections.shuffle(boatNames, new Random(seed));
if (numberOfBoats > Array.getLength(boatNames.toArray())){ if (numberOfBoats > Array.getLength(boatNames.toArray())) {
return null; return null;
} }
for (int i = 0; i < numberOfBoats; i++) { for (int i = 0; i < numberOfBoats; i++) {
race.addBoat(new Boat(boatNames.get(i), (Double)(teams.get(i).get("velocity")))); race.addBoat(new Boat(boatNames.get(i), (Double) (teams.get(i).get("velocity"))));
} }
race.addLeg(new Leg(35, 100, "Start")); race.addLeg(new Leg(35, 100, "Start"));
race.addLeg(new Leg(10, 300, "Marker 1")); race.addLeg(new Leg(10, 300, "Marker 1"));
race.addLeg(new Leg(350, 400, "Leeward Gate")); race.addLeg(new Leg(350, 400, "Leeward Gate"));
race.addLeg(new Leg(10, 400, "Windward Gate")); race.addLeg(new Leg(10, 400, "Windward Gate"));
Leg finishingLeg = new Leg(10, 400, "Leeward Gate"); Leg finishingLeg = new Leg(10, 400, "Leeward Gate");
finishingLeg.setFinishingLeg(true); finishingLeg.setFinishingLeg(true);
race.addLeg(finishingLeg); race.addLeg(finishingLeg);
return race; return race;
} }
public static void main( String[] args ) public static void main(String[] args) {
{ Race race = null;
Race race = null;
try{ try {
race = createRace(); race = createRace();
} } catch (Exception e) {
catch (Exception e){ System.out.println(e);
System.out.println(e); }
}
// If race was created // If race was created
if (race != null){ if (race != null) {
race.displayStartingBoats(); race.displayStartingBoats();
System.out.println("\n\n"); System.out.println("\n\n");
System.out.println("######################"); System.out.println("######################");
System.out.println("# Live Race Updates "); System.out.println("# Live Race Updates ");
System.out.println("######################"); System.out.println("######################");
race.startRace(); race.startRace();
System.out.println("\n\n"); System.out.println("\n\n");
System.out.println("######################"); System.out.println("######################");
System.out.println("# Race Results "); System.out.println("# Race Results ");
System.out.println("######################"); System.out.println("######################");
race.showRaceMarkerResults(); race.showRaceMarkerResults();
race.displayFinishingOrder(); race.displayFinishingOrder();
} } else {
else{ System.out.println("There was an error creating the race.");
System.out.println("There was an error creating the race."); }
}
} }
} }
src/main/java/seng302/Boat.java
+50 -46
View File
@@ -1,56 +1,60 @@
package seng302; package seng302;
/**
* 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
*/
public class Boat
{
private String teamName; // The name of the team, this is also the name of the boat public class Boat {
private double velocity; // In meters/second
public Boat(String teamName) { private String teamName; // The name of the team, this is also the name of the boat
this.teamName = teamName; private double velocity; // In meters/second
this.velocity = 10; // Default velocity
}
public Boat(String teamName, double boatVelocity) { public Boat(String teamName) {
this.teamName = teamName; this.teamName = teamName;
this.velocity = boatVelocity; this.velocity = 10; // Default velocity
} }
/** /**
* Returns the name of the team sailing the boat * Represents a boat in the race.
* @return The name of the team *
*/ * @param teamName The name of the team sailing the boat
public String getTeamName(){ * @param boatVelocity The speed of the boat in meters/second
return this.teamName; */
} public Boat(String teamName, double boatVelocity) {
this.teamName = teamName;
this.velocity = boatVelocity;
}
/** /**
* Sets the name of the team sailing the boat * Returns the name of the team sailing the boat
* @param teamName The name of the team *
*/ * @return The name of the team
public void setTeamName(String teamName){ */
this.teamName = teamName; public String getTeamName() {
} return this.teamName;
}
/** /**
* Sets velocity of the boat * Sets the name of the team sailing the boat
* @param velocity The velocity of boat *
*/ * @param teamName The name of the team
public void setVelocity(float velocity) { */
this.velocity = velocity; public void setTeamName(String teamName) {
} this.teamName = teamName;
}
/** /**
* Gets velocity of the boat * Gets velocity of the boat
* @return a float number of the boat velocity *
*/ * @return a float number of the boat velocity
public double getVelocity() { */
return this.velocity; public double getVelocity() {
} return this.velocity;
}
/**
* Sets velocity of the boat
*
* @param velocity The velocity of boat
*/
public void setVelocity(float velocity) {
this.velocity = velocity;
}
} }
src/main/java/seng302/Event.java
+105 -97
View File
@@ -3,117 +3,125 @@ package seng302;
import java.text.SimpleDateFormat; import java.text.SimpleDateFormat;
import java.util.Date; import java.util.Date;
/**
* Event class containing the time of specific event, related team/boat, and
* event location such as leg.
*
* @param eventTime, what time the event happens
* @param eventBoat, the boat that the event belongs to
* @param eventLeg, the leg the event happens on
*/
public class Event { public class Event {
private long time; private long time;
private Boat boat; private Boat boat;
private Leg leg; private Leg leg;
private boolean isFinishingEvent = false; private boolean isFinishingEvent = false;
public Event(long eventTime, Boat eventBoat, Leg eventLeg) { /**
this.time = eventTime; * Event class containing the time of specific event, related team/boat, and
this.boat = eventBoat; * event location such as leg.
this.leg = eventLeg; *
} * @param eventTime, what time the event happens
* @param eventBoat, the boat that the event belongs to
* @param eventLeg, the leg the event happens on
*/
public Event(long eventTime, Boat eventBoat, Leg eventLeg) {
this.time = eventTime;
this.boat = eventBoat;
this.leg = eventLeg;
}
public Event(long eventTime, Boat eventBoat, Leg eventLeg, boolean isFinishingEvent) { public Event(long eventTime, Boat eventBoat, Leg eventLeg, boolean isFinishingEvent) {
this.time = eventTime; this.time = eventTime;
this.boat = eventBoat; this.boat = eventBoat;
this.leg = eventLeg; this.leg = eventLeg;
this.isFinishingEvent = isFinishingEvent; this.isFinishingEvent = isFinishingEvent;
} }
/** /**
* Sets the time for the event * Gets the time for the event
* @param eventTime the time for event in millisecond *
*/ * @return the time for event in millisecond
public void setTime(long eventTime) { */
this.time = eventTime; public long getTime() {
} return this.time;
}
/** /**
* Gets the time for the event * Sets the time for the event
* @return the time for event in millisecond *
*/ * @param eventTime the time for event in millisecond
public long getTime() { */
return this.time; public void setTime(long eventTime) {
} this.time = eventTime;
}
/** /**
* Gets the time in a formatted string * Gets the time in a formatted string
* @return the string of time *
*/ * @return the string of time
public String getTimeString() { */
return (new SimpleDateFormat("mm:ss:SSS")).format(new Date(time)); public String getTimeString() {
} return (new SimpleDateFormat("mm:ss:SSS")).format(new Date(time));
}
/** /**
* Sets the involved boat * Gets the involved boat
* @param eventBoat the involved boat *
*/ * @return the boat involved in the event
public void setBoat(Boat eventBoat) { */
this.boat = eventBoat; public Boat getBoat() {
} return this.boat;
}
/** /**
* Gets the involved boat * Sets the involved boat
* @return the boat involved in the event *
*/ * @param eventBoat the involved boat
public Boat getBoat() { */
return this.boat; public void setBoat(Boat eventBoat) {
} this.boat = eventBoat;
}
/** /**
* Sets the involved location/leg * Gets the involved location/leg
* @param eventLeg the involved leg *
*/ * @return the leg involved in the event
public void setLeg(Leg eventLeg) { */
this.leg = eventLeg; public Leg getLeg() {
} return this.leg;
}
/** /**
* Gets the involved location/leg * Sets the involved location/leg
* @return the leg involved in the event *
*/ * @param eventLeg the involved leg
public Leg getLeg() { */
return this.leg; public void setLeg(Leg eventLeg) {
} this.leg = eventLeg;
}
/** /**
* Call when the boat reaches the marker, this will tell the marker the order * Call when the boat reaches the marker, this will tell the marker the order
* in which boats pass it * in which boats pass it
*/ */
public void addBoatToMarker(){ public void addBoatToMarker() {
this.leg.addBoatToMarker(boat); this.leg.addBoatToMarker(boat);
} }
/** /**
* Returns true if this event is the boat finishing the race * Returns true if this event is the boat finishing the race
* */
*/ public boolean getIsFinishingEvent() {
public boolean getIsFinishingEvent(){ return this.isFinishingEvent;
return this.isFinishingEvent; }
}
/** /**
* Get a string that contains the timestamp and course information for this event * Get a string that contains the timestamp and course information for this event
* @return A string that contains the timestamp and course information for this event *
*/ * @return A string that contains the timestamp and course information for this event
public String getEventString(){ */
String currentHeading = Integer.toString(this.getLeg().getHeading()); public String getEventString() {
String currentHeading = Integer.toString(this.getLeg().getHeading());
if (this.isFinishingEvent){ if (this.isFinishingEvent) {
return (this.getTimeString() + ", " + this.getBoat().getTeamName() + " finished the race"); return (this.getTimeString() + ", " + this.getBoat().getTeamName() + " finished the race");
} }
return (this.getTimeString() + ", " + this.getBoat().getTeamName() + " passed " + this.getLeg().getMarkerLabel() + " going heading " + currentHeading + "°"); return (this.getTimeString() + ", " + this.getBoat().getTeamName() + " passed " + this.getLeg().getMarkerLabel() + " going heading " + currentHeading + "°");
} }
} }
src/main/java/seng302/FileParser.java
+105 -98
View File
@@ -4,9 +4,9 @@ import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser; import org.json.simple.parser.JSONParser;
import org.json.simple.parser.ParseException; import org.json.simple.parser.ParseException;
import java.io.FileNotFoundException;
import java.io.FileReader; import java.io.FileReader;
import java.io.IOException; import java.io.IOException;
import java.io.FileNotFoundException;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Map; import java.util.Map;
@@ -18,108 +18,115 @@ import java.util.Map;
public class FileParser { public class FileParser {
private String filePath; private String filePath;
private JSONObject content; private JSONObject content;
/** used to construct an instance of file parser
*
* @param filePath a string like path to show location of desired file to
* be parsed
*/
public FileParser(String filePath) throws Exception {
this.filePath = filePath;
this.readFile();
}
/** /**
* Reads content from a given file, and return the content as JSONObject. * used to construct an instance of file parser
* Throws FileNotFoundException, if the given file cannot be found. *
*/ * @param filePath a string like path to show location of desired file to
private void readFile() throws FileNotFoundException{ * be parsed
JSONParser parser = new JSONParser(); */
try { public FileParser(String filePath) throws Exception {
this.content = (JSONObject) parser.parse(new FileReader(filePath)); this.filePath = filePath;
this.readFile();
}
} catch (FileNotFoundException e) { /**
throw e; * Reads content from a given file, and return the content as JSONObject.
} catch (IOException e) { * Throws FileNotFoundException, if the given file cannot be found.
e.printStackTrace(); */
} catch (ParseException e) { private void readFile() throws FileNotFoundException {
e.printStackTrace(); JSONParser parser = new JSONParser();
} try {
} this.content = (JSONObject) parser.parse(new FileReader(filePath));
/** } catch (FileNotFoundException e) {
* Gets time scale setting parameter. throw e;
* @return long time scale. -1 if parameter is invalid (eg. scale is } catch (IOException e) {
* negative number, or containing non numeric character) or cannot be found. e.printStackTrace();
*/ } catch (ParseException e) {
@SuppressWarnings("unchecked") e.printStackTrace();
public double getTimeScale() { }
try { }
double timeScale = (double) this.content.get("time-scale");
return timeScale >= 0 ? timeScale : -1;
} catch (Exception e) {
e.printStackTrace();
return 1;
}
}
/** /**
* Gets race name in the setting file. * Gets time scale setting parameter.
* @return a string of race name. null if race name is invalid or cannot *
* be found. * @return long time scale. -1 if parameter is invalid (eg. scale is
*/ * negative number, or containing non numeric character) or cannot be found.
@SuppressWarnings("unchecked") */
public String getRaceName() { @SuppressWarnings("unchecked")
try { public double getTimeScale() {
return (String) this.content.get("race-name"); try {
} catch (Exception e) { double timeScale = (double) this.content.get("time-scale");
return null; return timeScale >= 0 ? timeScale : -1;
} } catch (Exception e) {
} e.printStackTrace();
return 1;
}
}
/** /**
* Gets an array of teams who participate the race. * Gets race name in the setting file.
* @return an ArrayList containing strings of team names. null if teams *
* setting is invalid or there is no team. * @return a string of race name. null if race name is invalid or cannot
*/ * be found.
@SuppressWarnings("unchecked") */
public ArrayList<Map<String, Object>> getTeams() { @SuppressWarnings("unchecked")
try { public String getRaceName() {
return (ArrayList<Map<String, Object>>) this.content.get("teams"); try {
} catch (Exception e) { return (String) this.content.get("race-name");
return null; } catch (Exception e) {
} return null;
} }
}
/** /**
* Gets the total number of teams. * Gets an array of teams who participate the race.
* @return the number of teams. 0 if no teams or anything goes wrong. *
*/ * @return an ArrayList containing strings of team names. null if teams
@SuppressWarnings("unchecked") * setting is invalid or there is no team.
public long getTotalNumberOfTeams() { */
ArrayList<Map<String, Object>> teams = getTeams(); @SuppressWarnings("unchecked")
try { public ArrayList<Map<String, Object>> getTeams() {
return teams.size(); try {
} catch (Exception e) { return (ArrayList<Map<String, Object>>) this.content.get("teams");
return 0; } catch (Exception e) {
} return null;
} }
}
/** /**
* Gets the number of boats that would compete during a race. Returns the * Gets the total number of teams.
* total number of race size if parameter is invalid or cannot be found. *
* @return an int of the race size. * @return the number of teams. 0 if no teams or anything goes wrong.
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public long getRaceSize() { public long getTotalNumberOfTeams() {
long totalTeams = this.getTotalNumberOfTeams(); ArrayList<Map<String, Object>> teams = getTeams();
try { try {
long raceSize = (long) this.content.get("race-size"); return teams.size();
return raceSize >= 0 && raceSize <= totalTeams? raceSize : totalTeams; } catch (Exception e) {
} catch (Exception e) { return 0;
e.printStackTrace(); }
return totalTeams; }
}
} /**
* Gets the number of boats that would compete during a race. Returns the
* total number of race size if parameter is invalid or cannot be found.
*
* @return an int of the race size.
*/
@SuppressWarnings("unchecked")
public long getRaceSize() {
long totalTeams = this.getTotalNumberOfTeams();
try {
long raceSize = (long) this.content.get("race-size");
return raceSize >= 0 && raceSize <= totalTeams ? raceSize : totalTeams;
} catch (Exception e) {
e.printStackTrace();
return totalTeams;
}
}
} }
src/main/java/seng302/Leg.java
+92 -92
View File
@@ -1,108 +1,108 @@
package seng302; package seng302;
public class Leg { public class Leg {
private int heading; private int heading;
private int distance; private int distance;
private boolean isFinishingLeg; private boolean isFinishingLeg;
private Marker startingMarker; private Marker startingMarker;
/* /**
Create a new leg * Create a new leg
*
* @param heading, the magnetic heading of this leg
* @param distance, the total distance of this leg in meters
* @param marker, the marker this leg starts on
*/
public Leg(int heading, int distance, Marker marker) {
this.heading = heading;
this.distance = distance;
this.startingMarker = marker;
this.isFinishingLeg = false;
}
@param heading, the magnetic heading of this leg /**
@param distance, the total distance of this leg in meters * Create a new leg
@param marker, the marker this leg starts on *
*/ * @param heading, the magnetic heading of this leg
public Leg(int heading, int distance, Marker marker){ * @param distance, the total distance of this leg in meters
this.heading = heading; * @param markerName, the name of the marker this leg starts on
this.distance = distance; */
this.startingMarker = marker; public Leg(int heading, int distance, String markerName) {
this.isFinishingLeg = false; this.heading = heading;
} this.distance = distance;
this.startingMarker = new Marker(markerName);
this.isFinishingLeg = false;
}
/* /**
Create a new leg * Get the heading of this leg
*/
public int getHeading() {
return this.heading;
}
@param heading, the magnetic heading of this leg /**
@param distance, the total distance of this leg in meters * Set the heading for this leg
@param markerName, the name of the marker this leg starts on */
*/ public void setHeading(int heading) {
public Leg(int heading, int distance, String markerName){ this.heading = heading;
this.heading = heading; }
this.distance = distance;
this.startingMarker = new Marker(markerName);
this.isFinishingLeg = false;
}
/* /**
Set the heading for this leg * Get the total distance of this leg in meters
*/ */
public void setHeading(int heading){ public int getDistance() {
this.heading = heading; return this.distance;
} }
/* /**
Get the heading of this leg * Set the distance of this leg in meters
*/ */
public int getHeading(){ public void setDistance(int distance) {
return this.heading; this.distance = distance;
} }
/* /**
Set the distance of this leg in meters * Returns the marker this leg started on
*/ */
public void setDistance(int distance){ public Marker getMarker() {
this.distance = distance; return this.startingMarker;
} }
/* /**
Get the total distance of this leg in meters * Set the marker this leg starts on
*/ */
public int getDistance(){ public void setMarker(Marker marker) {
return this.distance; this.startingMarker = marker;
} }
/* /**
Set the marker this leg starts on * Returns the name of the marker this leg started on
*/ */
public void setMarker(Marker marker){ public String getMarkerLabel() {
this.startingMarker = marker; return this.startingMarker.getName();
} }
/* /**
Returns the marker this leg started on * Tell the marker that the boat has passed it
*/ */
public Marker getMarker(){ public void addBoatToMarker(Boat boat) {
return this.startingMarker; this.startingMarker.addBoat(boat);
} }
/* /**
Returns the name of the marker this leg started on * Specify whether or not the race finishes on this leg
*/ *
public String getMarkerLabel(){ * @param isFinishingLeg whether or not the race finishes on this leg
return this.startingMarker.getName(); */
} public void setFinishingLeg(boolean isFinishingLeg) {
this.isFinishingLeg = isFinishingLeg;
}
/* /**
Tell the marker that the boat has passed it * @returns true if this the race finishes after this leg
*/ */
public void addBoatToMarker(Boat boat){ public boolean getIsFinishingLeg() {
this.startingMarker.addBoat(boat); return this.isFinishingLeg;
} }
/*
Specify whether or not the race finishes on this leg
@param isFinishingLeg whether or not the race finishes on this leg
*/
public void setFinishingLeg(boolean isFinishingLeg){
this.isFinishingLeg = isFinishingLeg;
}
/*
@returns true if this the race finishes after this leg
*/
public boolean getIsFinishingLeg(){
return this.isFinishingLeg;
}
} }
src/main/java/seng302/Marker.java
+19 -19
View File
@@ -2,28 +2,28 @@ package seng302;
import java.util.ArrayList; import java.util.ArrayList;
class Marker{ class Marker {
private String name; private String name;
private ArrayList<Boat> boatOrder; private ArrayList<Boat> boatOrder;
public Marker(String name){ public Marker(String name) {
this.name = name; this.name = name;
this.boatOrder = new ArrayList<Boat>(); this.boatOrder = new ArrayList<Boat>();
} }
public void setName(String name){ public String getName() {
this.name = name; return this.name;
} }
public String getName(){ public void setName(String name) {
return this.name; this.name = name;
} }
public void addBoat(Boat boat){ public void addBoat(Boat boat) {
this.boatOrder.add(boat); this.boatOrder.add(boat);
} }
public Boat[] getBoats(){ public Boat[] getBoats() {
return this.boatOrder.toArray(new Boat[this.boatOrder.size()]); return this.boatOrder.toArray(new Boat[this.boatOrder.size()]);
} }
} }
src/main/java/seng302/Race.java
+207 -207
View File
@@ -1,246 +1,246 @@
package seng302; package seng302;
import java.util.*;
import java.lang.reflect.Array; import java.lang.reflect.Array;
import java.util.concurrent.TimeUnit; import java.util.*;
public class Race { public class Race {
private ArrayList<Boat> boats; // The boats in the race private ArrayList<Boat> boats; // The boats in the race
private ArrayList<Leg> legs; // The legs in the race private ArrayList<Leg> legs; // The legs in the race
private ArrayList<Boat> finishingOrder; // The order in which the boats finish the race private ArrayList<Boat> finishingOrder; // The order in which the boats finish the race
private PriorityQueue<Event> events; // The events that occur in the race private PriorityQueue<Event> events; // The events that occur in the race
private int numberOfBoats = 0; private int numberOfBoats = 0;
private long startTime = 0; private long startTime = 0;
private double timeScale = 1; private double timeScale = 1;
public Race() { public Race() {
this.boats = new ArrayList<Boat>(); this.boats = new ArrayList<Boat>();
this.legs = new ArrayList<Leg>(); this.legs = new ArrayList<Leg>();
this.finishingOrder = new ArrayList<Boat>(); this.finishingOrder = new ArrayList<Boat>();
// create a priority queue with a custom Comparator to order events // create a priority queue with a custom Comparator to order events
this.events = new PriorityQueue<Event>(new Comparator<Event>() { this.events = new PriorityQueue<Event>(new Comparator<Event>() {
@Override @Override
public int compare(Event o1, Event o2) { public int compare(Event o1, Event o2) {
Long time1 = o1.getTime(); Long time1 = o1.getTime();
Long time2 = o2.getTime(); Long time2 = o2.getTime();
// order event asc. by time. if tie appears, then order team // order event asc. by time. if tie appears, then order team
// name alphabetically. // name alphabetically.
if (time1 != time2) { if (time1 != time2) {
return time1.compareTo(time2); return time1.compareTo(time2);
} else { } else {
return o1.getBoat().getTeamName().compareTo(o2.getBoat().getTeamName()); return o1.getBoat().getTeamName().compareTo(o2.getBoat().getTeamName());
} }
} }
}); });
} }
/* /**
Add a boat to the race * Add a boat to the race
@param boat, the boat to add *
*/ * @param boat, the boat to add
public void addBoat(Boat boat) { */
boats.add(boat); public void addBoat(Boat boat) {
numberOfBoats += 1; boats.add(boat);
} numberOfBoats += 1;
}
/* /**
Returns a list of boats in a random order * Returns a list of boats in a random order
*
* @returns a list of boats
*/
public Boat[] getShuffledBoats() {
// Shuffle the list of boats
long seed = System.nanoTime();
Collections.shuffle(this.boats, new Random(seed));
@returns a list of boats return boats.toArray(new Boat[boats.size()]);
*/ }
public Boat[] getShuffledBoats() {
// Shuffle the list of boats
long seed = System.nanoTime();
Collections.shuffle(this.boats, new Random(seed));
return boats.toArray(new Boat[boats.size()]); /**
} * Returns a list of boats in the order that they
* finished the race (position 0 is first place)
*
* @returns a list of boats
*/
public Boat[] getFinishedBoats() {
return this.finishingOrder.toArray(new Boat[this.finishingOrder.size()]);
}
/* /**
Returns a list of boats in the order that they * Returns the number of boats in the race
finished the race (position 0 is first place) *
* @returns the number of boats in the race
*/
public int getNumberOfBoats() {
return numberOfBoats;
}
@returns a list of boats /**
*/ * Returns a list of boats in the race
public Boat[] getFinishedBoats() { *
return this.finishingOrder.toArray(new Boat[this.finishingOrder.size()]); * @returns a list of the boats competing in the race
} */
public Boat[] getBoats() {
return boats.toArray(new Boat[boats.size()]);
}
/* /**
Returns the number of boats in the race * Prints the order in which the boats finished
*/
public void displayFinishingOrder() {
int numberOfBoats = this.getNumberOfBoats();
Boat[] boats = this.getFinishedBoats();
@returns the number of boats in the race System.out.println("\n\n");
*/ System.out.println("--- Finishing Order ---");
public int getNumberOfBoats() {
return numberOfBoats;
}
/* for (int i = 0; i < Array.getLength(boats); i++) {
Returns a list of boats in the race System.out.println("#" + Integer.toString(i + 1) + " - " + boats[i].getTeamName());
}
}
@returns a list of the boats competing in the race /**
*/ * Prints the list of boats competing in the race
public Boat[] getBoats() { */
return boats.toArray(new Boat[boats.size()]); public void displayStartingBoats() {
} int numberOfBoats = this.getNumberOfBoats();
Boat[] boats = this.getBoats();
/* System.out.println("######################");
Prints the order in which the boats finished System.out.println("# Competing Boats ");
*/ System.out.println("######################");
public void displayFinishingOrder() {
int numberOfBoats = this.getNumberOfBoats();
Boat[] boats = this.getFinishedBoats();
System.out.println("\n\n"); for (int i = 0; i < numberOfBoats; i++) {
System.out.println("--- Finishing Order ---"); String velocityKnots = String.format("%1.2f", boats[i].getVelocity() * 1.943844492);
for (int i = 0; i < Array.getLength(boats); i++) { System.out.println(boats[i].getTeamName() + " Velocity: " + velocityKnots);
System.out.println("#" + Integer.toString(i + 1) + " - " + boats[i].getTeamName()); }
} }
}
/* /**
Prints the list of boats competing in the race * Adds a leg to the race
*/ *
public void displayStartingBoats() { * @param leg, the leg to add to the race
int numberOfBoats = this.getNumberOfBoats(); */
Boat[] boats = this.getBoats(); public void addLeg(Leg leg) {
this.legs.add(leg);
}
System.out.println("######################"); /**
System.out.println("# Competing Boats "); * Gets legs array
System.out.println("######################"); *
* @return an array of legs
*/
public ArrayList<Leg> getLegs() {
return this.legs;
}
for (int i = 0; i < numberOfBoats; i++) { /**
String velocityKnots = String.format("%1.2f", boats[i].getVelocity() * 1.943844492); * Sets time scale
*
* @param timeScale
*/
public void setTimeScale(double timeScale) {
this.timeScale = timeScale;
}
System.out.println(boats[i].getTeamName() + " Velocity: " + velocityKnots); /**
} * Temporary method used to generated all the events.
} */
private void generateEvents() {
/* //calculate the time for every boat passes each leg, and create an event
Adds a leg to the race for (Boat boat : this.boats) {
long totalDistance = 0;
for (Leg leg : this.legs) {
long time = (long) (1000 * totalDistance / boat.getVelocity());
Event event = new Event(time, boat, leg);
events.add(event);
totalDistance += leg.getDistance();
@param leg, the leg to add to the race // If finishing leg, add another event for when the boat finishes the race
*/ if (leg.getIsFinishingLeg()) {
public void addLeg(Leg leg) { time = (long) (1000 * totalDistance / boat.getVelocity());
this.legs.add(leg); event = new Event(time, boat, leg, true);
} events.add(event);
}
}
}
}
/** /**
* Gets legs array * Note: this function is useless so far
* * Calculates how far a boat has travelled in meter
* @return an array of legs *
*/ * @param velocity the velocity of boat
public ArrayList<Leg> getLegs() { * @return a float number of distance the boat has been travelled
return this.legs; */
} public float getDistanceTravelled(long velocity) {
long timeDiff = System.currentTimeMillis() - this.startTime;
long timeElapse = (long) (timeDiff / 1000 * this.timeScale);
return timeElapse * velocity;
}
/** /**
* Sets time scale * Iterate over events in the race and print the
* @param timeScale * event string for each event
*/ */
public void setTimeScale(double timeScale) { public void iterateEvents() {
this.timeScale = timeScale; // iterates all events. ends when no event in events.
} while (!events.isEmpty()) {
Event peekEvent = events.peek();
long currentTime = (long) ((System.currentTimeMillis() - this.startTime) * this.timeScale);
/** if (currentTime > peekEvent.getTime()) {
* Temporary method used to generated all the events. // pull out the event
*/ Event nextEvent = events.poll();
private void generateEvents() {
//calculate the time for every boat passes each leg, and create an event // I just simply print it out for testing
for (Boat boat : this.boats) { System.out.println(nextEvent.getEventString());
long totalDistance = 0; nextEvent.addBoatToMarker();
for (Leg leg : this.legs) {
long time = (long) (1000 * totalDistance / boat.getVelocity());
Event event = new Event(time, boat, leg);
events.add(event);
totalDistance += leg.getDistance();
// If finishing leg, add another event for when the boat finishes the race if (nextEvent.getIsFinishingEvent()) {
if (leg.getIsFinishingLeg()){ this.finishingOrder.add(nextEvent.getBoat());
time = (long) (1000 * totalDistance / boat.getVelocity()); }
event = new Event(time, boat, leg, true); }
events.add(event);
}
}
}
}
/** // Wait for 100ms to slow down the while loop
* Note: this function is useless so far try {
* Calculates how far a boat has travelled in meter Thread.sleep(100);
* } catch (java.lang.InterruptedException e) {
* @param velocity the velocity of boat continue;
* @return a float number of distance the boat has been travelled }
*/ }
public float getDistanceTravelled(long velocity) { }
long timeDiff = System.currentTimeMillis() - this.startTime;
long timeElapse = (long) (timeDiff / 1000 * this.timeScale);
return timeElapse * velocity;
}
/** /**
* Iterate over events in the race and print the * Start the race and print each marker with the order
* event string for each event * in which the boats passed that marker
*/ */
public void iterateEvents() { public void startRace() {
// iterates all events. ends when no event in events. // record start time.
while (!events.isEmpty()) { generateEvents();
Event peekEvent = events.peek(); this.startTime = System.currentTimeMillis();
long currentTime = (long) ((System.currentTimeMillis() - this.startTime) * this.timeScale); iterateEvents();
}
if (currentTime > peekEvent.getTime()) { /**
// pull out the event * Print the order in which the boats passed each marker
Event nextEvent = events.poll(); */
public void showRaceMarkerResults() {
for (Leg leg : this.legs) {
Boat[] boats = leg.getMarker().getBoats();
// I just simply print it out for testing System.out.println("--- " + leg.getMarkerLabel() + " ---");
System.out.println(nextEvent.getEventString());
nextEvent.addBoatToMarker();
if (nextEvent.getIsFinishingEvent()){ // Print the order in which the boats passed the marker
this.finishingOrder.add(nextEvent.getBoat()); for (int i = 0; i < this.getNumberOfBoats(); i++) {
} System.out.println("#" + Integer.toString(i + 1) + " - " + boats[i].getTeamName());
} }
// Wait for 100ms to slow down the while loop System.out.println("");
try{ }
Thread.sleep(100); }
}
catch(java.lang.InterruptedException e){
continue;
}
}
}
/*
Start the race and print each marker with the order
in which the boats passed that marker
*/
public void startRace() {
// record start time.
generateEvents();
this.startTime = System.currentTimeMillis();
iterateEvents();
}
/*
Print the order in which the boats passed each marker
*/
public void showRaceMarkerResults(){
for (Leg leg : this.legs) {
Boat[] boats = leg.getMarker().getBoats();
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("");
}
}
} }
src/test/java/seng302/AppTest.java
+4 -5
View File
@@ -1,16 +1,15 @@
package seng302; package seng302;
import org.junit.Test; import org.junit.Test;
import static org.junit.Assert.assertTrue; import static org.junit.Assert.assertTrue;
/** /**
* Unit test for simple App. * Unit test for simple App.
*/ */
public class AppTest public class AppTest {
{
@Test @Test
public void testApp() public void testApp() {
{ assertTrue(true);
assertTrue( true );
} }
} }
src/test/java/seng302/BoatTest.java
+7 -10
View File
@@ -1,27 +1,24 @@
package seng302; package seng302;
import org.junit.Test; import org.junit.Test;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertEquals;
/** /**
* Unit test for the Team class. * Unit test for the Team class.
*/ */
public class BoatTest public class BoatTest {
{
@Test @Test
public void testBoatCreation() public void testBoatCreation() {
{
Boat boat1 = new Boat("Team 1"); Boat boat1 = new Boat("Team 1");
assertEquals(boat1.getTeamName(), "Team 1"); assertEquals(boat1.getTeamName(), "Team 1");
} }
@Test @Test
public void testChangeTeamName() public void testChangeTeamName() {
{ Boat boat1 = new Boat("Team 1");
Boat boat1 = new Boat("Team 1"); boat1.setTeamName("Team 2");
boat1.setTeamName("Team 2"); assertEquals(boat1.getTeamName(), "Team 2");
assertEquals(boat1.getTeamName(), "Team 2");
} }
} }
src/test/java/seng302/EventTest.java
+8 -9
View File
@@ -1,9 +1,8 @@
package seng302; package seng302;
import org.junit.Before;
import org.junit.Test; import org.junit.Test;
import static org.junit.Assert.*; import static org.junit.Assert.assertEquals;
/** /**
* Test for Event class * Test for Event class
@@ -11,11 +10,11 @@ import static org.junit.Assert.*;
*/ */
public class EventTest { public class EventTest {
@Test @Test
public void getTimeString() throws Exception { public void getTimeString() throws Exception {
Leg leg = new Leg(035, 100, "Start"); Leg leg = new Leg(035, 100, "Start");
Boat boat = new Boat("testBoat"); Boat boat = new Boat("testBoat");
Event event = new Event(1231242, boat, leg); Event event = new Event(1231242, boat, leg);
assertEquals("20:31:242", event.getTimeString()); assertEquals("20:31:242", event.getTimeString());
} }
} }
src/test/java/seng302/FileParserTest.java
+34 -34
View File
@@ -3,50 +3,50 @@ package seng302;
import org.junit.Test; import org.junit.Test;
import java.io.FileNotFoundException; import java.io.FileNotFoundException;
import java.util.ArrayList;
import static org.junit.Assert.*; import static org.junit.Assert.assertEquals;
/** Unit test for FileParser class /**
* Unit test for FileParser class
* Created by Haoming on 5/03/17. * Created by Haoming on 5/03/17.
*/ */
public class FileParserTest { public class FileParserTest {
/* /*
test if it fails from reading non existed file test if it fails from reading non existed file
*/ */
@Test (expected = FileNotFoundException.class) @Test(expected = FileNotFoundException.class)
public void readNonExistedFile() throws Exception { public void readNonExistedFile() throws Exception {
FileParser fileParser = new FileParser("test/java/seng302/non-existed.json"); FileParser fileParser = new FileParser("test/java/seng302/non-existed.json");
} }
/* /*
test a valid json file with valid content. test a valid json file with valid content.
*/ */
@Test @Test
public void readValidFile() throws Exception{ public void readValidFile() throws Exception {
FileParser fileParser = new FileParser("src/test/java/seng302/valid.json"); FileParser fileParser = new FileParser("src/test/java/seng302/valid.json");
assertEquals("AC35", fileParser.getRaceName()); assertEquals("AC35", fileParser.getRaceName());
assertEquals("Oracle Team USA", fileParser.getTeams().get(0).get("team-name")); assertEquals("Oracle Team USA", fileParser.getTeams().get(0).get("team-name"));
assertEquals(20.9, fileParser.getTeams().get(0).get("velocity")); assertEquals(20.9, fileParser.getTeams().get(0).get("velocity"));
assertEquals(2, fileParser.getRaceSize()); assertEquals(2, fileParser.getRaceSize());
assertEquals(6, fileParser.getTotalNumberOfTeams()); assertEquals(6, fileParser.getTotalNumberOfTeams());
} }
/* /*
test an invalid json file within wrong type value and misnamed test an invalid json file within wrong type value and misnamed
variable name. variable name.
*/ */
@Test @Test
public void readInvalidFile() throws Exception { public void readInvalidFile() throws Exception {
FileParser fileParser = new FileParser("src/test/java/seng302/invalid.json"); FileParser fileParser = new FileParser("src/test/java/seng302/invalid.json");
assertEquals(null, fileParser.getRaceName()); assertEquals(null, fileParser.getRaceName());
assertEquals(null, fileParser.getTeams()); assertEquals(null, fileParser.getTeams());
//assertEquals(-1, fileParser.getTimeScale()); //assertEquals(-1, fileParser.getTimeScale());
assertEquals(null,fileParser.getTeams()); assertEquals(null, fileParser.getTeams());
} }
} }
src/test/java/seng302/LegTest.java
+12 -15
View File
@@ -1,21 +1,20 @@
package seng302; package seng302;
import org.junit.Test; import org.junit.Test;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertEquals;
/** /**
* Unit test for the Leg class. * Unit test for the Leg class.
*/ */
public class LegTest{ public class LegTest {
/* /*
Test creation of the leg by specifying a string Test creation of the leg by specifying a string
for the marker label for the marker label
*/ */
@Test @Test
public void testLegCreationUsingMarkerLabel() public void testLegCreationUsingMarkerLabel() {
{
Leg leg = new Leg(010, 100, "Marker"); Leg leg = new Leg(010, 100, "Marker");
assertEquals(leg.getHeading(), 010); assertEquals(leg.getHeading(), 010);
@@ -25,12 +24,11 @@ public class LegTest{
} }
/* /*
Test creation of the leg by providing a Test creation of the leg by providing a
Marker object Marker object
*/ */
@Test @Test
public void testLegCreation() public void testLegCreation() {
{
Leg leg = new Leg(010, 100, new Marker("Marker")); Leg leg = new Leg(010, 100, new Marker("Marker"));
assertEquals(leg.getHeading(), 010); assertEquals(leg.getHeading(), 010);
@@ -40,12 +38,11 @@ public class LegTest{
} }
/* /*
Test changing whether or not a Test changing whether or not a
leg is the finishing leg leg is the finishing leg
*/ */
@Test @Test
public void testSetFinishLeg() public void testSetFinishLeg() {
{
Leg leg = new Leg(010, 100, "Marker"); Leg leg = new Leg(010, 100, "Marker");
leg.setFinishingLeg(true); leg.setFinishingLeg(true);
src/test/java/seng302/RaceTest.java
+8 -8
View File
@@ -1,20 +1,20 @@
package seng302; package seng302;
import org.junit.Test; import org.junit.Test;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.assertEquals;
import java.lang.reflect.Array; import java.lang.reflect.Array;
import static org.junit.Assert.assertEquals;
/** /**
* Unit test for the Race class. * Unit test for the Race class.
*/ */
public class RaceTest public class RaceTest {
{ /**
/* * Test that all boats were added to the race
Test that all boats were added to the race */
*/
@Test @Test
public void testAddingBoatsToRace(){ public void testAddingBoatsToRace() {
Boat boat1 = new Boat("Team 1"); Boat boat1 = new Boat("Team 1");
Boat boat2 = new Boat("Team 2"); Boat boat2 = new Boat("Team 2");
src/test/java/seng302/invalid.json
+5 -1
View File
@@ -1,5 +1,9 @@
{ {
"time-scale": "abc", "time-scale": "abc",
"race-name": 123, "race-name": 123,
"teams-with-wrong-name":["team1","team2","team3"] "teams-with-wrong-name": [
"team1",
"team2",
"team3"
]
} }
src/test/java/seng302/valid.json
+24 -6
View File
@@ -3,11 +3,29 @@
"time-scale": 1, "time-scale": 1,
"race-size": 2, "race-size": 2,
"teams": [ "teams": [
{"team-name": "Oracle Team USA", "velocity": 20.9}, {
{"team-name": "Artemis Racing", "velocity": 18.3}, "team-name": "Oracle Team USA",
{"team-name": "Emirates Team New Zealand", "velocity": 21.5}, "velocity": 20.9
{"team-name": "Groupama Team France","velocity": 19.9}, },
{"team-name": "Land Rover BAR", "velocity": 17.6}, {
{"team-name": "SoftBank Team Japan", "velocity": 16.6} "team-name": "Artemis Racing",
"velocity": 18.3
},
{
"team-name": "Emirates Team New Zealand",
"velocity": 21.5
},
{
"team-name": "Groupama Team France",
"velocity": 19.9
},
{
"team-name": "Land Rover BAR",
"velocity": 17.6
},
{
"team-name": "SoftBank Team Japan",
"velocity": 16.6
}
] ]
} }