Merge branch 'story31.2_alternateTack' into 'sprint4_master'

story 31.1, 31.2, 32 merge request



See merge request !3
main
Joseph Gardner 9 years ago
commit e9a6c34e68

@ -3,27 +3,21 @@ package seng302;
import javafx.application.Application; import javafx.application.Application;
import javafx.stage.Stage; import javafx.stage.Stage;
import org.w3c.dom.Document; import org.w3c.dom.Document;
import org.xml.sax.InputSource; import org.xml.sax.InputSource;
import org.xml.sax.SAXException; import org.xml.sax.SAXException;
import seng302.DataInput.PolarParser;
import seng302.DataInput.XMLReader; import seng302.DataInput.XMLReader;
import seng302.Model.Event; import seng302.Model.Event;
import seng302.Model.Polars;
import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException; import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.*; import javax.xml.transform.TransformerException;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import java.io.IOException; import java.io.IOException;
import java.io.StringReader;
import java.io.StringWriter;
import java.nio.charset.Charset; import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
public class App extends Application { public class App extends Application {
@ -39,22 +33,19 @@ public class App extends Application {
@Override @Override
public void start(Stage primaryStage) { public void start(Stage primaryStage) {
try { try {
Polars boatPolars = PolarParser.parse("polars/acc_polars.csv");
String regattaXML = readFile("mockXML/regattaTest.xml", StandardCharsets.UTF_8); String regattaXML = readFile("mockXML/regattaTest.xml", StandardCharsets.UTF_8);
String raceXML = readFile("mockXML/raceTest.xml", StandardCharsets.UTF_8); String raceXML = readFile("mockXML/raceTest.xml", StandardCharsets.UTF_8);
String boatXML = readFile("mockXML/boatTest.xml", StandardCharsets.UTF_8); String boatXML = readFile("mockXML/boatTest.xml", StandardCharsets.UTF_8);
Event raceEvent = new Event(raceXML, regattaXML, boatXML); Event raceEvent = new Event(raceXML, regattaXML, boatXML, boatPolars);
raceEvent.start(); raceEvent.start();
} catch (IOException e) { } catch (Exception e) {
e.printStackTrace(); //Catch all exceptions, print, and exit.
} catch (ParserConfigurationException e) {
e.printStackTrace();
} catch (SAXException e) {
e.printStackTrace();
} catch (TransformerException e) {
e.printStackTrace(); e.printStackTrace();
System.exit(1);
} }
} }

@ -6,9 +6,44 @@ package seng302;
*/ */
public class Constants { public class Constants {
public static final int NMToMetersConversion = 1852; // 1 nautical mile = 1852 meters /**
* Multiply by this factor to convert nautical miles to meters.
* <br>
* Divide by this factor to convert meters to nautical miles.
* <br>
* 1 nautical mile = 1852 meters.
*/
public static final int NMToMetersConversion = 1852;
/**
* Multiply by this factor to convert Knots to millimeters per second.
* <br>
* Divide by this factor to convert millimeters per second to Knots.
* <br>
* 1 knot = 514.444 millimeters per second.
*/
public static final double KnotsToMMPerSecond = 514.444;
/**
* The race pre-start time, in milliseconds. 3 minutes.
*/
public static final long RacePreStartTime = 3 * 60 * 1000;
/**
* The race preparatory time, in milliseconds. 1 minutes.
*/
public static final long RacePreparatoryTime = 1 * 60 * 1000;
/**
* The number of milliseconds in one hour.
*/
public static long OneHourMilliseconds = 1 * 60 * 60 * 1000;
public static final int PRE_RACE_WAIT_TIME = 18000;
public static final int TEST_VELOCITIES[] = new int[] { 30, 15, 64, 52, 25, 24 };
} }

@ -6,6 +6,7 @@ import org.xml.sax.SAXException;
import seng302.Model.Boat; import seng302.Model.Boat;
import seng302.Model.GPSCoordinate; import seng302.Model.GPSCoordinate;
import seng302.Model.Mark; import seng302.Model.Mark;
import seng302.Model.Polars;
import javax.xml.parsers.ParserConfigurationException; import javax.xml.parsers.ParserConfigurationException;
import java.io.IOException; import java.io.IOException;
@ -16,28 +17,29 @@ import java.util.Map;
* Created by cbt24 on 10/05/17. * Created by cbt24 on 10/05/17.
*/ */
public class BoatXMLReader extends XMLReader implements BoatDataSource { public class BoatXMLReader extends XMLReader implements BoatDataSource {
private final Map<Integer, Boat> boatMap = new HashMap<>(); private final Map<Integer, Boat> boatMap = new HashMap<>();
private final Map<Integer, Mark> markerMap = new HashMap<>(); private final Map<Integer, Mark> markerMap = new HashMap<>();
public BoatXMLReader(String filePath) throws ParserConfigurationException, SAXException, IOException { /**
this(filePath, true); * Polars table to assign to each boat.
} */
Polars boatPolars;
/** /**
* COnstructor for Boat XML * Constructor for Boat XML
* *
* @param filePath file path to read * @param filePath Name/path of file to read. Read as a resource.
* @param read whether or not to read and store the files straight away.
* @throws IOException error * @throws IOException error
* @throws SAXException error * @throws SAXException error
* @throws ParserConfigurationException error * @throws ParserConfigurationException error
*/ */
public BoatXMLReader(String filePath, boolean read) throws IOException, SAXException, ParserConfigurationException { public BoatXMLReader(String filePath, Polars boatPolars) throws IOException, SAXException, ParserConfigurationException {
super(filePath); super(filePath);
if (read) { this.boatPolars = boatPolars;
read(); read();
} }
}
public void read() { public void read() {
readSettings(); readSettings();
@ -89,9 +91,9 @@ public class BoatXMLReader extends XMLReader implements BoatDataSource {
String shortName = boatNode.getAttributes().getNamedItem("ShortName").getTextContent(); String shortName = boatNode.getAttributes().getNamedItem("ShortName").getTextContent();
if (exists(boatNode, "Country")) { if (exists(boatNode, "Country")) {
String country = boatNode.getAttributes().getNamedItem("Country").getTextContent(); String country = boatNode.getAttributes().getNamedItem("Country").getTextContent();
boatMap.put(sourceID, new Boat(sourceID, name, country)); boatMap.put(sourceID, new Boat(sourceID, name, country, this.boatPolars));
} else { } else {
boatMap.put(sourceID, new Boat(sourceID, name, shortName)); boatMap.put(sourceID, new Boat(sourceID, name, shortName, this.boatPolars));
} }
} }

@ -0,0 +1,109 @@
package seng302.DataInput;
/**
* Created by hba56 on 10/05/17.
*/
import seng302.Exceptions.InvalidPolarFileException;
import seng302.Model.Bearing;
import seng302.Model.Polars;
import java.io.*;
import java.util.ArrayList;
/**
* Responsible for parsing a polar data file, and creating a Polar data object.
*/
public class PolarParser {
/**
* Given a filename, this function parses it and generates a Polar object, which can be queried for polar information.
* @param filename The filename to load and read data from (loaded as a resource).
* @return A Polar table containing data from the given file.
*/
public static Polars parse(String filename) throws InvalidPolarFileException {
//Temporary table to return later.
Polars polarTable = new Polars();
//Open the file for reading.
InputStream fileStream = PolarParser.class.getClassLoader().getResourceAsStream(filename);
if (fileStream == null) {
throw new InvalidPolarFileException("Could not open polar data file: " + filename);
}
//Wrap it with buffered input stream to set encoding and buffer.
InputStreamReader in = null;
try {
in = new InputStreamReader(fileStream, "UTF-8");
} catch (UnsupportedEncodingException e) {
throw new InvalidPolarFileException("Unsupported encoding: UTF-8", e);
}
BufferedReader inputStream = new BufferedReader(in);
//We expect the polar data file to have the column headings:
// Tws, Twa0, Bsp0, Twa1, Bsp1, UpTwa, UpBsp, Twa2, Bsp2, Twa3, Bsp3, Twa4, Bsp4, Twa5, Bsp5, Twa6, Bsp6, DnTwa, DnBsp, Twa7, Bsp7
//and to have 7 rows of data.
//Angles are expected to be in degrees, and velocities in knots.
//We read data rows, and split them into arrays of elements.
ArrayList<String[]> dataRows = new ArrayList<>(7);
try {
//Heading row.
//We skip the heading row by reading it.
String headingRow = inputStream.readLine();
//Data rows.
while (inputStream.ready()) {
//Read line.
String dataRow = inputStream.readLine();
//Split line.
String[] dataElements = dataRow.split(",");
//Add to collection.
dataRows.add(dataElements);
}
} catch (IOException e) {
throw new InvalidPolarFileException("Could not read from polar data file: " + filename, e);
}
//Finished reading in data, now we need to construct polar rows and table from it.
//For each row...
int rowNumber = 0;
for (String[] row : dataRows) {
//For each pair of columns (the pair is angle, speed).
//We start at column 1 since column 0 is the wind speed column.
for (int i = 1; i < row.length; i += 2) {
//Add angle+speed=velocity estimate to polar table.
try {
//Add the polar value to the polar table
double windSpeedKnots = Double.parseDouble(row[0]);
double angleDegrees = Double.parseDouble(row[i]);
Bearing angle = Bearing.fromDegrees(angleDegrees);
double boatSpeedKnots = Double.parseDouble(row[i + 1]);
polarTable.addEstimate(windSpeedKnots, angle, boatSpeedKnots);
} catch (NumberFormatException e) {
throw new InvalidPolarFileException("Could not convert (Row,Col): (" + rowNumber + "," + i +") = " + row[i] + " to a double.", e);
}
}
//Increment row number.
rowNumber++;
}
return polarTable;
}
}

@ -1,6 +1,5 @@
package seng302.DataInput; package seng302.DataInput;
;
import seng302.Model.Boat; import seng302.Model.Boat;
import seng302.Model.CompoundMark; import seng302.Model.CompoundMark;
import seng302.Model.GPSCoordinate; import seng302.Model.GPSCoordinate;

@ -204,6 +204,7 @@ public class RaceXMLReader extends XMLReader implements RaceDataSource {
lastCompoundMark = currentCompoundMark; lastCompoundMark = currentCompoundMark;
legName = getCompoundMarkName(getCompoundMarkID(markXML)); legName = getCompoundMarkName(getCompoundMarkID(markXML));
} }
} }
private void readCourseLimit() { private void readCourseLimit() {

@ -27,9 +27,9 @@ public abstract class XMLReader {
/** /**
* Read in XML file * Read in XML file
* @param filePath filepath for XML file * @param filePath filepath for XML file
* @throws ParserConfigurationException * @throws ParserConfigurationException If a document builder cannot be created.
* @throws IOException * @throws IOException If any IO errors occur while parsing the XML file.
* @throws SAXException * @throws SAXException If any parse error occurs while parsing.
*/ */
public XMLReader(String filePath) throws ParserConfigurationException, IOException, SAXException { public XMLReader(String filePath) throws ParserConfigurationException, IOException, SAXException {

@ -0,0 +1,28 @@
package seng302.Exceptions;
/**
* Created by f123 on 10-May-17.
*/
/**
* An exception thrown when we cannot parse a polar data file.
*/
public class InvalidPolarFileException extends RuntimeException {
/**
* Constructs the exception with a given message.
* @param message Message to store.
*/
public InvalidPolarFileException(String message) {
super(message);
}
/**
* Constructs the exception with a given message and cause.
* @param message Message to store.
* @param cause Cause to store.
*/
public InvalidPolarFileException(String message, Throwable cause) {
super(message, cause);
}
}

@ -0,0 +1,130 @@
package seng302.Model;
/**
* This represents an angle.
* Has functions to return angle as either degrees or radians.
*/
public class Angle implements Comparable<Angle> {
/**
* The angle stored in this object.
* Degrees.
*/
private double degrees;
/**
* Ctor.
* Don't use this.
* This is protected because you need to use the static helper functions {@link #fromDegrees(double)} and {@link #fromRadians(double)} to construct an Angle object.
*
* @param degrees The value, in degrees, to initialize this Angle object with.
*/
protected Angle(double degrees) {
this.degrees = degrees;
}
/**
* Constructs an Angle object from an angle value in degrees.
* @param degrees Angle value in degrees.
* @return Angle object.
*/
public static Angle fromDegrees(double degrees) {
Angle angle = new Angle(degrees);
return angle;
}
/**
* Constructs an Angle object from an angle value in radians.
* @param radians Angle value in radians.
* @return Angle object.
*/
public static Angle fromRadians(double radians) {
return Angle.fromDegrees(Math.toDegrees(radians));
}
/**
* Returns the value of this Angle object, in degrees.
* @return The value of this Angle object, in degrees.
*/
public double degrees() {
return this.degrees;
}
/**
* Returns the value of this Angle object, in radians.
* @return The value of this Angle object, in radians.
*/
public double radians() {
return Math.toRadians(this.degrees);
}
/**
* Returns true if two Angle objects have equal values.
* @param obj Other angle object to compare.
* @return True if they are equal, false otherwise.
*/
@Override
public boolean equals(Object obj) {
//Cast other side.
Angle other = (Angle) obj;
//Compare values.
if (this.degrees() == other.degrees()) {
return true;
} else {
return false;
}
}
/**
* Returns an int describing the ordering between this angle object, and another.
* @param o Other angle to compare to.
* @return {@literal int < 0} if this angle is less than the other angle, {@literal int > 0} if this angle is greater than the other angle, and {@literal int = 0} if this angle is equal to the other angle,
*/
@Override
public int compareTo(Angle o) {
if (this.degrees() < o.degrees()) {
return -1;
} else if (this.degrees() > o.degrees()) {
return 1;
} else {
return 0;
}
}
/**
* Converts an angle to an angle in a given periodic interval (e.g., degrees have a periodic interval of 360, radians have a periodic interval of 2Pi) of [lowerBound, upperBound).
* @param angle The angle to convert.
* @param lowerBound The lower bound of the interval.
* @param upperBound The upper bound of the interval.
* @param period The period of the interval.
* @return The angle in the desired periodic interval.
*/
public static double toPeriodicInterval(double angle, double lowerBound, double upperBound, double period) {
while (angle >= upperBound) {
//Too large.
angle -= period;
}
while (angle < lowerBound) {
//Too small.
angle += period;
}
return angle;
}
}

@ -0,0 +1,68 @@
package seng302.Model;
/**
* Represents an azimuth.
* If treated as an absolute azimuth this is the angle between north and a target point.
* If treated as a relative azimuth, this is the angle between from one target point to the other.
* It has the interval [-180, 180) degrees, and clockwise is positive.
*/
public class Azimuth extends Angle{
/**
* Ctor.
* This is protected because you need to use the static helper functions {@link #fromDegrees(double)} and {@link #fromRadians(double)} to construct an Azimuth object.
*
* @param degrees The value, in degrees, to initialize this Azimuth object with.
*/
protected Azimuth(double degrees) {
super(degrees);
}
/**
* Converts an angle in degrees into an angle in degrees in the correct interval for an azimuth - [-180, 180).
* E.g., converts -183 to 177, or converts 250 to -110, or converts 180 to -180.
* @param degrees Degree value to convert.
* @return Degree value in interval [-180, 180).
*/
public static double toAzimuthInterval(double degrees) {
return Angle.toPeriodicInterval(degrees, -180d, 180d, 360d);
}
/**
* Constructs an Azimuth object from an angle value in degrees.
* @param degrees Azimuth value in degrees.
* @return Azimuth object.
*/
public static Azimuth fromDegrees(double degrees) {
//Ensure the angle is in the correct interval.
double degreesInInterval = Azimuth.toAzimuthInterval(degrees);
Azimuth azimuth = new Azimuth(degreesInInterval);
return azimuth;
}
/**
* Constructs an Azimuth object from an angle value in radians.
* @param radians Azimuth value in radians.
* @return Azimuth object.
*/
public static Azimuth fromRadians(double radians) {
return Azimuth.fromDegrees(Math.toDegrees(radians));
}
/**
* Constructs an Azimuth object from a Bearing object.
* @param bearing Bearing object to read value from.
* @return Azimuth object.
*/
public static Azimuth fromBearing(Bearing bearing) {
return Azimuth.fromDegrees(bearing.degrees());
}
}

@ -0,0 +1,66 @@
package seng302.Model;
/**
* Represents a bearing. Also known as a heading.
* If treated as an absolute bearing this is the angle between north and a target point.
* If treated as a relative bearing, this is the angle between from one target point to the other.
* Has the interval [0, 360) degrees, and clockwise is positive.
*/
public class Bearing extends Angle {
/**
* Ctor.
* This is protected because you need to use the static helper functions {@link #fromDegrees(double)} and {@link #fromRadians(double)} to construct a Bearing object.
*
* @param degrees The value, in degrees, to initialize this Bearing object with.
*/
protected Bearing(double degrees) {
super(degrees);
}
/**
* Converts an angle in degrees into an angle in degrees in the correct interval for a bearing - [0, 360).
* E.g., converts -183 to 177, or converts 425 to 65.
* @param degrees Degree value to convert.
* @return Degree value in interval [0, 360).
*/
public static double toBearingInterval(double degrees) {
return Angle.toPeriodicInterval(degrees, -0d, 360d, 360d);
}
/**
* Constructs a Bearing object from an angle value in degrees.
* @param degrees Bearing value in degrees.
* @return Bearing object.
*/
public static Bearing fromDegrees(double degrees) {
//Ensure the angle is in the correct interval.
double degreesInInterval = Bearing.toBearingInterval(degrees);
Bearing bearing = new Bearing(degreesInInterval);
return bearing;
}
/**
* Constructs a Bearing object from an angle value in radians.
* @param radians Bearing value in radians.
* @return Bearing object.
*/
public static Bearing fromRadians(double radians) {
return Bearing.fromDegrees(Math.toDegrees(radians));
}
/**
* Constructs a Bearing object from an Azimuth object.
* @param azimuth Azimuth object to read value from.
* @return Bearing object.
*/
public static Bearing fromAzimuth(Azimuth azimuth) {
return Bearing.fromDegrees(azimuth.degrees());
}
}

@ -1,154 +1,445 @@
package seng302.Model; package seng302.Model;
import org.geotools.referencing.GeodeticCalculator; import seng302.Constants;
import seng302.Networking.Messages.Enums.BoatStatusEnum;
/** /**
* Created by esa46 on 1/05/17. * This class represents a boat during a race.
*/ */
public class Boat { public class Boat {
/**
* The name of the boat/team.
*/
private String name; private String name;
private double velocity;
private double scaledVelocity; /**
* The current speed of the boat, in knots.
* TODO knots
*/
private double currentSpeed;
/**
* The current bearing/heading of the boat.
*/
private Bearing bearing;
/**
* The current position of the boat.
*/
private GPSCoordinate currentPosition;
/**
* The country or team abbreviation of the boat.
*/
private String country; private String country;
/**
* The source ID of the boat.
* This uniquely identifies an entity during a race.
*/
private int sourceID; private int sourceID;
/**
* The leg of the race that the boat is currently on.
*/
private Leg currentLeg; private Leg currentLeg;
/**
* The distance, in meters, that the boat has travelled in the current leg.
* TODO meters
*/
private double distanceTravelledInLeg; private double distanceTravelledInLeg;
private GPSCoordinate currentPosition;
/**
* The time, in milliseconds, that has elapsed during the current leg.
* TODO milliseconds
*/
private long timeElapsedInCurrentLeg;
/**
* The timestamp, in milliseconds, of when the boat finished the race.
* Is -1 if it hasn't finished.
* TODO milliseconds
*/
private long timeFinished = -1; private long timeFinished = -1;
private boolean started = false;
private double heading;
/** /**
* Boat initialiser which keeps all of the information of the boat. * The current status of the boat.
*/
private BoatStatusEnum status;
/**
* This stores a boat's polars table.
* Can be used to calculate VMG.
*/
private Polars polars;
/**
* This stores the milliseconds since the boat has changed its tack, to allow for only updating the tack every X milliseconds.
* TODO milliseconds
*/
private long timeSinceTackChange = 0;
/**
* Constructs a boat object with a given sourceID, name, country/team abbreviation, and polars table.
* *
* @param sourceID id of boat * @param sourceID The id of the boat
* @param name Name of the Boat. * @param name The name of the Boat.
* @param country nam abbreviation * @param country The abbreviation or country code for the boat.
* @param polars The polars table to use for this boat.
*/ */
public Boat(int sourceID, String name, String country) { public Boat(int sourceID, String name, String country, Polars polars) {
this.country = this.country; this.country = country;
this.name = name; this.name = name;
this.sourceID = sourceID; this.sourceID = sourceID;
this.polars = polars;
this.bearing = Bearing.fromDegrees(0d);
this.status = BoatStatusEnum.UNDEFINED;
} }
/** /**
* Calculates the azimuth of the travel via map coordinates of the raceMarkers * Calculate the bearing of the boat to its next marker.
* * @return The bearing to the next marker.
* @return the direction that the boat is heading towards in degrees (-180 to 180).
*/ */
public double calculateAzimuth() { public Bearing calculateBearingToNextMarker() {
GeodeticCalculator calc = new GeodeticCalculator(); //Get the start and end points.
GPSCoordinate start = currentLeg.getStartCompoundMark().getAverageGPSCoordinate(); GPSCoordinate currentPosition = this.getCurrentPosition();
GPSCoordinate end = currentLeg.getEndCompoundMark().getAverageGPSCoordinate(); GPSCoordinate nextMarkerPosition = this.getCurrentLeg().getEndCompoundMark().getAverageGPSCoordinate();
calc.setStartingGeographicPoint(start.getLongitude(), start.getLatitude()); //Calculate bearing.
calc.setDestinationGeographicPoint(end.getLongitude(), end.getLatitude()); Bearing bearing = GPSCoordinate.calculateBearing(currentPosition, nextMarkerPosition);
return calc.getAzimuth(); return bearing;
} }
/** /**
* Calculate the heding depending on the calculated azimuth value * Calculates the distance between the boat and its target marker in nautical miles.
* @return The azimuth value which is greater than 0 * @return The distance (in nautical miles) between the boat and its target marker.
*/ */
public double calculateHeading() { public double calculateDistanceToNextMarker() {
double azimuth = this.calculateAzimuth();
if (azimuth >= 0) { //Get start and end markers.
return azimuth; GPSCoordinate startPosition = this.getCurrentPosition();
} else {
return azimuth + 360; //When boats finish, their "current leg" doesn't have an end marker.
if (this.getCurrentLeg().getEndCompoundMark() == null) {
return 0d;
} }
GPSCoordinate endMarker = this.getCurrentLeg().getEndCompoundMark().getAverageGPSCoordinate();
//Calculate distance.
double distanceNauticalMiles = GPSCoordinate.calculateDistanceNauticalMiles(startPosition, endMarker);
return distanceNauticalMiles;
} }
/**
* Returns the name of the boat/team.
* @return Name of the boat/team.
*/
public String getName() { public String getName() {
return name; return name;
} }
/**
* Sets the name of the boat/team.
* @param name Name of the boat/team.
*/
public void setName(String name) { public void setName(String name) {
this.name = name; this.name = name;
} }
public double getVelocity() {
return velocity;
}
public void setVelocity(double velocity) { /**
this.velocity = velocity; * Returns the current speed of the boat, in knots.
* @return The current speed of the boat, in knots.
*/
public double getCurrentSpeed() {
return currentSpeed;
} }
public double getScaledVelocity() { /**
return scaledVelocity; * Sets the speed of the boat, in knots.
* @param currentSpeed The new speed of the boat, in knots.
*/
public void setCurrentSpeed(double currentSpeed) {
this.currentSpeed = currentSpeed;
} }
public void setScaledVelocity(double scaledVelocity) {
this.scaledVelocity = scaledVelocity;
}
/**
* Gets the country/team abbreviation of the boat.
* @return The country/team abbreviation of the boat.
*/
public String getCountry() { public String getCountry() {
return country; return country;
} }
/**
* Sets the country/team abbreviation of the boat.
* @param country The new country/team abbreviation for the boat.
*/
public void setCountry(String country) { public void setCountry(String country) {
this.country = country; this.country = country;
} }
/**
* Returns the source ID of the boat.
* @return The source ID of the boat.
*/
public int getSourceID() { public int getSourceID() {
return sourceID; return sourceID;
} }
/**
* Sets the source ID of the boat.
* @param sourceID The new source ID for the boat.
*/
public void setSourceID(int sourceID) { public void setSourceID(int sourceID) {
this.sourceID = sourceID; this.sourceID = sourceID;
} }
/**
* Returns the current leg of the race the boat is in.
* @return The current leg of the race the boat is in.
*/
public Leg getCurrentLeg() { public Leg getCurrentLeg() {
return currentLeg; return currentLeg;
} }
/**
* Sets the current leg of the race the boat is in.
* Clears time elapsed in current leg and distance travelled in current leg.
* @param currentLeg The new leg of the race the boat is in.
*/
public void setCurrentLeg(Leg currentLeg) { public void setCurrentLeg(Leg currentLeg) {
this.currentLeg = currentLeg; this.currentLeg = currentLeg;
this.setTimeElapsedInCurrentLeg(0);
this.setDistanceTravelledInLeg(0);
} }
/**
* Returns the distance, in meters, the boat has travelled in the current leg.
* @return The distance, in meters, the boat has travelled in the current leg.
*/
public double getDistanceTravelledInLeg() { public double getDistanceTravelledInLeg() {
return distanceTravelledInLeg; return distanceTravelledInLeg;
} }
/**
* Sets the distance, in meters, the boat has travelled in the current leg.
* @param distanceTravelledInLeg The distance, in meters, the boat has travelled in the current leg.
*/
public void setDistanceTravelledInLeg(double distanceTravelledInLeg) { public void setDistanceTravelledInLeg(double distanceTravelledInLeg) {
this.distanceTravelledInLeg = distanceTravelledInLeg; this.distanceTravelledInLeg = distanceTravelledInLeg;
} }
/**
* Returns the current position of the boat.
* @return The current position of the boat.
*/
public GPSCoordinate getCurrentPosition() { public GPSCoordinate getCurrentPosition() {
return currentPosition; return currentPosition;
} }
/**
* Sets the current position of the boat.
* @param currentPosition The new position for the boat.
*/
public void setCurrentPosition(GPSCoordinate currentPosition) { public void setCurrentPosition(GPSCoordinate currentPosition) {
this.currentPosition = currentPosition; this.currentPosition = currentPosition;
} }
/**
* Gets the timestamp, in milliseconds, at which the boat finished the race.
* @return The timestamp, in milliseconds, at which the boat finished the race.
*/
public long getTimeFinished() { public long getTimeFinished() {
return timeFinished; return timeFinished;
} }
/**
* Sets the timestamp, in milliseconds, at which the boat finished the race.
* @param timeFinished The timestamp, in milliseconds, at which the boat finished the race.
*/
public void setTimeFinished(long timeFinished) { public void setTimeFinished(long timeFinished) {
this.timeFinished = timeFinished; this.timeFinished = timeFinished;
} }
public boolean isStarted() {
return started;
/**
* Returns the current bearing of the boat.
* @return The current bearing of the boat.
*/
public Bearing getBearing() {
return bearing;
}
/**
* Sets the current bearing of the boat.
* @param bearing The new bearing of the boat.
*/
public void setBearing(Bearing bearing) {
this.bearing = bearing;
}
/**
* Returns the polars table for this boat.
* @return The polars table for this boat.
*/
public Polars getPolars() {
return polars;
}
/**
* Sets the polars table for this boat.
* @param polars The new polars table for this boat.
*/
public void setPolars(Polars polars) {
this.polars = polars;
}
/**
* Returns the time since the boat changed its tack, in milliseconds.
* @return Time since the boat changed its tack, in milliseconds.
*/
public long getTimeSinceTackChange() {
return timeSinceTackChange;
}
/**
* Sets the time since the boat changed it's tack, in milliseconds.
* @param timeSinceTackChange Time since the boat changed its tack, in milliseconds.
*/
public void setTimeSinceTackChange(long timeSinceTackChange) {
this.timeSinceTackChange = timeSinceTackChange;
}
/**
* Returns the time, in milliseconds, that has elapsed since the boat started the current leg.
* @return The time, in milliseconds, that has elapsed since the boat started the current leg.
*/
public long getTimeElapsedInCurrentLeg() {
return timeElapsedInCurrentLeg;
}
/**
* Sets the time, in milliseconds, that has elapsed since the boat started the current leg.
* @param timeElapsedInCurrentLeg The new time, in milliseconds, that has elapsed since the boat started the current leg.
*/
public void setTimeElapsedInCurrentLeg(long timeElapsedInCurrentLeg) {
this.timeElapsedInCurrentLeg = timeElapsedInCurrentLeg;
} }
public void setStarted(boolean started) {
this.started = started; /**
* Returns the status of the boat.
* @return The sttus of the boat.
*/
public BoatStatusEnum getStatus() {
return status;
} }
public double getHeading() { /**
return heading; * Sets the status of the boat.
* @param status The new status of the boat.
*/
public void setStatus(BoatStatusEnum status) {
this.status = status;
} }
public void setHeading(double heading) {
this.heading = heading; /**
* Moves the boat meters forward in the direction that it is facing
* @param meters The number of meters to move forward.
* @param milliseconds The number of milliseconds to advance the boat's timers by.
*/
public void moveForwards(double meters, long milliseconds) {
//Update the boat's time since last tack.
this.setTimeSinceTackChange(this.getTimeSinceTackChange() + milliseconds);
//Update the time into the current leg.
this.setTimeElapsedInCurrentLeg(this.getTimeElapsedInCurrentLeg() + milliseconds);
//Update the distance into the current leg.
this.setDistanceTravelledInLeg(this.getDistanceTravelledInLeg() + meters);
//Updates the current position of the boat.
GPSCoordinate newPosition = GPSCoordinate.calculateNewPosition(this.getCurrentPosition(), meters, Azimuth.fromBearing(this.getBearing()));
this.setCurrentPosition(newPosition);
} }
/**
* Sets the boats speed and bearing to those in the given VMG.
* @param newVMG The new VMG to use for the boat - contains speed and bearing.
*/
public void setVMG(VMG newVMG) {
this.setBearing(newVMG.getBearing());
this.setCurrentSpeed(newVMG.getSpeed());
this.setTimeSinceTackChange(0);
}
/**
* Calculates the number of nautical miles the boat will travel in a given time slice.
* E.g., in 53 milliseconds a boat may travel 0.0002 nautical miles.
* @param timeSlice The timeslice to use.
* @return The distance travelled, in nautical miles, over the given timeslice.
*/
public double calculateNauticalMilesTravelled(long timeSlice) {
//The proportion of one hour the current timeslice is.
//This will be a low fractional number, so we need to go from long -> double.
double hourProportion = ((double) timeSlice) / Constants.OneHourMilliseconds;
//Calculates the distance travelled, in nautical miles, in the current timeslice.
//distanceTravelledNM = speed (nm p hr) * time taken to update loop
double distanceTravelledNM = this.getCurrentSpeed() * hourProportion;
return distanceTravelledNM;
}
/**
* Calculates the number of meters the boat will travel in a given time slice.
* E.g., in 53 milliseconds a boat may travel 0.02 meters.
* @param timeSlice The timeslice to use.
* @return The distance travelled, in meters, over the given timeslice.
*/
public double calculateMetersTravelled(long timeSlice) {
//Calculate the distance travelled, in nautical miles.
double distanceTravelledNM = this.calculateNauticalMilesTravelled(timeSlice);
//Convert to meters.
double distanceTravelledMeters = distanceTravelledNM * Constants.NMToMetersConversion;
return distanceTravelledMeters;
}
} }

@ -1,61 +1,110 @@
package seng302.Model; package seng302.Model;
import org.geotools.referencing.GeodeticCalculator;
import java.awt.geom.Point2D;
/** /**
* Created by esa46 on 29/03/17. * Represents a compound mark - that is, either one or two individual marks which form a single compound mark.
*/ */
public class CompoundMark extends Marker{ public class CompoundMark {
private GPSCoordinate averageGPSCoordinate; /**
* The first mark in the compound mark.
*/
private Mark mark1; private Mark mark1;
private Mark mark2 = null;
/**
* The second mark in the compound mark.
*/
private Mark mark2;
/**
* The average coordinate of the compound mark.
*/
private GPSCoordinate averageGPSCoordinate;
/**
* Constructs a compound mark from a single mark.
* @param mark1 The individual mark that comprises this compound mark.
*/
public CompoundMark(Mark mark1) { public CompoundMark(Mark mark1) {
super(mark1.getPosition());
this.mark1 = mark1; this.mark1 = mark1;
this.averageGPSCoordinate = calculateAverage(); this.averageGPSCoordinate = calculateAverage();
} }
/**
* Constructs a compound mark from a pair of marks.
* @param mark1 The first individual mark that comprises this compound mark.
* @param mark2 The second individual mark that comprises this compound mark.
*/
public CompoundMark(Mark mark1, Mark mark2) { public CompoundMark(Mark mark1, Mark mark2) {
super(mark1.getPosition(), mark2.getPosition());
this.mark1 = mark1; this.mark1 = mark1;
this.mark2 = mark2; this.mark2 = mark2;
this.averageGPSCoordinate = calculateAverage(); this.averageGPSCoordinate = calculateAverage();
} }
public Mark getMark1Source() { return mark1; }
public Mark getMark2Source() { return mark2; } /**
* Returns the first mark of the compound mark.
* @return The first mark of the compound mark.
*/
public Mark getMark1() {
return mark1;
}
public GPSCoordinate getMark1() { /**
* Returns the second mark of the compound mark.
* @return The second mark of the compound mark.
*/
public Mark getMark2() {
return mark2;
}
/**
* Returns the position of the first mark in the compound mark.
* @return The position of the first mark in the compound mark.
*/
public GPSCoordinate getMark1Position() {
return mark1.getPosition(); return mark1.getPosition();
} }
public GPSCoordinate getMark2() { /**
* Returns the position of the second mark in the compound mark.
* @return The position of the second mark in the compound mark.
*/
public GPSCoordinate getMark2Position() {
return mark2.getPosition(); return mark2.getPosition();
} }
/**
* Returns the average coordinate of the compound mark.
* @return The average coordinate of the compound mark.
*/
public GPSCoordinate getAverageGPSCoordinate() { public GPSCoordinate getAverageGPSCoordinate() {
return averageGPSCoordinate; return averageGPSCoordinate;
} }
/**
* Calculates the average coordinate of the compound mark.
* @return The average coordinate of the compound mark.
*/
private GPSCoordinate calculateAverage() { private GPSCoordinate calculateAverage() {
if(mark2 != null) {
GeodeticCalculator calc = new GeodeticCalculator(); //If the compound mark only contains one mark, the average is simply the first mark's position.
calc.setStartingGeographicPoint(mark1.getPosition().getLongitude(), mark1.getPosition().getLatitude()); if (this.mark2 == null) {
calc.setDestinationGeographicPoint(mark2.getPosition().getLongitude(), mark2.getPosition().getLatitude()); return this.getMark1Position();
double azimuth = calc.getAzimuth(); }
double distance = calc.getOrthodromicDistance();
GeodeticCalculator middleCalc = new GeodeticCalculator(); //Otherwise, calculate the average of both marks.
middleCalc.setStartingGeographicPoint(mark1.getPosition().getLongitude(), mark1.getPosition().getLatitude()); GPSCoordinate averageCoordinate = GPSCoordinate.calculateAverageCoordinate(this.getMark1Position(), this.getMark2Position());
middleCalc.setDirection(azimuth, distance / 2);
Point2D middlePoint = middleCalc.getDestinationGeographicPoint(); return averageCoordinate;
return new GPSCoordinate(middlePoint.getY(), middlePoint.getX());
} else return mark1.getPosition();
} }
} }

@ -21,13 +21,15 @@ public class Event {
String raceXML; String raceXML;
String regattaXML; String regattaXML;
String boatXML; String boatXML;
Polars boatPolars;
MockOutput mockOutput; MockOutput mockOutput;
public Event(String raceXML, String regattaXML, String boatXML) { public Event(String raceXML, String regattaXML, String boatXML, Polars boatPolars) {
this.raceXML = getRaceXMLAtCurrentTime(raceXML); this.raceXML = getRaceXMLAtCurrentTime(raceXML);
this.boatXML = boatXML; this.boatXML = boatXML;
this.regattaXML = regattaXML; this.regattaXML = regattaXML;
this.boatPolars = boatPolars;
try { try {
mockOutput = new MockOutput(); mockOutput = new MockOutput();
new Thread(mockOutput).start(); new Thread(mockOutput).start();
@ -42,7 +44,7 @@ public class Event {
public void start() { public void start() {
try { try {
sendXMLs(); sendXMLs();
Race newRace = new Race(new RaceXMLReader(this.raceXML, new BoatXMLReader(boatXML)), mockOutput); Race newRace = new Race(new RaceXMLReader(this.raceXML, new BoatXMLReader(boatXML, this.boatPolars)), mockOutput);
new Thread((newRace)).start(); new Thread((newRace)).start();
} catch (ParserConfigurationException | IOException | SAXException | ParseException | StreamedCourseXMLException e) { } catch (ParserConfigurationException | IOException | SAXException | ParseException | StreamedCourseXMLException e) {

@ -1,18 +1,34 @@
package seng302.Model; package seng302.Model;
import org.geotools.referencing.GeodeticCalculator;
import org.opengis.geometry.DirectPosition;
import seng302.Constants;
import java.awt.geom.Point2D;
import java.util.Comparator;
import java.util.List;
/** /**
* GPS Coordinate for the world map. * GPS Coordinate for the world map, containing a longitude and latitude.
* Created by esa46 on 15/03/17. * Created by esa46 on 15/03/17.
*/ */
public class GPSCoordinate { public class GPSCoordinate {
/**
* The latitude of the coordinate.
*/
private double latitude; private double latitude;
/**
* The longitude of the coordinate.
*/
private double longitude; private double longitude;
/** /**
* Constructor Method * Constructs a GPSCoordinate from a latitude and longitude value.
* * @param latitude Latitude the coordinate is located at.
* @param latitude latitude the coordinate is located at.
* @param longitude Longitude that the coordinate is located at. * @param longitude Longitude that the coordinate is located at.
*/ */
public GPSCoordinate(double latitude, double longitude) { public GPSCoordinate(double latitude, double longitude) {
@ -20,6 +36,8 @@ public class GPSCoordinate {
this.longitude = longitude; this.longitude = longitude;
} }
/** /**
* Gets the Latitude that the Coordinate is at. * Gets the Latitude that the Coordinate is at.
* *
@ -68,5 +86,211 @@ public class GPSCoordinate {
result = 31 * result + (int) (temp ^ (temp >>> 32)); result = 31 * result + (int) (temp ^ (temp >>> 32));
return result; return result;
} }
/**
* Calculates min and max values and passed it to calculate if coordinate is in the boundary
* @param coordinate coordinate of interest
* @param boundary List of points which make a boundry
* @return true if coordinate is in the boundary
*/
public static boolean isInsideBoundary(GPSCoordinate coordinate, List<GPSCoordinate> boundary) {
int length = boundary.size();
boolean inside = false;
// Check if inside using ray casting algorithm
for (int i = 0, j = length - 1; i < length; j = i++) {
if (intersects(boundary.get(i), boundary.get(j), coordinate)) {
inside = !inside;
}
}
return inside;
}
/**
* Calculates if the coordinate is in the boundary
* @param coordinate coordinate of interest
* @param boundary List of points which make a boundary
* @param minValues max GPS
* @param maxValues min GPS
* @return true if coordinate is in the boundary
*/
public static boolean isInsideBoundary(GPSCoordinate coordinate, List<GPSCoordinate> boundary, GPSCoordinate minValues, GPSCoordinate maxValues) {
double minLat = minValues.getLatitude();
double minLon = minValues.getLongitude();
double maxLat = maxValues.getLatitude();
double maxLon = maxValues.getLongitude();
double coordinateLat = coordinate.getLatitude();
double coordinateLon = coordinate.getLongitude();
// End computation early
if (coordinateLat <= minLat || coordinateLat >= maxLat || coordinateLon <= minLon || coordinateLon >= maxLon) {
return false;
} else {
return isInsideBoundary(coordinate, boundary);
}
}
/**
* Helper function to find if a point is in a boundary
* @param boundaryA The first coordinate of the boundary.
* @param boundaryB The second coordinate of the bounary.
* @param coordinate The coordinate to test.
* @return true if a line from the point intersects the two boundary points
*/
private static boolean intersects(GPSCoordinate boundaryA, GPSCoordinate boundaryB, GPSCoordinate coordinate) {
double boundaryALat = boundaryA.getLatitude();
double boundaryALon = boundaryA.getLongitude();
double boundaryBLat = boundaryB.getLatitude();
double boundaryBLon = boundaryB.getLongitude();
double coordinateLat = coordinate.getLatitude();
double coordinateLon = coordinate.getLongitude();
if (boundaryALat > boundaryBLat) {
return intersects(boundaryB, boundaryA, coordinate);
}
if (coordinateLat == boundaryALat || coordinateLat == boundaryBLat) {
// Move coordinate off intersection line
coordinateLat += 1e-9;
}
if (coordinateLat > boundaryBLat || coordinateLat < boundaryALat || coordinateLon > Double.max(boundaryALon, boundaryBLon)) {
return false;
}
if (coordinateLon < Double.min(boundaryALon, boundaryBLon)) {
return true;
}
double aRatio = (coordinateLat - boundaryALat) / (coordinateLon - boundaryALon);
double bRatio = (coordinateLat - boundaryBLat) / (coordinateLon - boundaryBLon);
return aRatio >= bRatio;
}
/**
* Calculates the azimuth between two points.
* @param start The starting point.
* @param end The ending point.
* @return The azimuth from the start point to the end point.
*/
public static Azimuth calculateAzimuth(GPSCoordinate start, GPSCoordinate end) {
GeodeticCalculator calc = new GeodeticCalculator();
calc.setStartingGeographicPoint(start.getLongitude(), start.getLatitude());
calc.setDestinationGeographicPoint(end.getLongitude(), end.getLatitude());
return Azimuth.fromDegrees(calc.getAzimuth());
}
/**
* Calculates the bearing between two points.
* @param start The starting point.
* @param end The ending point.
* @return The Bearing from the start point to the end point.
*/
public static Bearing calculateBearing(GPSCoordinate start, GPSCoordinate end) {
//Calculates the azimuth between the two points.
Azimuth azimuth = GPSCoordinate.calculateAzimuth(start, end);
//And converts it into a bearing.
return Bearing.fromAzimuth(azimuth);
}
/**
* Calculates the distance, in meters, between two points.
* Note: all other distance calculations (e.g., nautical miles between two points) should use this, and convert from meters to their desired unit.
* @param start The starting point.
* @param end The ending point.
* @return The distance, in meters, between the two given points.
*/
public static double calculateDistanceMeters(GPSCoordinate start, GPSCoordinate end) {
GeodeticCalculator calc = new GeodeticCalculator();
calc.setStartingGeographicPoint(start.getLongitude(), start.getLatitude());
calc.setDestinationGeographicPoint(end.getLongitude(), end.getLatitude());
double distanceMeters = calc.getOrthodromicDistance();
return distanceMeters;
}
/**
* Calculates the distance, in nautical miles, between two points.
* @param start The starting point.
* @param end The ending point.
* @return The distance, in nautical miles, between the two given points.
*/
public static double calculateDistanceNauticalMiles(GPSCoordinate start, GPSCoordinate end) {
//Find distance in meters.
double distanceMeters = GPSCoordinate.calculateDistanceMeters(start, end);
//Convert to nautical miles.
double distanceNauticalMiles = distanceMeters / Constants.NMToMetersConversion;
return distanceNauticalMiles;
}
/**
* Calculates the GPS position an entity will be at, given a starting position, distance (in meters), and an azimuth.
*
* @param oldCoordinates GPS coordinates of the entity's starting position.
* @param distanceMeters The distance in meters.
* @param azimuth The entity's current azimuth.
* @return The entity's new coordinate.
*/
public static GPSCoordinate calculateNewPosition(GPSCoordinate oldCoordinates, double distanceMeters, Azimuth azimuth) {
GeodeticCalculator calc = new GeodeticCalculator();
//Set starting position.
calc.setStartingGeographicPoint(oldCoordinates.getLongitude(), oldCoordinates.getLatitude());
//Set direction.
calc.setDirection(azimuth.degrees(), distanceMeters);
//Get the destination.
Point2D destinationPoint = calc.getDestinationGeographicPoint();
return new GPSCoordinate(destinationPoint.getY(), destinationPoint.getX());
}
/**
* Calculates the average coordinate of two coordinates.
* @param point1 The first coordinate to average.
* @param point2 The second coordinate to average.
* @return The average of the two coordinates.
*/
public static GPSCoordinate calculateAverageCoordinate(GPSCoordinate point1, GPSCoordinate point2) {
//Calculate distance between them.
double distanceMeters = GPSCoordinate.calculateDistanceMeters(point1, point2);
//We want the average, so get half the distance between points.
distanceMeters = distanceMeters / 2d;
//Calculate azimuth between them.
Azimuth azimuth = GPSCoordinate.calculateAzimuth(point1, point2);
//Calculate the middle coordinate.
GPSCoordinate middleCoordinate = GPSCoordinate.calculateNewPosition(point1, distanceMeters, azimuth);
return middleCoordinate;
}
} }

@ -1,102 +1,127 @@
package seng302.Model; package seng302.Model;
import org.geotools.referencing.GeodeticCalculator;
import seng302.Constants;
/** /**
* Created by cbt24 on 6/03/17. * Represents a leg of a race.
*/ */
public class Leg { public class Leg {
private String name; //nautical miles
private double distance; /**
private Marker startCompoundMark; * The name of the leg.
private Marker endCompoundMark; */
private String name;
/**
* The distance of the leg, in nautical miles.
*/
private double distanceNauticalMiles;
/**
* The starting marker of the leg.
*/
private CompoundMark startCompoundMark;
/**
* The ending marking of the leg.
*/
private CompoundMark endCompoundMark;
/**
* The leg number within a race.
*/
private int legNumber; private int legNumber;
/** /**
* Leg Initialiser * Constructs a leg from a name, start marker, end marker, and leg number.
* *
* @param name Name of the Leg * @param name Name of the Leg.
* @param start marker * @param start Starting marker of the leg.
* @param end marker * @param end Ending marker of the leg.
* @param number Leg's position in race * @param number Leg's position within the race.
*/ */
public Leg(String name, Marker start, Marker end, int number) { public Leg(String name, CompoundMark start, CompoundMark end, int number) {
this.name = name; this.name = name;
this.startCompoundMark = start; this.startCompoundMark = start;
this.endCompoundMark = end; this.endCompoundMark = end;
this.legNumber = number; this.legNumber = number;
calculateDistance(); this.calculateLegDistance();
} }
/** /**
* Construction Method * Constructs a leg from a name and leg number.
* This is currently used for constructing "dummy" DNF and Finish legs.
* *
* @param name Name of the Leg * @param name Name of the leg.
* @param number leg number * @param number Leg's position within the race.
*/ */
public Leg(String name, int number) { public Leg(String name, int number) {
this.name = name; this.name = name;
this.legNumber = number; this.legNumber = number;
} }
/** /**
* Returns the name of the Leg * Returns the name of the Leg.
* * @return The name of the Leg.
* @return Returns the name of the Leg
*/ */
public String getName() { public String getName() {
return name; return name;
} }
/** /**
* Get the distance in nautical miles * Get the distance in nautical miles.
* * @return The total distance of the leg.
* @return Returns the total distance of the leg.
*/ */
public double getDistance() { public double getDistanceNauticalMiles() {
return distance; return distanceNauticalMiles;
} }
/** /**
* Returns the leg number that the leg exists in the Race * Returns the leg number of the leg within a race.
* * @return The leg number of the leg within a race
* @return Returns the Leg
*/ */
public int getLegNumber() { public int getLegNumber() {
return legNumber; return legNumber;
} }
public Marker getStartCompoundMark() { /**
* Returns the starting marker of the leg.
* @return The starting marker of the leg.
*/
public CompoundMark getStartCompoundMark() {
return startCompoundMark; return startCompoundMark;
} }
public void setStartCompoundMark(Marker startCompoundMark) {
this.startCompoundMark = startCompoundMark;
}
public Marker getEndCompoundMark() { /**
* Returns the ending marker of the leg.
* @return The ending marker of the leg.
*/
public CompoundMark getEndCompoundMark() {
return endCompoundMark; return endCompoundMark;
} }
public void setEndCompoundMark(Marker endCompoundMark) {
this.endCompoundMark = endCompoundMark;
}
/** /**
* Calculates the distance that the legs are in nautical miles (1.852 km). * Calculates the distance of the leg, in nautical miles.
*/ */
public void calculateDistance() { public void calculateLegDistance() {
GeodeticCalculator calc = new GeodeticCalculator(); //Gets the start and end coordinates.
//Load start and end of leg
GPSCoordinate startMarker = this.startCompoundMark.getAverageGPSCoordinate(); GPSCoordinate startMarker = this.startCompoundMark.getAverageGPSCoordinate();
GPSCoordinate endMarker = this.endCompoundMark.getAverageGPSCoordinate(); GPSCoordinate endMarker = this.endCompoundMark.getAverageGPSCoordinate();
calc.setStartingGeographicPoint(startMarker.getLongitude(), startMarker.getLatitude());
calc.setDestinationGeographicPoint(endMarker.getLongitude(), endMarker.getLatitude()); //Calculates the distance between markers.
this.distance = calc.getOrthodromicDistance() / Constants.NMToMetersConversion; double distanceNauticalMiles = GPSCoordinate.calculateDistanceNauticalMiles(startMarker, endMarker);
this.distanceNauticalMiles = distanceNauticalMiles;
} }

@ -1,28 +1,64 @@
package seng302.Model; package seng302.Model;
/** /**
* Created by cbt24 on 10/05/17. * Represents an individual mark.
* Has a source ID, name, and position.
*/ */
public class Mark { public class Mark {
/**
* The source ID of the mark.
*/
private int sourceID; private int sourceID;
/**
* The name of the mark.
*/
private String name; private String name;
/**
* The position of the mark.
*/
private GPSCoordinate position; private GPSCoordinate position;
/**
* Constructs a mark with a given source ID, name, and position.
* @param sourceID The source ID of the mark.
* @param name The name of the mark.
* @param position The position of the mark.
*/
public Mark(int sourceID, String name, GPSCoordinate position) { public Mark(int sourceID, String name, GPSCoordinate position) {
this.sourceID = sourceID; this.sourceID = sourceID;
this.name = name; this.name = name;
this.position = position; this.position = position;
} }
/**
* Returns the name of the mark.
* @return The name of the mark.
*/
public String getName() { public String getName() {
return name; return name;
} }
/**
* Returns the source ID of the mark.
* @return The source ID of the mark.
*/
public int getSourceID() { public int getSourceID() {
return sourceID; return sourceID;
} }
/**
* Returns the position of the mark.
* @return The position of the mark.
*/
public GPSCoordinate getPosition() { public GPSCoordinate getPosition() {
return position; return position;
} }
} }

@ -1,74 +0,0 @@
package seng302.Model;
import org.geotools.referencing.GeodeticCalculator;
import java.awt.geom.Point2D;
/**
* Created by esa46 on 29/03/17.
*/
public class Marker {
private GPSCoordinate averageGPSCoordinate;
private GPSCoordinate mark1;
private GPSCoordinate mark2;
private String name;
private boolean doubleMarker = false;
public Marker(GPSCoordinate mark1) {
this.mark1 = mark1;
this.mark2 = mark1;
this.averageGPSCoordinate = calculateAverage();
}
public Marker(GPSCoordinate mark1, GPSCoordinate mark2) {
this.mark1 = mark1;
this.mark2 = mark2;
this.averageGPSCoordinate = calculateAverage();
}
public Marker(String name, GPSCoordinate mark1, GPSCoordinate mark2) {
this.name = name;
this.mark1 = mark1;
this.mark2 = mark2;
this.averageGPSCoordinate = calculateAverage();
}
public GPSCoordinate getMark1() {
return mark1;
}
public GPSCoordinate getMark2() {
return mark2;
}
public GPSCoordinate getAverageGPSCoordinate() {
return averageGPSCoordinate;
}
public String getName() {
return name;
}
private GPSCoordinate calculateAverage() {
GeodeticCalculator calc = new GeodeticCalculator();
calc.setStartingGeographicPoint(mark1.getLongitude(), mark1.getLatitude());
calc.setDestinationGeographicPoint(mark2.getLongitude(), mark2.getLatitude());
double azimuth = calc.getAzimuth();
double distance = calc.getOrthodromicDistance();
GeodeticCalculator middleCalc = new GeodeticCalculator();
middleCalc.setStartingGeographicPoint(mark1.getLongitude(), mark1.getLatitude());
middleCalc.setDirection(azimuth, distance / 2);
Point2D middlePoint = middleCalc.getDestinationGeographicPoint();
return new GPSCoordinate(middlePoint.getY(), middlePoint.getX());
}
}

@ -0,0 +1,394 @@
package seng302.Model;
import javafx.util.Pair;
import java.util.*;
/**
* Created by hba56 on 10/05/17.
*/
/**
* Encapsulates an entire polar table. Has a function to calculate VMG.
*/
public class Polars {
/**
* Internal store of data. Maps {@literal Pair<windSpeed, windAngle>} to boatSpeed.
*/
private Map<Pair<Double, Bearing>, Double> polarValues = new HashMap<>();
/**
* Stores a list of angles from the polar table - this is used during the calculateVMG function.
* Maps between windSpeed and a list of angles for that wind speed.
*/
private HashMap<Double, List<Bearing>> polarAngles = new HashMap<>();
/**
* Ctor.
*/
public Polars() {
}
/**
* Adds an estimated velocity to the polar table object, for a given (windSpeed, windAngle) pair. That is, stores a mapping from (windSpeed, windAngle) to (boatVelocity).
* Note: an estimate means given a specific wind speed of trueWindSpeed, if the boat travels relativeWindAngle degrees towards the wind, it will move at boatSpeed knots. E.g., trueWindSpeed = 20kn, relativeWindAngle = 45 degrees, boatSpeed = 25kn. If the boat travels towards the wind, plus or minus 45 degrees either side, it will move at 25kn.
* @param trueWindSpeed The true wind speed of the estimate.
* @param relativeWindAngle The relative wind angle between the wind direction + 180 degrees and the boat's direction of the estimate.
* @param boatSpeed The boat speed of the estimate.
*/
public void addEstimate(double trueWindSpeed, Bearing relativeWindAngle, double boatSpeed) {
//We also add the same values with a complementary angle (e.g., angle = 50, complement = 360 - 50 = 310). This is because the data file contains angles [0, 180), but we need [0, 360).
//Create the array to store angles for this wind speed if it doesn't exist.
if (!this.polarAngles.containsKey(trueWindSpeed)) {
this.polarAngles.put(trueWindSpeed, new ArrayList<>());
}
//Add estimate to map.
Pair<Double, Bearing> newKeyPositive = new Pair<>(trueWindSpeed, relativeWindAngle);
this.polarValues.put(newKeyPositive, boatSpeed);
//Get the "negative" bearing - that is, the equivalent bearing between [180, 360).
Bearing negativeBearing = Bearing.fromDegrees(360d - relativeWindAngle.degrees());
//Ensure that the positive and negative angles aren't the same (e.g., pos = 0, neg = 360 - 0 = 0.
if (!negativeBearing.equals(relativeWindAngle)) {
Pair<Double, Bearing> newKeyNegative = new Pair<>(trueWindSpeed, negativeBearing);
this.polarValues.put(newKeyNegative, boatSpeed);
}
//Add angle to angle list. Don't add if it already contains them.
if (!this.polarAngles.get(trueWindSpeed).contains(relativeWindAngle)) {
this.polarAngles.get(trueWindSpeed).add(relativeWindAngle);
}
if (!this.polarAngles.get(trueWindSpeed).contains(negativeBearing)) {
this.polarAngles.get(trueWindSpeed).add(negativeBearing);
}
}
/**
* Calculates the VMG for a given wind angle, wind speed, and angle to destination. Will only return VMGs that have a true bearing (angle) within a given bound - this is to ensure that you can calculate VMGs without going out of bounds.
* <br>
* If you don't care about bearing bounds, simply pass in lower = 0, upper = 359.9.
* <br>
* Passing in lower = 0, upper = 0, or lower = 0, upper = 360 will both be treated the same as lower = 0, upper = 359.99999.
* <br><br>
* The resulting angle of the VMG will be within the interval [bearingLowerBound, bearingUpperBound].
* <br><br>
* If the lower bound is greater than the upper bound (e.g., lower = 70, upper = 55), then it checks that {@literal VMGAngle >= lower OR VMGAngle <= upper} (e.g., {@literal [70, 55] means angle >= 70, OR angle =< 55}).
* <br><br>
* Returns a VMG with 0 speed and 0 bearing if there are no VMGs with {@literal velocity > 0} in the acceptable bearing bounds.
* @param trueWindAngle The current true wind angle.
* @param trueWindSpeed The current true wind speed. Knots.
* @param destinationAngle The angle between the boat and the destination point.
* @param bearingLowerBound The lowest bearing (angle) that the boat may travel on.
* @param bearingUpperBound The highest bearing (angle) that the boat may travel on.
* @return The VMG.
*/
public VMG calculateVMG(Bearing trueWindAngle, double trueWindSpeed, Bearing destinationAngle, Bearing bearingLowerBound, Bearing bearingUpperBound) {
//Sorts polar angles.
for (List<Bearing> angles : this.polarAngles.values()) {
angles.sort(null);
}
//If the user enters [0, 360] for their bounds, there won't be any accepted angles, as Bearing(360) turn into Bearing(0) (it has the interval [0, 360)).
//So if both bearing bounds are zero, we assume that the user wanted [0, 360) for the interval.
//So, we give them Bearing(359.99999) as the upper bound.
if ((bearingLowerBound.degrees() == 0d) && (bearingUpperBound.degrees() == 0d)) {
bearingUpperBound = Bearing.fromDegrees(359.99999d);
}
//If the lower bound is greater than the upper bound, we have a "flipped" interval. That is for, e.g., [70, 55] the lower bound is greater than the upper bound, and so it checks that (VMGAngle >= 70 OR VMGAngle =< 55), instead of (VMGAngle >= 70 AND VMGAngle =< 55).
boolean flippedInterval = false;
if (bearingLowerBound.degrees() > bearingUpperBound.degrees()) {
flippedInterval = true;
}
//We need to find the upper and lower wind speeds from the Polars table, for a given current wind speed (e.g., current wind speed is 11kn, therefore lower = 8kn, upper = 12kn).
double polarWindSpeedLowerBound = 0d;
double polarWindSpeedUpperBound = 9999999d;//Start this off with a value larger than any in the Polars table so that it actually works.
//This indicates whether or not we've managed to find a wind speed larger than the current wind speed (the upper bound) in the Polars table (in cases where the current wind speed is larger than any in the file we will never find an upper bound).
boolean foundUpperBoundWindSpeed = false;
boolean foundLowerBoundWindSpeed = false;
for (Pair<Double, Bearing> key : this.polarValues.keySet()) {
//The key is Pair<windSpeed, windAngle>, so pair.key is windSpeed.
double currentPolarSpeed = key.getKey();
//Lower bound.
if ((currentPolarSpeed >= polarWindSpeedLowerBound) && (currentPolarSpeed <= trueWindSpeed)) {
polarWindSpeedLowerBound = currentPolarSpeed;
foundLowerBoundWindSpeed = true;
}
//Upper bound.
if ((currentPolarSpeed < polarWindSpeedUpperBound) && (currentPolarSpeed > trueWindSpeed)) {
polarWindSpeedUpperBound = currentPolarSpeed;
foundUpperBoundWindSpeed = true;
}
}
//Find the angle with the best VMG.
//We need to find the VMGs for both lower and upper bound wind speeds, and interpolate between them.
List<VMG> vmgs = new ArrayList<>();
//Put wind speed bounds we found above into a list.
List<Double> windSpeedBounds = new ArrayList<>(2);
if (foundLowerBoundWindSpeed) {
windSpeedBounds.add(polarWindSpeedLowerBound);
}
if (foundUpperBoundWindSpeed) {
windSpeedBounds.add(polarWindSpeedUpperBound);
}
//Calculate VMG for any wind speed bounds we found.
for (double polarWindSpeed : windSpeedBounds) {
//The list of polar angles for this wind speed.
List<Bearing> polarAngles = this.polarAngles.get(polarWindSpeed);
double bestVMGVelocity = 0;
double bestVMGSpeed = 0;
Bearing bestVMGAngle = Bearing.fromDegrees(0d);
//Calculate the VMG for all possible angles at this wind speed.
for (double angleDegree = 0; angleDegree < 360; angleDegree += 0.1) {
Bearing angle = Bearing.fromDegrees(angleDegree);
//This is the true bearing of the boat, if it went at the angle against the wind.
//For angle < 90 OR angle > 270, it means that the boat is going into the wind (tacking).
//For angle > 90 AND angle < 270, it means that the boat is actually going with the wind (gybing).
double trueBoatBearingDegrees = trueWindAngle.degrees() + angle.degrees() + 180d;
Bearing trueBoatBearing = Bearing.fromDegrees(trueBoatBearingDegrees);
//Check that the boat's bearing would actually be acceptable.
//We continue (skip to next iteration) if it is outside of the interval.
if (flippedInterval) {
//Bearing must be inside [lower, upper], where lower > upper. So, bearing must be >= lower, or bearing < upper. We use inverted logic since we are skipping if it is true.
if ((trueBoatBearing.degrees() < bearingLowerBound.degrees()) & (trueBoatBearing.degrees() > bearingUpperBound.degrees())) {
continue;
}
} else {
//Bearing must be inside [lower, upper].
if ((trueBoatBearing.degrees() < bearingLowerBound.degrees()) || (trueBoatBearing.degrees() > bearingUpperBound.degrees())) {
continue;
}
}
//Basic linear interpolation. Find the nearest two angles from the table, and interpolate between them.
//Check which pair of adjacent angles the angle is between.
boolean foundAdjacentAngles = false;
Bearing lowerBound = Bearing.fromDegrees(0d);
Bearing upperBound = Bearing.fromDegrees(0d);
for (int i = 0; i < polarAngles.size() - 1; i++) {
Bearing currentAngle = polarAngles.get(i);
Bearing nextAngle = polarAngles.get(i + 1);
//Check that angle is in interval [lower, upper).
if ((angle.degrees() >= currentAngle.degrees()) && (angle.degrees() < nextAngle.degrees())) {
foundAdjacentAngles = true;
lowerBound = currentAngle;
upperBound = nextAngle;
break;
}
}
if (!foundAdjacentAngles) {
//If we never found the interval, then it must be the "last" interval, between the i'th and 0'th values - angles are periodic, so they wrap around.
lowerBound = polarAngles.get(polarAngles.size() - 1);
upperBound = polarAngles.get(0);
}
//Calculate how far between those points the angle is.
//This is how far between the lower and upper bounds the angle is, as a proportion (e.g., 0.5 = half-way, 0.9 = close to upper).
double interpolationScalar = calculatePeriodicLinearInterpolateScalar(lowerBound.degrees(), upperBound.degrees(), 360, angle.degrees());
//Get the estimated boat speeds for the lower and upper angles.
Pair<Double, Bearing> lowerKey = new Pair<>(polarWindSpeed, lowerBound);
Pair<Double, Bearing> upperKey = new Pair<>(polarWindSpeed, upperBound);
double lowerSpeed = this.polarValues.get(lowerKey);
double upperSpeed = this.polarValues.get(upperKey);
//Calculate the speed at the interpolated angle.
double interpolatedSpeed = calculateLinearInterpolation(lowerSpeed, upperSpeed, interpolationScalar);
//This is the delta angle between the boat's true bearing and the destination.
double angleBetweenDestAndTackDegrees = trueBoatBearing.degrees() - destinationAngle.degrees();
Bearing angleBetweenDestAndTack = Bearing.fromDegrees(angleBetweenDestAndTackDegrees);
//This is the estimated velocity towards the target (e.g., angling away from the target reduces velocity).
double interpolatedVelocity = Math.cos(angleBetweenDestAndTack.radians()) * interpolatedSpeed;
//Check that the velocity is better, if so, update our best VMG so far, for this wind speed.
if (interpolatedVelocity > bestVMGVelocity) {
bestVMGVelocity = interpolatedVelocity;
bestVMGSpeed = interpolatedSpeed;
bestVMGAngle = trueBoatBearing;
}
}
//Angle iteration loop is finished.
//Create the VMG, and add to list.
VMG vmg = new VMG(bestVMGSpeed, bestVMGAngle);
vmgs.add(vmg);
}
//If we never found an upper bound for the wind speed, we will only have one VMG (for the lower bound), so we can't interpolate/extrapolate anything.
if (!foundUpperBoundWindSpeed) {
return vmgs.get(0);
} else {
//We may have more than one VMG. If we found an upper and lower bound we will have two, if we only found an upper bound (e.g., wind speed = 2kn, upper = 4kn, lower = n/a) we will only have one VMG, but must interpolate between that and a new VMG with 0kn speed.
//We do a simple linear interpolation.
VMG vmg1 = vmgs.get(0);
VMG vmg2;
if (vmgs.size() > 1) {
//If we have a second VMG use it.
vmg2 = vmgs.get(1);
} else {
//Otherwise create a VMG with zero speed, but the same angle. This is what our VMG would be with 0 knot wind speed (boats don't move at 0 knots).
//We also need to swap them around, as vmg1 needs to be the vmg for the lower bound wind speed, and vmg2 is the upper bound wind speed.
vmg2 = vmg1;
vmg1 = new VMG(0, vmg1.getBearing());
}
//Get the interpolation scalar for the current wind speed.
double interpolationScalar = calculateLinearInterpolateScalar(polarWindSpeedLowerBound, polarWindSpeedUpperBound, trueWindSpeed);
//We then calculate the interpolated VMG speed and angle using the interpolation scalar.
double interpolatedSpeed = calculateLinearInterpolation(vmg1.getSpeed(), vmg2.getSpeed(), interpolationScalar);
double interpolatedAngleDegrees = calculateLinearInterpolation(vmg1.getBearing().degrees(), vmg2.getBearing().degrees(), interpolationScalar);
Bearing interpolatedAngle = Bearing.fromDegrees(interpolatedAngleDegrees);
//Return the interpolated VMG.
return new VMG(interpolatedSpeed, interpolatedAngle);
}
}
/**
* Calculate the linear interpolation scalar for a value between two bounds. E.g., lower = 7, upper = 10, value = 8, therefore the scalar (or the proportion between the bounds) is 0.333.
* Also assumes that the bounds are periodic - e.g., for angles a lower bound of 350deg and upper bound of 5deg is in interval of 15 degrees.
* @param lowerBound The lower bound to interpolate between.
* @param upperBound The upper bound to interpolate between.
* @param value The value that sits between the lower and upper bounds.
* @param period The period of the bounds (e.g., for angles, they have a period of 360 degrees).
* @return The interpolation scalar for the value between two bounds.
*/
public static double calculatePeriodicLinearInterpolateScalar(double lowerBound, double upperBound, double period, double value) {
//This is the "distance" between the value and its lower bound.
//I.e., L----V-----------U
// <----> is lowerDelta.
double lowerDelta = value - lowerBound;
//This is the "distance" between the upper and lower bound.
//I.e., L----V-----------U
// <----------------> is intervalDelta.
//This can potentially be negative if we have, e.g., lower = 340deg, upper = 0deg, delta = -340deg.
double intervalDelta = upperBound - lowerBound;
//If it _is_ negative, modulo it to make it positive.
//E.g., -340deg = +20deg.
while (intervalDelta < 0) {
intervalDelta += period;
}
//This is how far between the lower and upper bounds the value is, as a proportion (e.g., 0.5 = half-way, 0.9 = close to upper).
double interpolationScalar = lowerDelta / intervalDelta;
return interpolationScalar;
}
/**
* Calculate the linear interpolation scalar for a value between two bounds. E.g., lower = 7, upper = 10, value = 8, therefore the scalar (or the proportion between the bounds) is 0.333.
* Assumes that the upper bound is larger than the lower bound.
* @param lowerBound The lower bound to interpolate between.
* @param upperBound The upper bound to interpolate between.
* @param value The value that sits between the lower and upper bounds.
* @return The interpolation scalar for the value between two bounds.
*/
public static double calculateLinearInterpolateScalar(double lowerBound, double upperBound, double value) {
//This is the "distance" between the value and its lower bound.
//I.e., L----V-----------U
// <----> is lowerDelta.
double lowerDelta = value - lowerBound;
//This is the "distance" between the upper and lower bound.
//I.e., L----V-----------U
// <----------------> is intervalDelta.
double intervalDelta = upperBound - lowerBound;
//This is how far between the lower and upper bounds the value is, as a proportion (e.g., 0.5 = half-way, 0.9 = close to upper).
double interpolationScalar = lowerDelta / intervalDelta;
return interpolationScalar;
}
/**
* Does a linear interpolation between two bounds, using an interpolation scalar - i.e., value = lower + (scalar * delta).
* @param lowerBound Lower bound to interpolate from.
* @param upperBound Upper bound to interpolate to.
* @param interpolationScalar Interpolation scalar - the proportion the target value sits between the two bounds.
* @return The interpolated value.
*/
public static double calculateLinearInterpolation(double lowerBound, double upperBound, double interpolationScalar) {
//Get the delta between upper and lower bounds.
double boundDelta = upperBound - lowerBound;
//Calculate the speed at the interpolated angle.
double interpolatedValue = lowerBound + (boundDelta * interpolationScalar);
return interpolatedValue;
}
}

@ -3,45 +3,137 @@ package seng302.Model;
import javafx.animation.AnimationTimer; import javafx.animation.AnimationTimer;
import javafx.collections.FXCollections; import javafx.collections.FXCollections;
import javafx.collections.ObservableList; import javafx.collections.ObservableList;
import org.geotools.referencing.GeodeticCalculator;
import seng302.Constants; import seng302.Constants;
import seng302.DataInput.RaceDataSource; import seng302.DataInput.RaceDataSource;
import seng302.MockOutput; import seng302.MockOutput;
import seng302.Networking.Messages.BoatLocation;
import seng302.Networking.Messages.BoatStatus; import seng302.Networking.Messages.BoatStatus;
import seng302.Networking.Messages.Enums.BoatStatusEnum; import seng302.Networking.Messages.Enums.BoatStatusEnum;
import seng302.Networking.Messages.Enums.RaceStatusEnum;
import seng302.Networking.Messages.Enums.RaceTypeEnum;
import seng302.Networking.Messages.RaceStatus; import seng302.Networking.Messages.RaceStatus;
import java.awt.geom.Point2D;
import java.io.*;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Iterator;
import java.util.List; import java.util.List;
import java.util.Random; import java.util.Random;
/** /**
* Parent class for races * Represents a yacht race.
* Created by fwy13 on 3/03/17. * Has a course, boats, boundaries, etc...
* Is responsible for simulating the race, and sending messages to a MockOutput instance.
*/ */
public class Race implements Runnable { public class Race implements Runnable {
protected ObservableList<Boat> startingBoats; /**
protected ObservableList<CompoundMark> compoundMarks; * An observable list of boats in the race.
protected List<Leg> legs; */
protected int boatsFinished = 0; private ObservableList<Boat> boats;
protected long totalTimeElapsed;
protected int scaleFactor = 3; /**
* An observable list of compound marks in the race.
*/
private ObservableList<CompoundMark> compoundMarks;
/**
* A list of legs in the race.
*/
private List<Leg> legs;
/**
* A list of coordinates describing the boundary of the course.
*/
private List<GPSCoordinate> boundary;
/**
* The elapsed time, in milliseconds, of the race.
*/
private long totalTimeElapsed;
/**
* The starting timestamp, in milliseconds, of the race.
*/
private long startTime; private long startTime;
/**
* The scale factor of the race.
* Frame periods are multiplied by this to get the amount of time a single frame represents.
* E.g., frame period = 20ms, scale = 5, frame represents 20 * 5 = 100ms, and so boats are simulated for 100ms, even though only 20ms actually occurred.
*/
private int scaleFactor = 5;
/**
* The race ID of the course.
*/
private int raceId; private int raceId;
private int dnfChance = 0; //percentage chance a boat fails at each checkpoint
/**
* The current status of the race.
*/
private RaceStatusEnum raceStatusEnum;
/**
* The type of race this is.
*/
private RaceTypeEnum raceType;
/**
* The percent chance that a boat fails the race, and enters a DNF state, at each checkpoint.
* 0 = 0%, 100 = 100%.
*/
private int dnfChance = 0;
/**
* The mockOutput to send messages to.
*/
private MockOutput mockOutput; private MockOutput mockOutput;
/**
* Wind direction bearing.
*/
private Bearing windDirection;
/**
* Wind speed (knots).
* Convert this to millimeters per second before passing to RaceStatus.
*/
private double windSpeed;
/**
* Constructs a race object with a given RaceDataSource and sends events to the given mockOutput.
* @param raceData Data source for race related data (boats, legs, etc...).
* @param mockOutput The mockOutput to send events to.
*/
public Race(RaceDataSource raceData, MockOutput mockOutput) { public Race(RaceDataSource raceData, MockOutput mockOutput) {
this.startingBoats = FXCollections.observableArrayList(raceData.getBoats());
this.legs = raceData.getLegs(); this.mockOutput = mockOutput;
this.boats = FXCollections.observableArrayList(raceData.getBoats());
this.compoundMarks = FXCollections.observableArrayList(raceData.getCompoundMarks()); this.compoundMarks = FXCollections.observableArrayList(raceData.getCompoundMarks());
this.boundary = raceData.getBoundary();
this.legs = raceData.getLegs();
this.legs.add(new Leg("Finish", this.legs.size())); this.legs.add(new Leg("Finish", this.legs.size()));
this.raceId = raceData.getRaceId(); this.raceId = raceData.getRaceId();
this.mockOutput = mockOutput;
this.startTime = System.currentTimeMillis() + (Constants.PRE_RACE_WAIT_TIME / this.scaleFactor); //The start time is current time + 4 minutes, scaled. prestart is 3 minutes, and we add another.
this.startTime = System.currentTimeMillis() + ((Constants.RacePreStartTime + (1 * 1000)) / this.scaleFactor);
this.setRaceStatusEnum(RaceStatusEnum.NOT_ACTIVE);
this.raceType = RaceTypeEnum.FLEET_RACE;
this.windSpeed = 12;
this.windDirection = Bearing.fromDegrees(180);
} }
/** /**
@ -53,218 +145,613 @@ public class Race implements Runnable {
} }
/** /**
* Parse the marker boats through mock output * Parse the compound marker boats through mock output.
*/ */
public void parseMarks() { private void parseMarks() {
for (CompoundMark mark : compoundMarks){ for (CompoundMark compoundMark : this.compoundMarks) {
mockOutput.parseBoatLocation(mark.getMark1Source().getSourceID(), mark.getMark1().getLatitude(), mark.getMark1().getLongitude(),0,0);
if (mark.getMark2Source()!=null){ //Get the individual marks from the compound mark.
mockOutput.parseBoatLocation(mark.getMark2Source().getSourceID(), mark.getMark2().getLatitude(), mark.getMark2().getLongitude(),0,0); Mark mark1 = compoundMark.getMark1();
Mark mark2 = compoundMark.getMark2();
//If they aren't null, parse them (some compound marks only have one mark).
if (mark1 != null) {
this.parseIndividualMark(mark1);
} }
if (mark2 != null) {
this.parseIndividualMark(mark2);
} }
} }
}
/**
* Parses an individual marker boat, and sends it to mockOutput.
* @param mark The marker boat to parse.
*/
private void parseIndividualMark(Mark mark) {
this.mockOutput.parseBoatLocation(mark.getSourceID(), mark.getPosition().getLatitude(), mark.getPosition().getLongitude(),0,0);
}
/** /**
* Countdown timer until race starts. * Parse the boats in the race, and send it to mockOutput.
*/
private void parseBoatLocations() {
//Parse each boat.
for (Boat boat : this.boats) {
this.parseIndividualBoatLocation(boat);
}
}
/**
* Parses an individual boat, and sends it to mockOutput.
* @param boat The boat to parse.
*/
private void parseIndividualBoatLocation(Boat boat) {
this.mockOutput.parseBoatLocation(
boat.getSourceID(),
boat.getCurrentPosition().getLatitude(),
boat.getCurrentPosition().getLongitude(),
boat.getBearing().degrees(),
boat.getCurrentSpeed()
);
}
/**
* Updates the race status enumeration based on the current time, in milliseconds.
* @param currentTime The current time, in milliseconds.
*/
private void updateRaceStatusEnum(long currentTime) {
//The amount of milliseconds until the race starts.
long timeToStart = this.startTime - currentTime;
//Scale the time to start based on the scale factor.
long timeToStartScaled = timeToStart / this.scaleFactor;
if (timeToStartScaled > Constants.RacePreStartTime) {
//Time > 3 minutes is the prestart period.
this.setRaceStatusEnum(RaceStatusEnum.PRESTART);
} else if ((timeToStartScaled <= Constants.RacePreStartTime) && (timeToStartScaled >= Constants.RacePreparatoryTime)) {
//Time between [1, 3] minutes is the warning period.
this.setRaceStatusEnum(RaceStatusEnum.WARNING);
} else if ((timeToStartScaled <= Constants.RacePreparatoryTime) && (timeToStartScaled > 0)) {
//Time between (0, 1] minutes is the preparatory period.
this.setRaceStatusEnum(RaceStatusEnum.PREPARATORY);
} else {
//Otherwise, the race has started!
this.setRaceStatusEnum(RaceStatusEnum.STARTED);
}
}
/**
* Parses the race status, and sends it to mockOutput.
*/ */
private void parseRaceStatus() {
//A race status message contains a list of boat statuses.
List<BoatStatus> boatStatuses = new ArrayList<>();
//Add each boat status to the status list.
for (Boat boat : boats) {
BoatStatus boatStatus = new BoatStatus(boat.getSourceID(), boat.getStatus(), boat.getCurrentLeg().getLegNumber());
boatStatuses.add(boatStatus);
}
//TODO REFACTOR for consistency, could send parameters to mockOutput instead of the whole racestatus. This will also fix the sequence number issue.
//Convert wind direction and speed to ints. //TODO this conversion should be done inside the racestatus class.
int windDirectionInt = BoatLocation.convertHeadingDoubleToInt(this.windDirection.degrees());
int windSpeedInt = (int) (windSpeed * Constants.KnotsToMMPerSecond);
//Create race status object, and send it.
RaceStatus raceStatus = new RaceStatus(System.currentTimeMillis(), this.raceId, this.getRaceStatusEnum().getValue(), this.startTime, windDirectionInt, windSpeedInt, this.getRaceType().getValue(), boatStatuses);
mockOutput.parseRaceStatus(raceStatus);
}
/**
* Sets the status of all boats in the race to RACING.
*/
private void setBoatsStatusToRacing() {
for (Boat boat : this.boats) {
boat.setStatus(BoatStatusEnum.RACING);
}
}
/**
* Countdown timer until race starts.
*/
protected AnimationTimer countdownTimer = new AnimationTimer() { protected AnimationTimer countdownTimer = new AnimationTimer() {
long currentTime = System.currentTimeMillis(); long currentTime = System.currentTimeMillis();
long timeLeft;
@Override @Override
public void handle(long arg0) { public void handle(long arg0) {
timeLeft = startTime - currentTime;
if (timeLeft <= 0) { //Update the race status based on the current time.
updateRaceStatusEnum(this.currentTime);
//Parse the boat locations.
parseBoatLocations();
//Parse the marks.
parseMarks();
//Parse the race status.
parseRaceStatus();
if (getRaceStatusEnum() == RaceStatusEnum.STARTED) {
System.setProperty("javafx.animation.fullspeed", "true"); System.setProperty("javafx.animation.fullspeed", "true");
setBoatsStatusToRacing();
raceTimer.start(); raceTimer.start();
stop(); this.stop();
}
ArrayList<BoatStatus> boatStatuses = new ArrayList<>();
for (Boat boat : startingBoats) {
mockOutput.parseBoatLocation(boat.getSourceID(), boat.getCurrentPosition().getLatitude(),
boat.getCurrentPosition().getLongitude(), boat.getHeading(), 0);
boatStatuses.add(new BoatStatus(boat.getSourceID(), BoatStatusEnum.PRESTART, 0));
} }
parseMarks();
int raceStatusNumber = timeLeft <= 60000 / scaleFactor && timeLeft > 0? 2 : 1;
RaceStatus raceStatus = new RaceStatus(System.currentTimeMillis(), raceId, raceStatusNumber, startTime, 0, 2300, 1, boatStatuses);
mockOutput.parseRaceStatus(raceStatus);
//Update the animations timer's time.
currentTime = System.currentTimeMillis(); currentTime = System.currentTimeMillis();
} }
}; };
/**
* Timer that runs for the duration of the race, until all boats finish.
*/
private AnimationTimer raceTimer = new AnimationTimer() { private AnimationTimer raceTimer = new AnimationTimer() {
//Start time of loop.
/**
* Start time of loop, in milliseconds.
*/
long timeRaceStarted = System.currentTimeMillis(); long timeRaceStarted = System.currentTimeMillis();
int boatOffset = 0;
/**
* The time of the previous frame, in milliseconds.
*/
long lastFrameTime = timeRaceStarted;
@Override @Override
public void handle(long arg0) { public void handle(long arg0) {
if (boatsFinished < startingBoats.size()) {
//Get the current time. //Get the current time.
long currentTime = System.currentTimeMillis(); long currentTime = System.currentTimeMillis();
//Update the total elapsed time. //Update the total elapsed time.
totalTimeElapsed = currentTime - timeRaceStarted; totalTimeElapsed = currentTime - this.timeRaceStarted;
ArrayList<BoatStatus> boatStatuses = new ArrayList<>();
//As long as there is at least one boat racing, we still simulate the race.
if (getNumberOfActiveBoats() != 0) {
//Get the time period of this frame.
long framePeriod = currentTime - lastFrameTime;
//We actually simulate 20ms istead of the amount of time that has occurred, as that ensure that we don't end up with large frame periods on slow computers, causing position issues.
framePeriod = 20;
//For each boat, we update its position, and generate a BoatLocationMessage. //For each boat, we update its position, and generate a BoatLocationMessage.
for (int i = 0; i < startingBoats.size(); i++) { for (Boat boat : boats) {
Boat boat = startingBoats.get((i + boatOffset) % startingBoats.size());
if (boat != null) { //If it is still racing, update its position.
//Update position. if (boat.getStatus() == BoatStatusEnum.RACING) {
if (boat.getTimeFinished() < 0) {
updatePosition(boat, 15); updatePosition(boat, framePeriod, totalTimeElapsed);
checkPosition(boat, totalTimeElapsed);
}
if (boat.getTimeFinished() > 0) {
mockOutput.parseBoatLocation(boat.getSourceID(), boat.getCurrentPosition().getLatitude(), boat.getCurrentPosition().getLongitude(), boat.getHeading(), boat.getVelocity());
boatStatuses.add(new BoatStatus(boat.getSourceID(), BoatStatusEnum.FINISHED, boat.getCurrentLeg().getLegNumber()));
} else {
mockOutput.parseBoatLocation(boat.getSourceID(), boat.getCurrentPosition().getLatitude(), boat.getCurrentPosition().getLongitude(), boat.getHeading(), boat.getVelocity());
boatStatuses.add(new BoatStatus(boat.getSourceID(),
boat.getCurrentLeg().getLegNumber() >= 0 ? BoatStatusEnum.RACING : BoatStatusEnum.DNF, boat.getCurrentLeg().getLegNumber()));
} }
} else {
stop();
} }
} else {
//Otherwise, the race is over!
setRaceStatusEnum(RaceStatusEnum.FINISHED);
this.stop();
} }
//Parse the boat locations.
parseBoatLocations();
//Parse the marks.
parseMarks(); parseMarks();
boatOffset = (boatOffset + 1) % (startingBoats.size());
RaceStatus raceStatus = new RaceStatus(System.currentTimeMillis(), raceId, 3, startTime, 0, 2300, 2, boatStatuses); //Parse the race status.
mockOutput.parseRaceStatus(raceStatus); parseRaceStatus();
}
//Update the last frame time.
this.lastFrameTime = currentTime;
} }
}; };
/**
* Initialise the boats in the race.
* This sets their starting positions and current legs.
*/
public void initialiseBoats() { public void initialiseBoats() {
Leg officialStart = legs.get(0);
String name = officialStart.getName();
Marker endMark = officialStart.getEndCompoundMark();
ArrayList<GPSCoordinate> startingPositions = getSpreadStartingPositions();
for (int i = 0; i < startingBoats.size(); i++) { //Gets the starting positions of the boats.
Boat boat = startingBoats.get(i); List<GPSCoordinate> startingPositions = getSpreadStartingPositions();
if (boat != null) {
Leg newLeg = new Leg(name, new Marker(startingPositions.get(i)), endMark, 0); //Get iterators for our boat and position lists.
boat.setCurrentLeg(newLeg); Iterator<Boat> boatIt = this.boats.iterator();
boat.setVelocity(Constants.TEST_VELOCITIES[i]); Iterator<GPSCoordinate> startPositionIt = startingPositions.iterator();
boat.setScaledVelocity(boat.getVelocity() * scaleFactor);
boat.setCurrentPosition(startingPositions.get(i)); //Iterate over the pair of lists.
boat.setHeading(boat.calculateHeading()); while (boatIt.hasNext() && startPositionIt.hasNext()) {
}
//Get the next boat and position.
Boat boat = boatIt.next();
GPSCoordinate startPosition = startPositionIt.next();
//The boat starts on the first leg of the race.
boat.setCurrentLeg(this.legs.get(0));
//Boats start with 0 knots speed.
boat.setCurrentSpeed(0d);
//Place the boat at its starting position.
boat.setCurrentPosition(startPosition);
//Boats start facing their next marker.
boat.setBearing(boat.calculateBearingToNextMarker());
//Sets the boats status to prestart - it changes to racing when the race starts.
boat.setStatus(BoatStatusEnum.PRESTART);
//We set a large time since tack change so that it calculates a new VMG when the simulation starts.
boat.setTimeSinceTackChange(999999);
} }
} }
/** /**
* Creates a list of starting positions for the different boats, so they do not appear cramped at the start line * Creates a list of starting positions for the different boats, so they do not appear cramped at the start line.
* *
* @return list of starting positions * @return A list of starting positions.
*/ */
public ArrayList<GPSCoordinate> getSpreadStartingPositions() { public List<GPSCoordinate> getSpreadStartingPositions() {
//The first compound marker of the race - the starting gate.
CompoundMark compoundMark = this.legs.get(0).getStartCompoundMark();
//The position of the two markers from the compound marker.
GPSCoordinate mark1Position = compoundMark.getMark1Position();
GPSCoordinate mark2Position = compoundMark.getMark2Position();
//Calculates the azimuth between the two points.
Azimuth azimuth = GPSCoordinate.calculateAzimuth(mark1Position, mark2Position);
int nBoats = startingBoats.size(); //Calculates the distance between the two points.
Marker compoundMark = legs.get(0).getStartCompoundMark(); double distanceMeters = GPSCoordinate.calculateDistanceMeters(mark1Position, mark2Position);
GeodeticCalculator initialCalc = new GeodeticCalculator(); //The number of boats in the race.
initialCalc.setStartingGeographicPoint(compoundMark.getMark1().getLongitude(), compoundMark.getMark1().getLatitude()); int numberOfBoats = this.boats.size();
initialCalc.setDestinationGeographicPoint(compoundMark.getMark2().getLongitude(), compoundMark.getMark2().getLatitude());
double azimuth = initialCalc.getAzimuth(); //Calculates the distance between each boat. We divide by numberOfBoats + 1 to ensure that no boat is placed on one of the starting gate's marks.
double distanceBetweenMarkers = initialCalc.getOrthodromicDistance(); double distanceBetweenBoatsMeters = distanceMeters / (numberOfBoats + 1);
double distanceBetweenBoats = distanceBetweenMarkers / (nBoats + 1);
GeodeticCalculator positionCalc = new GeodeticCalculator();
positionCalc.setStartingGeographicPoint(compoundMark.getMark1().getLongitude(), compoundMark.getMark1().getLatitude());
ArrayList<GPSCoordinate> positions = new ArrayList<>();
for (int i = 0; i < nBoats; i++) { //List to store coordinates in.
positionCalc.setDirection(azimuth, distanceBetweenBoats); List<GPSCoordinate> positions = new ArrayList<>();
Point2D position = positionCalc.getDestinationGeographicPoint();
positions.add(new GPSCoordinate(position.getY(), position.getX()));
//We start spacing boats out from mark 1.
GPSCoordinate position = mark1Position;
//For each boat, displace position, and store it.
for (int i = 0; i < numberOfBoats; i++) {
position = GPSCoordinate.calculateNewPosition(position, distanceBetweenBoatsMeters, azimuth);
positions.add(position);
positionCalc = new GeodeticCalculator();
positionCalc.setStartingGeographicPoint(position);
} }
return positions; return positions;
} }
/** /**
* Calculates the boats next GPS position based on its distance travelled and heading * Calculates a boat's VMG.
* * @param boat The boat to calculate VMG for.
* @param oldCoordinates GPS coordinates of the boat's starting position * @param bearingBounds An array containing the lower and upper acceptable bearing bounds to keep the boat in the course.
* @param distanceTravelled distance in nautical miles * @return VMG for the specified boat.
* @param azimuth boat's current direction. Value between -180 and 180 */
* @return The boat's new coordinate private VMG calculateVMG(Boat boat, Bearing[] bearingBounds) {
//How fast a boat can turn, in degrees per millisecond.
double turnRate = 0.03;
//How much the boat is allowed to turn, considering how long since it last turned.
double turnAngle = turnRate * boat.getTimeSinceTackChange();
//This ensures that the boat bounds don't flip around.
turnAngle = Math.min(turnAngle, 179.999);
//Find the bounds on what angle the boat is allowed to travel at. The bounds cap out at [0, 360).
double bound1Degrees = boat.getBearing().degrees() - turnAngle;
double bound2Degrees = boat.getBearing().degrees() + turnAngle;
Bearing bound1 = Bearing.fromDegrees(bound1Degrees);
Bearing bound2 = Bearing.fromDegrees(bound2Degrees);
//Get the lower and upper acceptable bounds.
Bearing lowerAcceptableBound = bearingBounds[0];
Bearing upperAcceptableBound = bearingBounds[1];
//Find the bounds on what angle the boat can travel on, taking into account both turning rate and the acceptable bounds.
bound1Degrees = Math.max(bound1.degrees(), lowerAcceptableBound.degrees());
bound2Degrees = Math.min(bound2.degrees(), upperAcceptableBound.degrees());
bound1 = Bearing.fromDegrees(bound1Degrees);
bound2 = Bearing.fromDegrees(bound2Degrees);
//Calculate VMG using these bounds.
return boat.getPolars().calculateVMG(this.windDirection, this.windSpeed, boat.calculateBearingToNextMarker(), bound1, bound2);
}
/**
* Determines whether or not a given VMG improves the velocity of a boat.
* @param boat The boat to test.
* @param vmg The new VMG to test.
* @return True if the new VMG is improves velocity, false otherwise.
*/ */
public static GPSCoordinate calculatePosition(GPSCoordinate oldCoordinates, double distanceTravelled, double azimuth) { private boolean improvesVelocity(Boat boat, VMG vmg) {
//Calculates the angle between the boat and its destination.
Angle angleBetweenDestAndHeading = Angle.fromDegrees(boat.getBearing().degrees() - boat.calculateBearingToNextMarker().degrees());
//Calculates the angle between the new VMG and the boat's destination.
Angle angleBetweenDestAndNewVMG = Angle.fromDegrees(vmg.getBearing().degrees() - boat.calculateBearingToNextMarker().degrees());
//Calculate the boat's current velocity.
double currentVelocity = Math.cos(angleBetweenDestAndHeading.radians()) * boat.getCurrentSpeed();
//Find new coordinate using current heading and distance //Calculate the potential velocity with the new VMG.
GeodeticCalculator geodeticCalculator = new GeodeticCalculator(); double vmgVelocity = Math.cos(angleBetweenDestAndNewVMG.radians()) * vmg.getSpeed();
//Load start point into calculator
Point2D startPoint = new Point2D.Double(oldCoordinates.getLongitude(), oldCoordinates.getLatitude()); //Return whether or not the new VMG gives better velocity.
geodeticCalculator.setStartingGeographicPoint(startPoint); return vmgVelocity > currentVelocity;
//load direction and distance travelled into calculator
geodeticCalculator.setDirection(azimuth, distanceTravelled * Constants.NMToMetersConversion);
//get new point
Point2D endPoint = geodeticCalculator.getDestinationGeographicPoint();
return new GPSCoordinate(endPoint.getY(), endPoint.getX());
} }
/** /**
* Calculates the distance a boat has travelled and updates its current position according to this value. * Calculates the distance a boat has travelled and updates its current position according to this value.
* *
* @param boat to be updated * @param boat The boat to be updated.
* @param millisecondsElapsed since last update * @param updatePeriodMilliseconds The time, in milliseconds, since the last update.
* @param totalElapsedMilliseconds The total number of milliseconds that have elapsed since the start of the race.
*/ */
protected void updatePosition(Boat boat, int millisecondsElapsed) { protected void updatePosition(Boat boat, long updatePeriodMilliseconds, long totalElapsedMilliseconds) {
//distanceTravelled = velocity (nm p hr) * time taken to update loop //Checks if the current boat has finished the race or not.
double distanceTravelled = (boat.getScaledVelocity() * millisecondsElapsed) / 3600000; boolean finish = this.isLastLeg(boat.getCurrentLeg());
double totalDistanceTravelled = distanceTravelled + boat.getDistanceTravelledInLeg();
boolean finish = boat.getCurrentLeg().getName().equals("Finish");
if (!finish) { if (!finish) {
boat.setHeading(boat.calculateHeading());
//update boat's distance travelled
boat.setDistanceTravelledInLeg(totalDistanceTravelled); //Calculates the distance travelled, in meters, in the current timeslice.
//Calculate boat's new position by adding the distance travelled onto the start point of the leg double distanceTravelledMeters = boat.calculateMetersTravelled(updatePeriodMilliseconds);
boat.setCurrentPosition(calculatePosition(boat.getCurrentLeg().getStartCompoundMark().getAverageGPSCoordinate(),
totalDistanceTravelled, boat.calculateAzimuth())); //Scale it.
distanceTravelledMeters = distanceTravelledMeters * this.scaleFactor;
//Move the boat forwards that many meters, and advances its time counters by enough milliseconds.
boat.moveForwards(distanceTravelledMeters, updatePeriodMilliseconds * this.scaleFactor);
//Calculate the boat's bearing bounds, to ensure that it doesn't go out of the course.
Bearing[] bearingBounds = this.calculateBearingBounds(boat);
//Calculate the new VMG.
VMG newVMG = this.calculateVMG(boat, bearingBounds);
//If the new vmg improves velocity, use it.
if (improvesVelocity(boat, newVMG)) {
boat.setVMG(newVMG);
}
//Check the boats position (update leg and stuff).
this.checkPosition(boat, totalTimeElapsed);
}
}
/**
* Calculates the upper and lower bounds that the boat may have in order to not go outside of the course.
* @param boat The boat to check.
* @return An array of bearings. The first is the lower bound, the second is the upper bound.
*/
private Bearing[] calculateBearingBounds(Boat boat) {
Bearing[] bearings = new Bearing[2];
Bearing lowerBearing = Bearing.fromDegrees(0);
Bearing upperBearing = Bearing.fromDegrees(359.999);
boolean foundAnyBadBearing = false;
boolean foundLowerBearing = false;
//Check all bearings between [0, 360).
for (double angle = 0; angle < 360; angle += 1) {
//Create bearing from angle.
Bearing bearing = Bearing.fromDegrees(angle);
//Check that if it is acceptable.
boolean bearingIsGood = this.checkBearingInsideCourse(bearing, boat.getCurrentPosition());
if (bearingIsGood) {
//The lower bearing will be the first acceptable bearing after finding any unacceptable bearing.
if (foundAnyBadBearing && !foundLowerBearing) {
lowerBearing = bearing;
foundLowerBearing = true;
}
//The upper bearing will be the last acceptable bearing before finding any unacceptable bearing.
if (!foundAnyBadBearing) {
upperBearing = bearing;
}
} else {
foundAnyBadBearing = true;
}
}
bearings[0] = lowerBearing;
bearings[1] = upperBearing;
return bearings;
}
/**
* Checks if a given bearing, starting at a given position, would put a boat out of the course boundaries.
* @param bearing The bearing to check.
* @param position The position to start from.
*/
private boolean checkBearingInsideCourse(Bearing bearing, GPSCoordinate position) {
//Get azimuth from bearing.
Azimuth azimuth = Azimuth.fromBearing(bearing);
//Tests to see if a point in front of the boat is out of bounds.
double epsilonMeters = 100d;
GPSCoordinate testCoord = GPSCoordinate.calculateNewPosition(position, epsilonMeters, azimuth);
//If it isn't inside the boundary, calculate new bearing.
if (GPSCoordinate.isInsideBoundary(testCoord, this.boundary)) {
return true;
} else {
return false;
} }
} }
/**
* Checks if a boat has finished any legs, or has pulled out of race (DNF).
* @param boat The boat to check.
* @param timeElapsed The total time, in milliseconds, that has elapsed since the race started.
*/
protected void checkPosition(Boat boat, long timeElapsed) { protected void checkPosition(Boat boat, long timeElapsed) {
if (boat.getDistanceTravelledInLeg() > boat.getCurrentLeg().getDistance()) {
//boat has passed onto new leg
if (boat.getCurrentLeg().getName().equals("Finish")) { //The distance, in nautical miles, within which the boat needs to get in order to consider that it has reached the marker.
//boat has finished double epsilonNauticalMiles = 100.0 / Constants.NMToMetersConversion; //100 meters. TODO should be more like 5-10.
boatsFinished++;
boat.setTimeFinished(timeElapsed); if (boat.calculateDistanceToNextMarker() < epsilonNauticalMiles) {
//Boat has reached its target marker, and has moved on to a new leg.
//Calculate how much the boat overshot the marker by.
double overshootMeters = boat.calculateDistanceToNextMarker();
//Move boat on to next leg.
Leg nextLeg = this.legs.get(boat.getCurrentLeg().getLegNumber() + 1);
boat.setCurrentLeg(nextLeg);
//Add overshoot distance into the distance travelled for the next leg.
boat.setDistanceTravelledInLeg(overshootMeters);
//Setting a high value for this allows the boat to immediately do a large turn, as it needs to in order to get to the next mark.
boat.setTimeSinceTackChange(999999);
//Check if the boat has finished or stopped racing.
if (this.isLastLeg(boat.getCurrentLeg())) {
//Boat has finished.
boat.setTimeFinished(timeElapsed); boat.setTimeFinished(timeElapsed);
boat.setVelocity(0); boat.setCurrentSpeed(0);
boat.setScaledVelocity(0); boat.setStatus(BoatStatusEnum.FINISHED);
} else if (doNotFinish()) { } else if (doNotFinish()) {
boatsFinished++; //Boat has pulled out of race.
boat.setTimeFinished(timeElapsed); boat.setTimeFinished(timeElapsed);
boat.setCurrentLeg(new Leg("DNF", -1)); boat.setCurrentLeg(new Leg("DNF", -1));
boat.setVelocity(0); boat.setCurrentSpeed(0);
boat.setScaledVelocity(0); boat.setStatus(BoatStatusEnum.DNF);
} else {
//Calculate how much the boat overshot the marker by }
boat.setDistanceTravelledInLeg(boat.getDistanceTravelledInLeg() - boat.getCurrentLeg().getDistance());
//Move boat on to next leg
Leg nextLeg = legs.get(boat.getCurrentLeg().getLegNumber() + 1);
boat.setCurrentLeg(nextLeg);
} }
} }
/**
* Determines whether or not a specific leg is the last leg in the race.
* @param leg The leg to check.
* @return Returns true if it is the last, false otherwse.
*/
private boolean isLastLeg(Leg leg) {
//Get the last leg.
Leg lastLeg = this.legs.get(this.legs.size() - 1);
//Check its ID.
int lastLegID = lastLeg.getLegNumber();
//Get the specified leg's ID.
int legID = leg.getLegNumber();
//Check if they are the same.
return legID == lastLegID;
} }
/** /**
* Sets the chance each boat has of failing at a gate or marker * Sets the chance each boat has of failing at a gate or marker
* *
@ -276,9 +763,69 @@ public class Race implements Runnable {
} }
} }
/**
* Decides if a boat should received a DNF status.
* @return True means it should DNF, false means it shouldn't.
*/
protected boolean doNotFinish() { protected boolean doNotFinish() {
Random rand = new Random(); Random rand = new Random();
return rand.nextInt(100) < dnfChance; return rand.nextInt(100) < dnfChance;
} }
/**
* Returns the current race status.
* @return The current race status.
*/
public RaceStatusEnum getRaceStatusEnum() {
return raceStatusEnum;
}
/**
* Sets the current race status.
* @param raceStatusEnum The new status of the race.
*/
private void setRaceStatusEnum(RaceStatusEnum raceStatusEnum) {
this.raceStatusEnum = raceStatusEnum;
}
/**
* Returns the type of race this is.
* @return The type of race this is.
*/
public RaceTypeEnum getRaceType() {
return raceType;
}
/**
* Returns the number of boats that are still active in the race.
* They become inactive by either finishing or withdrawing.
* @return The number of boats still active in the race.
*/
protected int getNumberOfActiveBoats() {
int numberofActiveBoats = 0;
for (Boat boat : this.boats) {
//If the boat is currently racing, count it.
if (boat.getStatus() == BoatStatusEnum.RACING) {
numberofActiveBoats++;
}
}
return numberofActiveBoats;
}
/**
* Returns an observable list of boats in the race.
* @return List of boats in the race.
*/
public ObservableList<Boat> getBoats() {
return boats;
}
} }

@ -0,0 +1,50 @@
package seng302.Model;
/**
* Created by f123 on 10-May-17.
*/
/**
* This class encapsulates VMG - that is, velocity made good. It has a speed component and a bearing component.
*/
public class VMG {
/**
* Speed component of the VMG, in knots.
*/
private double speed;
/**
* Bearing component of the VMG.
*/
private Bearing bearing;
/**
* Ctor. Creates a VMG object with a given speed and bearing (that is, a velocity).
* @param speed Speed component of the VMG.
* @param bearing Bearing component of the VMG.
*/
public VMG(double speed, Bearing bearing) {
this.speed = speed;
this.bearing = bearing;
}
/**
* Returns the speed component of this VMG object, measured in knots.
* @return Speed component of this VMG object.
*/
public double getSpeed() {
return speed;
}
/**
* Returns the bearing component of this VMG object.
* @return Bearing component of this VMG object.
*/
public Bearing getBearing() {
return bearing;
}
}

@ -0,0 +1,8 @@
Tws,Twa0,Bsp0,Twa1,Bsp1,UpTwa,UpBsp,Twa2,Bsp2,Twa3,Bsp3,Twa4,Bsp4,Twa5,Bsp5,Twa6,Bsp6,DnTwa,DnBsp,Twa7,Bsp7
4,0,0,30,4,45,8,60,9,75,10,90,10,115,10,145,10,155,10,175,4
8,0,0,30,7,43,10,60,11,75,11,90,11,115,12,145,12,153,12,175,10
12,0,0,30,11,43,14.4,60,16,75,20,90,23,115,24,145,23,153,21.6,175,14
16,0,0,30,12,42,19.2,60,25,75,27,90,31,115,32,145,30,153,28.8,175,20
20,0,0,30,13,41,24,60,29,75,37,90,39,115,40,145,38,153,36,175,24
25,0,0,30,15,40,30,60,38,75,44,90,49,115,50,145,49,151,47,175,30
30,0,0,30,15,42,30,60,37,75,42,90,48,115,49,145,48,150,46,175,32
1 Tws Twa0 Bsp0 Twa1 Bsp1 UpTwa UpBsp Twa2 Bsp2 Twa3 Bsp3 Twa4 Bsp4 Twa5 Bsp5 Twa6 Bsp6 DnTwa DnBsp Twa7 Bsp7
2 4 0 0 30 4 45 8 60 9 75 10 90 10 115 10 145 10 155 10 175 4
3 8 0 0 30 7 43 10 60 11 75 11 90 11 115 12 145 12 153 12 175 10
4 12 0 0 30 11 43 14.4 60 16 75 20 90 23 115 24 145 23 153 21.6 175 14
5 16 0 0 30 12 42 19.2 60 25 75 27 90 31 115 32 145 30 153 28.8 175 20
6 20 0 0 30 13 41 24 60 29 75 37 90 39 115 40 145 38 153 36 175 24
7 25 0 0 30 15 40 30 60 38 75 44 90 49 115 50 145 49 151 47 175 30
8 30 0 0 30 15 42 30 60 37 75 42 90 48 115 49 145 48 150 46 175 32

@ -5,6 +5,7 @@ import org.junit.Test;
import org.xml.sax.SAXException; import org.xml.sax.SAXException;
import seng302.Model.Boat; import seng302.Model.Boat;
import seng302.Model.Mark; import seng302.Model.Mark;
import seng302.Model.Polars;
import javax.xml.parsers.ParserConfigurationException; import javax.xml.parsers.ParserConfigurationException;
import java.io.IOException; import java.io.IOException;
@ -25,7 +26,7 @@ public class BoatXMLReaderTest {
@Before @Before
public void setUp() { public void setUp() {
try { try {
boatData = new BoatXMLReader("mockXML/boatTest.xml"); boatData = new BoatXMLReader("mockXML/boatTest.xml", new Polars());
boats = new ArrayList<>(boatData.getBoats().values()); boats = new ArrayList<>(boatData.getBoats().values());
marks = new ArrayList<>(boatData.getMarkerBoats().values()); marks = new ArrayList<>(boatData.getMarkerBoats().values());
} catch (ParserConfigurationException e) { } catch (ParserConfigurationException e) {

@ -0,0 +1,38 @@
package seng302.DataInput;
import org.testng.annotations.Test;
import seng302.Exceptions.InvalidPolarFileException;
import seng302.Model.Polars;
import java.io.File;
import static org.testng.Assert.*;
/**
* Created by f123 on 10-May-17.
*/
public class PolarParserTest {
@Test
/**
* Tests if we can parse a polar data file (stored in a string), and create a polar table.
*/
public void testParse() throws Exception {
try {
//Parse data file.
Polars polars = PolarParser.parse("polars/acc_polars.csv");
//If the parse function didn't through, it worked.
assertTrue(true);
}
catch (InvalidPolarFileException e) {
assertTrue(false);
}
}
}

@ -1,10 +1,10 @@
package seng302.Model; package seng302.Model;
import org.junit.Before;
import org.junit.Test; import org.junit.Test;
import static org.junit.Assert.assertEquals;
import static junit.framework.TestCase.*;
/** /**
* Created by esa46 on 22/03/17. * Created by esa46 on 22/03/17.
@ -12,85 +12,92 @@ import static junit.framework.TestCase.*;
public class BoatTest { public class BoatTest {
private GPSCoordinate ORIGIN_COORDS = new GPSCoordinate(0, 0); private GPSCoordinate ORIGIN_COORDS;
private Boat TEST_BOAT = new Boat(1, "Test", "tt"); private Boat TEST_BOAT;
@Before
public void setUp() {
ORIGIN_COORDS = new GPSCoordinate(0, 0);
TEST_BOAT = new Boat(1, "Test", "tt", new Polars());
TEST_BOAT.setCurrentPosition(ORIGIN_COORDS);
}
@Test @Test
public void calculateDueNorthAzimuthReturns0() { public void calculateDueNorthAzimuthReturns0() {
Marker startMarker = new Marker(ORIGIN_COORDS); CompoundMark startMarker = new CompoundMark(new Mark(1, "test origin 1", ORIGIN_COORDS));
Marker endMarker = new Marker(new GPSCoordinate(50, 0)); CompoundMark endMarker = new CompoundMark(new Mark(2, "test mark 2", new GPSCoordinate(50, 0)));
Leg start = new Leg("Start", startMarker, endMarker, 0); Leg start = new Leg("Start", startMarker, endMarker, 0);
TEST_BOAT.setCurrentLeg(start); TEST_BOAT.setCurrentLeg(start);
assertEquals(TEST_BOAT.calculateAzimuth(), 0, 1e-8); assertEquals(GPSCoordinate.calculateAzimuth(startMarker.getAverageGPSCoordinate(), endMarker.getAverageGPSCoordinate()).degrees(), 0, 1e-8);
} }
@Test @Test
public void calculateDueSouthAzimuthReturns180() { public void calculateDueSouthAzimuthReturns180() {
Marker startMarker = new Marker(ORIGIN_COORDS); CompoundMark startMarker = new CompoundMark(new Mark(1, "test origin 1", ORIGIN_COORDS));
Marker endMarker = new Marker(new GPSCoordinate(-50, 0)); CompoundMark endMarker = new CompoundMark(new Mark(2, "test mark 2", new GPSCoordinate(-50, 0)));
Leg start = new Leg("Start", startMarker, endMarker, 0); Leg start = new Leg("Start", startMarker, endMarker, 0);
TEST_BOAT.setCurrentLeg(start); TEST_BOAT.setCurrentLeg(start);
assertEquals(TEST_BOAT.calculateAzimuth(), 180, 1e-8); assertEquals(GPSCoordinate.calculateAzimuth(startMarker.getAverageGPSCoordinate(), endMarker.getAverageGPSCoordinate()).degrees(), -180, 1e-8);
} }
@Test @Test
public void calculateDueEastAzimuthReturns90() { public void calculateDueEastAzimuthReturns90() {
Marker startMarker = new Marker(ORIGIN_COORDS); CompoundMark startMarker = new CompoundMark(new Mark(1, "test origin 1", ORIGIN_COORDS));
Marker endMarker = new Marker(new GPSCoordinate(0, 50)); CompoundMark endMarker = new CompoundMark(new Mark(2, "test mark 2", new GPSCoordinate(0, 50)));
Leg start = new Leg("Start", startMarker, endMarker, 0); Leg start = new Leg("Start", startMarker, endMarker, 0);
TEST_BOAT.setCurrentLeg(start); TEST_BOAT.setCurrentLeg(start);
assertEquals(TEST_BOAT.calculateAzimuth(), 90, 1e-8); assertEquals(GPSCoordinate.calculateAzimuth(startMarker.getAverageGPSCoordinate(), endMarker.getAverageGPSCoordinate()).degrees(), 90, 1e-8);
} }
@Test @Test
public void calculateDueWestAzimuthReturnsNegative90() { public void calculateDueWestAzimuthReturnsNegative90() {
Marker startMarker = new Marker(ORIGIN_COORDS); CompoundMark startMarker = new CompoundMark(new Mark(1, "test origin 1", ORIGIN_COORDS));
Marker endMarker = new Marker(new GPSCoordinate(0, -50)); CompoundMark endMarker = new CompoundMark(new Mark(2, "test mark 2", new GPSCoordinate(0, -50)));
Leg start = new Leg("Start", startMarker, endMarker, 0); Leg start = new Leg("Start", startMarker, endMarker, 0);
TEST_BOAT.setCurrentLeg(start); TEST_BOAT.setCurrentLeg(start);
assertEquals(TEST_BOAT.calculateAzimuth(), -90, 1e-8); assertEquals(GPSCoordinate.calculateAzimuth(startMarker.getAverageGPSCoordinate(), endMarker.getAverageGPSCoordinate()).degrees(), -90, 1e-8);
} }
@Test @Test
public void calculateDueNorthHeadingReturns0() { public void calculateDueNorthHeadingReturns0() {
Marker startMarker = new Marker(ORIGIN_COORDS); CompoundMark startMarker = new CompoundMark(new Mark(1, "test origin 1", ORIGIN_COORDS));
Marker endMarker = new Marker(new GPSCoordinate(50, 0)); CompoundMark endMarker = new CompoundMark(new Mark(2, "test mark 2", new GPSCoordinate(50, 0)));
Leg start = new Leg("Start", startMarker, endMarker, 0); Leg start = new Leg("Start", startMarker, endMarker, 0);
TEST_BOAT.setCurrentLeg(start); TEST_BOAT.setCurrentLeg(start);
assertEquals(TEST_BOAT.calculateHeading(), 0, 1e-8); assertEquals(TEST_BOAT.calculateBearingToNextMarker().degrees(), 0, 1e-8);
} }
@Test @Test
public void calculateDueEastHeadingReturns90() { public void calculateDueEastHeadingReturns90() {
Marker startMarker = new Marker(ORIGIN_COORDS); CompoundMark startMarker = new CompoundMark(new Mark(1, "test origin 1", ORIGIN_COORDS));
Marker endMarker = new Marker(new GPSCoordinate(0, 50)); CompoundMark endMarker = new CompoundMark(new Mark(2, "test mark 2", new GPSCoordinate(0, 50)));
Leg start = new Leg("Start", startMarker, endMarker, 0); Leg start = new Leg("Start", startMarker, endMarker, 0);
TEST_BOAT.setCurrentLeg(start); TEST_BOAT.setCurrentLeg(start);
assertEquals(TEST_BOAT.calculateHeading(), 90, 1e-8); assertEquals(TEST_BOAT.calculateBearingToNextMarker().degrees(), 90, 1e-8);
} }
@Test @Test
public void calculateDueSouthHeadingReturns180() { public void calculateDueSouthHeadingReturns180() {
Marker startMarker = new Marker(ORIGIN_COORDS); CompoundMark startMarker = new CompoundMark(new Mark(1, "test origin 1", ORIGIN_COORDS));
Marker endMarker = new Marker(new GPSCoordinate(-50, 0)); CompoundMark endMarker = new CompoundMark(new Mark(2, "test mark 2", new GPSCoordinate(-50, 0)));
Leg start = new Leg("Start", startMarker, endMarker, 0); Leg start = new Leg("Start", startMarker, endMarker, 0);
TEST_BOAT.setCurrentLeg(start); TEST_BOAT.setCurrentLeg(start);
assertEquals(TEST_BOAT.calculateHeading(), 180, 1e-8); assertEquals(TEST_BOAT.calculateBearingToNextMarker().degrees(), 180, 1e-8);
} }
@Test @Test
public void calculateDueWestHeadingReturns270() { public void calculateDueWestHeadingReturns270() {
Marker startMarker = new Marker(ORIGIN_COORDS); CompoundMark startMarker = new CompoundMark(new Mark(1, "test origin 1", ORIGIN_COORDS));
Marker endMarker = new Marker(new GPSCoordinate(0, -50)); CompoundMark endMarker = new CompoundMark(new Mark(2, "test mark 2", new GPSCoordinate(0, -50)));
Leg start = new Leg("Start", startMarker, endMarker, 0); Leg start = new Leg("Start", startMarker, endMarker, 0);
TEST_BOAT.setCurrentLeg(start); TEST_BOAT.setCurrentLeg(start);
assertEquals(TEST_BOAT.calculateHeading(), 270, 1e-8); assertEquals(TEST_BOAT.calculateBearingToNextMarker().degrees(), 270, 1e-8);
} }
} }

@ -17,7 +17,7 @@ public class CompoundMarkTest {
@Test @Test
public void averageOfSingleMarkAtOriginIsSingleMark() { public void averageOfSingleMarkAtOriginIsSingleMark() {
Marker testMark = new Marker(ORIGIN_COORD); CompoundMark testMark = new CompoundMark(new Mark(1, "test origin 1", ORIGIN_COORD));
assertTrue(testMark.getAverageGPSCoordinate().equals(ORIGIN_COORD)); assertTrue(testMark.getAverageGPSCoordinate().equals(ORIGIN_COORD));
} }
@ -26,7 +26,7 @@ public class CompoundMarkTest {
public void averageOfSingleMarkIsSingleMark() { public void averageOfSingleMarkIsSingleMark() {
GPSCoordinate testCoord = new GPSCoordinate(20, 25); GPSCoordinate testCoord = new GPSCoordinate(20, 25);
Marker testMark = new Marker(testCoord); CompoundMark testMark = new CompoundMark(new Mark(1, "test origin 1", testCoord));
assertTrue(testMark.getAverageGPSCoordinate().equals(testCoord)); assertTrue(testMark.getAverageGPSCoordinate().equals(testCoord));
} }
@ -35,15 +35,16 @@ public class CompoundMarkTest {
public void averageLatOfTwoMarksIsAccurate() { public void averageLatOfTwoMarksIsAccurate() {
GPSCoordinate testCoord = new GPSCoordinate(0.001, 0); GPSCoordinate testCoord = new GPSCoordinate(0.001, 0);
Marker testMark = new Marker(ORIGIN_COORD, testCoord); CompoundMark testMark = new CompoundMark(new Mark(1, "test origin 1", ORIGIN_COORD), new Mark(2, "test origin 2", testCoord));
assertEquals(testMark.getAverageGPSCoordinate(), new GPSCoordinate(0.0005, 0)); assertEquals(testMark.getAverageGPSCoordinate(), new GPSCoordinate(0.0005, 0));
} }
@Test @Test
public void averageLongOfTwoMarksIsAccurate() { public void averageLongOfTwoMarksIsAccurate() {
GPSCoordinate testCoord = new GPSCoordinate(0, 10); GPSCoordinate testCoord = new GPSCoordinate(0, 10);
Marker testMark = new Marker(ORIGIN_COORD, testCoord); CompoundMark testMark = new CompoundMark(new Mark(1, "test origin 1", ORIGIN_COORD), new Mark(2, "test origin 2", testCoord));
assertTrue(testMark.getAverageGPSCoordinate().equals(new GPSCoordinate(0, 5))); assertTrue(testMark.getAverageGPSCoordinate().equals(new GPSCoordinate(0, 5)));
} }
@ -53,7 +54,9 @@ public class CompoundMarkTest {
GPSCoordinate testCoord1 = new GPSCoordinate(0.0, 30); GPSCoordinate testCoord1 = new GPSCoordinate(0.0, 30);
GPSCoordinate testCoord2 = new GPSCoordinate(0.001, 60); GPSCoordinate testCoord2 = new GPSCoordinate(0.001, 60);
Marker testMark = new Marker(testCoord1, testCoord2);
CompoundMark testMark = new CompoundMark(new Mark(1, "test origin 1", testCoord1), new Mark(2, "test origin 2", testCoord2));
assertEquals(testMark.getAverageGPSCoordinate().getLatitude(), 0.00051776, 1e-8); assertEquals(testMark.getAverageGPSCoordinate().getLatitude(), 0.00051776, 1e-8);
assertEquals(testMark.getAverageGPSCoordinate().getLongitude(), 45.000000, 1e-8); assertEquals(testMark.getAverageGPSCoordinate().getLongitude(), 45.000000, 1e-8);
} }

@ -0,0 +1,106 @@
package seng302.Model;
import org.junit.Before;
import org.junit.Test;
import java.util.ArrayList;
import java.util.List;
import static junit.framework.TestCase.assertTrue;
import static junit.framework.TestCase.assertFalse;
/**
* Created by jjg64 on 11/05/17.
*/
public class GPSCoordinateTest {
List<GPSCoordinate> boundary;
@Before
public void init() {
boundary = new ArrayList<>();
}
/**
* -------
* | |
* | * |
* -------
*/
@Test
public void insideSquareTest() {
boundary.add(new GPSCoordinate(0, 0));
boundary.add(new GPSCoordinate(10, 0));
boundary.add(new GPSCoordinate(10, 10));
boundary.add(new GPSCoordinate(0, 10));
GPSCoordinate coordinate = new GPSCoordinate(2, 8);
boolean inside = GPSCoordinate.isInsideBoundary(coordinate, boundary);
assertTrue(inside);
}
/**
* -------
* | |
* * | |
* -------
*/
@Test
public void outsideSquareTest() {
boundary.add(new GPSCoordinate(0, 0));
boundary.add(new GPSCoordinate(10, 0));
boundary.add(new GPSCoordinate(10, 10));
boundary.add(new GPSCoordinate(0, 10));
GPSCoordinate coordinate = new GPSCoordinate(-2, 8);
boolean inside = GPSCoordinate.isInsideBoundary(coordinate, boundary);
assertFalse(inside);
}
@Test
public void insideShapeWithObtuseAnglesTest() {
boundary.add(new GPSCoordinate(0, 0));
boundary.add(new GPSCoordinate(4, 4));
boundary.add(new GPSCoordinate(7, 2));
boundary.add(new GPSCoordinate(9, 5));
boundary.add(new GPSCoordinate(10, 10));
boundary.add(new GPSCoordinate(6, 6));
boundary.add(new GPSCoordinate(2, 10));
GPSCoordinate coordinate = new GPSCoordinate(5, 5);
boolean inside = GPSCoordinate.isInsideBoundary(coordinate, boundary);
assertTrue(inside);
}
@Test
public void outsideShapeWithObtuseAnglesTest() {
boundary.add(new GPSCoordinate(0, 0));
boundary.add(new GPSCoordinate(4, 4));
boundary.add(new GPSCoordinate(7, 2));
boundary.add(new GPSCoordinate(9, 5));
boundary.add(new GPSCoordinate(10, 10));
boundary.add(new GPSCoordinate(6, 6));
boundary.add(new GPSCoordinate(2, 10));
GPSCoordinate coordinate = new GPSCoordinate(4, 3);
boolean inside = GPSCoordinate.isInsideBoundary(coordinate, boundary);
assertFalse(inside);
}
/**
* -------
* | |
* * | |
* -------
*/
@Test
public void earlyTerminationTest() {
boundary.add(new GPSCoordinate(0, 0));
boundary.add(new GPSCoordinate(10, 0));
boundary.add(new GPSCoordinate(10, 10));
boundary.add(new GPSCoordinate(0, 10));
GPSCoordinate coordinate = new GPSCoordinate(-2, 8);
boolean inside = GPSCoordinate.isInsideBoundary(coordinate, boundary, new GPSCoordinate(0, 0), new GPSCoordinate(10, 10));
assertFalse(inside);
}
}

@ -14,7 +14,7 @@ import static junit.framework.TestCase.assertEquals;
*/ */
public class LegTest { public class LegTest {
private Marker ORIGIN_Compound_MARKER = new Marker(new GPSCoordinate(0, 0)); private CompoundMark ORIGIN_Compound_MARKER = new CompoundMark(new Mark(1, "test mark1", new GPSCoordinate(0, 0)));
@Test @Test
public void calculateDistanceHandles5nmNorth() { public void calculateDistanceHandles5nmNorth() {
@ -22,9 +22,9 @@ public class LegTest {
calc.setStartingGeographicPoint(0, 0); calc.setStartingGeographicPoint(0, 0);
calc.setDirection(0, 5 * Constants.NMToMetersConversion); calc.setDirection(0, 5 * Constants.NMToMetersConversion);
Marker endMarker = getEndMarker(calc.getDestinationGeographicPoint()); CompoundMark endMarker = getEndMarker(calc.getDestinationGeographicPoint());
Leg test = new Leg("Test", ORIGIN_Compound_MARKER, endMarker, 0); Leg test = new Leg("Test", ORIGIN_Compound_MARKER, endMarker, 0);
assertEquals(test.getDistance(), 5, 1e-8); assertEquals(test.getDistanceNauticalMiles(), 5, 1e-8);
} }
@Test @Test
@ -33,9 +33,9 @@ public class LegTest {
calc.setStartingGeographicPoint(0, 0); calc.setStartingGeographicPoint(0, 0);
calc.setDirection(90, 12 * Constants.NMToMetersConversion); calc.setDirection(90, 12 * Constants.NMToMetersConversion);
Marker endMarker = getEndMarker(calc.getDestinationGeographicPoint()); CompoundMark endMarker = getEndMarker(calc.getDestinationGeographicPoint());
Leg test = new Leg("Test", ORIGIN_Compound_MARKER, endMarker, 0); Leg test = new Leg("Test", ORIGIN_Compound_MARKER, endMarker, 0);
assertEquals(test.getDistance(), 12, 1e-8); assertEquals(test.getDistanceNauticalMiles(), 12, 1e-8);
} }
@Test @Test
@ -44,9 +44,9 @@ public class LegTest {
calc.setStartingGeographicPoint(0, 0); calc.setStartingGeographicPoint(0, 0);
calc.setDirection(180, 0.5 * Constants.NMToMetersConversion); calc.setDirection(180, 0.5 * Constants.NMToMetersConversion);
Marker endMarker = getEndMarker(calc.getDestinationGeographicPoint()); CompoundMark endMarker = getEndMarker(calc.getDestinationGeographicPoint());
Leg test = new Leg("Test", ORIGIN_Compound_MARKER, endMarker, 0); Leg test = new Leg("Test", ORIGIN_Compound_MARKER, endMarker, 0);
assertEquals(test.getDistance(), 0.5, 1e-8); assertEquals(test.getDistanceNauticalMiles(), 0.5, 1e-8);
} }
@Test @Test
@ -55,23 +55,23 @@ public class LegTest {
calc.setStartingGeographicPoint(0, 0); calc.setStartingGeographicPoint(0, 0);
calc.setDirection(-90, 0.1 * Constants.NMToMetersConversion); calc.setDirection(-90, 0.1 * Constants.NMToMetersConversion);
Marker endMarker = getEndMarker(calc.getDestinationGeographicPoint()); CompoundMark endMarker = getEndMarker(calc.getDestinationGeographicPoint());
Leg test = new Leg("Test", ORIGIN_Compound_MARKER, endMarker, 0); Leg test = new Leg("Test", ORIGIN_Compound_MARKER, endMarker, 0);
assertEquals(test.getDistance(), 0.1, 1e-8); assertEquals(test.getDistanceNauticalMiles(), 0.1, 1e-8);
} }
@Test @Test
public void calculateDistanceHandlesZeroDifference() { public void calculateDistanceHandlesZeroDifference() {
Leg test = new Leg("Test", ORIGIN_Compound_MARKER, ORIGIN_Compound_MARKER, 0); Leg test = new Leg("Test", ORIGIN_Compound_MARKER, ORIGIN_Compound_MARKER, 0);
assertEquals(test.getDistance(), 0, 1e-8); assertEquals(test.getDistanceNauticalMiles(), 0, 1e-8);
} }
private Marker getEndMarker(Point2D point) { private CompoundMark getEndMarker(Point2D point) {
GPSCoordinate coords = new GPSCoordinate(point.getY(), point.getX()); GPSCoordinate coords = new GPSCoordinate(point.getY(), point.getX());
return new Marker(coords); return new CompoundMark(new Mark(3, "test mark3", coords));
} }
} }

@ -0,0 +1,259 @@
package seng302.Model;
import org.junit.Before;
import org.junit.Test;
import seng302.DataInput.PolarParser;
import seng302.Exceptions.InvalidPolarFileException;
import static org.testng.Assert.*;
/**
* Created by f123 on 10-May-17.
*/
public class PolarsTest {
private Polars polars = null;
private double angleEpsilon = 2;
private double speedEpsilon = 0.5;
/**
* Creates the Polars object for the tests.
*/
@Before
public void setUp() {
//Read data.
try {
//Parse data file.
polars = PolarParser.parse("polars/acc_polars.csv");
}
catch (InvalidPolarFileException e) {
assertTrue(false);
}
}
/**
* Tests if we can calculate VMG for a variety of values.
*/
@Test
public void testVMG1() {
//Test 1.
//This test has a wind speed that is between two values from the table (12kn, 16kn, this is 15.9kn).
Bearing windAngle1 = Bearing.fromDegrees(31.5);
Bearing destAngle1 = Bearing.fromDegrees(65.32);
double windSpeed1 = 15.9;//knots
Bearing vmgAngle1 = Bearing.fromDegrees(72.4);
double vmgSpeed1 = 30.4;
VMG calcVMG1 = polars.calculateVMG(windAngle1, windSpeed1, destAngle1, Bearing.fromDegrees(0), Bearing.fromDegrees(359.9));
Bearing calcVMGAngle1 = calcVMG1.getBearing();
double calcVMGSpeed1 = calcVMG1.getSpeed();
assertEquals(calcVMGAngle1.degrees(), vmgAngle1.degrees(), angleEpsilon);
assertEquals(calcVMGSpeed1, vmgSpeed1, speedEpsilon);
}
/**
* Tests if we can calculate VMG for a variety of values.
*/
@Test
public void testVMG2() {
//Test 2.
//This test has a wind speed much larger than any in the table (max from table is 30kn, this is 40kn).
Bearing windAngle2 = Bearing.fromDegrees(200);
Bearing destAngle2 = Bearing.fromDegrees(35);
double windSpeed2 = 40;//knots
Bearing vmgAngle2 = Bearing.fromDegrees(69);
double vmgSpeed2 = 32.8;
VMG calcVMG2 = polars.calculateVMG(windAngle2, windSpeed2, destAngle2, Bearing.fromDegrees(0), Bearing.fromDegrees(359.9));
Bearing calcVMGAngle2 = calcVMG2.getBearing();
double calcVMGSpeed2 = calcVMG2.getSpeed();
assertEquals(calcVMGAngle2.degrees(), vmgAngle2.degrees(), angleEpsilon);
assertEquals(calcVMGSpeed2, vmgSpeed2, speedEpsilon);
}
/**
* Tests if we can calculate VMG for a variety of values.
*/
@Test
public void testVMG3() {
//Test 3.
//This test has a wind speed lower than any non-zero values from the table (table has 0kn, 4kn, this is 2kn).
Bearing windAngle3 = Bearing.fromDegrees(345);
Bearing destAngle3 = Bearing.fromDegrees(199);
double windSpeed3 = 2;//knots
Bearing vmgAngle3 = Bearing.fromDegrees(222);
double vmgSpeed3 = 4.4;
VMG calcVMG3 = polars.calculateVMG(windAngle3, windSpeed3, destAngle3, Bearing.fromDegrees(0), Bearing.fromDegrees(359.9));
Bearing calcVMGAngle3 = calcVMG3.getBearing();
double calcVMGSpeed3 = calcVMG3.getSpeed();
assertEquals(calcVMGAngle3.degrees(), vmgAngle3.degrees(), angleEpsilon);
assertEquals(calcVMGSpeed3, vmgSpeed3, speedEpsilon);
}
/**
* Tests if we can calculate VMG for a variety of values.
*/
@Test
public void testVMG4() {
//Test 4.
//This test has a wind speed of 0.
Bearing windAngle4 = Bearing.fromDegrees(5);
Bearing destAngle4 = Bearing.fromDegrees(100);
double windSpeed4 = 0;//knots
Bearing vmgAngle4 = Bearing.fromDegrees(100);
double vmgSpeed4 = 0;
VMG calcVMG4 = polars.calculateVMG(windAngle4, windSpeed4, destAngle4, Bearing.fromDegrees(0), Bearing.fromDegrees(359.9));
Bearing calcVMGAngle4 = calcVMG4.getBearing();
double calcVMGSpeed4 = calcVMG4.getSpeed();
assertEquals(calcVMGAngle4.degrees(), vmgAngle4.degrees(), angleEpsilon);
assertEquals(calcVMGSpeed4, vmgSpeed4, speedEpsilon);
}
/**
* Tests if we can calculate VMG for a variety of values.
*/
@Test
public void testVMG5() {
//Test 5.
//This test has a bearing bound of [55, 70), which only contains a suboptimal VMG.
Bearing windAngle5 = Bearing.fromDegrees(5);
Bearing destAngle5 = Bearing.fromDegrees(100);
double windSpeed5 = 9;//knots
Bearing vmgAngle5 = Bearing.fromDegrees(70);
double vmgSpeed5 = 15;
Bearing bearingUpperBound5 = Bearing.fromDegrees(70);
Bearing bearingLowerBound5 = Bearing.fromDegrees(55);
VMG calcVMG5 = polars.calculateVMG(windAngle5, windSpeed5, destAngle5, bearingLowerBound5, bearingUpperBound5);
Bearing calcVMGAngle5 = calcVMG5.getBearing();
double calcVMGSpeed5 = calcVMG5.getSpeed();
assertEquals(calcVMGAngle5.degrees(), vmgAngle5.degrees(), angleEpsilon);
assertEquals(calcVMGSpeed5, vmgSpeed5, speedEpsilon);
assertTrue(calcVMGAngle5.degrees() >= bearingLowerBound5.degrees());
assertTrue(calcVMGAngle5.degrees() <= bearingUpperBound5.degrees());
}
/**
* Tests if we can calculate VMG for a variety of values.
*/
@Test
public void testVMG6() {
//Test 6.
//This test has a bearing bound of [70, 55), which has a lower bound > upper bound, which is complementary to [55, 70).
Bearing windAngle6 = Bearing.fromDegrees(5);
Bearing destAngle6 = Bearing.fromDegrees(100);
double windSpeed6 = 11;//knots
Bearing vmgAngle6 = Bearing.fromDegrees(92.85);
double vmgSpeed6 = 20.086;
Bearing bearingUpperBound6 = Bearing.fromDegrees(55);
Bearing bearingLowerBound6 = Bearing.fromDegrees(70);
VMG calcVMG6 = polars.calculateVMG(windAngle6, windSpeed6, destAngle6, bearingLowerBound6, bearingUpperBound6);
Bearing calcVMGAngle6 = calcVMG6.getBearing();
double calcVMGSpeed6 = calcVMG6.getSpeed();
assertEquals(calcVMGAngle6.degrees(), vmgAngle6.degrees(), angleEpsilon);
assertEquals(calcVMGSpeed6, vmgSpeed6, speedEpsilon);
if (bearingLowerBound6.degrees() > bearingUpperBound6.degrees()) {
assertTrue((calcVMGAngle6.degrees() >= bearingLowerBound6.degrees()) || (calcVMGAngle6.degrees() <= bearingUpperBound6.degrees()));
} else {
assertTrue(calcVMGAngle6.degrees() >= bearingLowerBound6.degrees());
assertTrue(calcVMGAngle6.degrees() <= bearingUpperBound6.degrees());
}
}
/**
* Tests if we can calculate VMG for a variety of values.
*/
@Test
public void testVMG7() {
//Test 7.
//This test has a bearing bound of [340, 5), which has a lower bound > upper bound, which is complementary to [5, 340).
Bearing windAngle7 = Bearing.fromDegrees(340);
Bearing destAngle7 = Bearing.fromDegrees(30);
double windSpeed7 = 7;//knots
Bearing vmgAngle7 = Bearing.fromDegrees(5);
double vmgSpeed7 = 11;
Bearing bearingUpperBound7 = Bearing.fromDegrees(5);
Bearing bearingLowerBound7 = Bearing.fromDegrees(340);
VMG calcVMG7 = polars.calculateVMG(windAngle7, windSpeed7, destAngle7, bearingLowerBound7, bearingUpperBound7);
Bearing calcVMGAngle7 = calcVMG7.getBearing();
double calcVMGSpeed7 = calcVMG7.getSpeed();
assertEquals(calcVMGAngle7.degrees(), vmgAngle7.degrees(), angleEpsilon);
assertEquals(calcVMGSpeed7, vmgSpeed7, speedEpsilon);
if (bearingLowerBound7.degrees() > bearingUpperBound7.degrees()) {
assertTrue((calcVMGAngle7.degrees() >= bearingLowerBound7.degrees()) || (calcVMGAngle7.degrees() <= bearingUpperBound7.degrees()));
} else {
assertTrue(calcVMGAngle7.degrees() >= bearingLowerBound7.degrees());
assertTrue(calcVMGAngle7.degrees() <= bearingUpperBound7.degrees());
}
}
/**
* Tests if we can calculate VMG for a variety of values.
*/
@Test
public void testVMG8() {
//Test 8.
//This test has a bearing bound of [340, 5), which has a lower bound > upper bound, which is complementary to [5, 340). Due to the wind, dest angles, and bearing bounds, it cannot actually find a VMG > 0 (valid VMGs will actually be in the angle interval [10, 190]), so it will return the VMG(angle=0, speed=0).
Bearing windAngle8 = Bearing.fromDegrees(5);
Bearing destAngle8 = Bearing.fromDegrees(100);
double windSpeed8 = 7;//knots
Bearing vmgAngle8 = Bearing.fromDegrees(0);
double vmgSpeed8 = 0;
Bearing bearingUpperBound8 = Bearing.fromDegrees(5);
Bearing bearingLowerBound8 = Bearing.fromDegrees(340);
VMG calcVMG8 = polars.calculateVMG(windAngle8, windSpeed8, destAngle8, bearingLowerBound8, bearingUpperBound8);
Bearing calcVMGAngle8 = calcVMG8.getBearing();
double calcVMGSpeed8 = calcVMG8.getSpeed();
assertEquals(calcVMGAngle8.degrees(), vmgAngle8.degrees(), 0);
assertEquals(calcVMGSpeed8, vmgSpeed8, 0);
}
}

@ -29,9 +29,9 @@ import static org.mockito.Mockito.*;
public class RaceTest{ public class RaceTest{
public static final Marker ORIGIN = new Marker(new GPSCoordinate(0, 0)); public static final CompoundMark ORIGIN = new CompoundMark(new Mark(1, "test origin 1", new GPSCoordinate(0, 0)));
public static final Marker THREE_NM_FROM_ORIGIN = new Marker(new GPSCoordinate(0.050246769, 0)); public static final CompoundMark THREE_NM_FROM_ORIGIN = new CompoundMark(new Mark(2, "test mark 2", new GPSCoordinate(0.050246769, 0)));
public static final Marker FIFTEEN_NM_FROM_ORIGIN = new Marker(new GPSCoordinate(0.251233845, 0)); public static final CompoundMark FIFTEEN_NM_FROM_ORIGIN = new CompoundMark(new Mark(3, "test mark 3", new GPSCoordinate(0.251233845, 0)));
public static ArrayList<Leg> TEST_LEGS = new ArrayList<>(); public static ArrayList<Leg> TEST_LEGS = new ArrayList<>();
public static final int START_LEG_DISTANCE = 3; public static final int START_LEG_DISTANCE = 3;
public static final int MIDDLE_LEG_DISTANCE = 12; public static final int MIDDLE_LEG_DISTANCE = 12;
@ -52,7 +52,7 @@ public class RaceTest{
try { try {
MockOutput mockOutput = Mockito.mock(MockOutput.class); MockOutput mockOutput = Mockito.mock(MockOutput.class);
BoatDataSource boatDataSource = new BoatXMLReader("mockXML/boatTest.xml"); BoatDataSource boatDataSource = new BoatXMLReader("mockXML/boatTest.xml", new Polars());
RaceDataSource raceDataSource = new RaceXMLReader("mockXML/raceTest.xml", boatDataSource); RaceDataSource raceDataSource = new RaceXMLReader("mockXML/raceTest.xml", boatDataSource);
Race testRace = new Race(raceDataSource, mockOutput); Race testRace = new Race(raceDataSource, mockOutput);
testRace.initialiseBoats(); testRace.initialiseBoats();
@ -71,7 +71,7 @@ public class RaceTest{
try { try {
MockOutput mockOutput = Mockito.mock(MockOutput.class); MockOutput mockOutput = Mockito.mock(MockOutput.class);
RaceDataSource dataSource = new RaceXMLReader("mockXML/raceTest.xml", new BoatXMLReader("mockXML/boatTest.xml")); RaceDataSource dataSource = new RaceXMLReader("mockXML/raceTest.xml", new BoatXMLReader("mockXML/boatTest.xml", new Polars()));
Race testRace = new Race(dataSource, mockOutput); Race testRace = new Race(dataSource, mockOutput);
testRace.initialiseBoats(); testRace.initialiseBoats();
testRace.countdownTimer.handle(1); testRace.countdownTimer.handle(1);
@ -89,15 +89,15 @@ public class RaceTest{
try { try {
MockOutput mockOutput = Mockito.mock(MockOutput.class); MockOutput mockOutput = Mockito.mock(MockOutput.class);
RaceDataSource dataSource = new RaceXMLReader("mockXML/raceTest.xml", new BoatXMLReader("mockXML/boatTest.xml")); RaceDataSource dataSource = new RaceXMLReader("mockXML/raceTest.xml", new BoatXMLReader("mockXML/boatTest.xml", new Polars()));
Race testRace = new Race(dataSource, mockOutput); Race testRace = new Race(dataSource, mockOutput);
testRace.initialiseBoats(); testRace.initialiseBoats();
Boat testBoat = testRace.startingBoats.get(0); Boat testBoat = testRace.getBoats().get(0);
testBoat.setCurrentLeg(FINISH_LEG); testBoat.setCurrentLeg(FINISH_LEG);
testBoat.setDistanceTravelledInLeg(1); testBoat.setDistanceTravelledInLeg(1);
testRace.checkPosition(testBoat, 1); testRace.checkPosition(testBoat, 1);
assertEquals(testRace.boatsFinished, 1); assertEquals(testRace.getNumberOfActiveBoats(), 0);
} catch (ParserConfigurationException | IOException | SAXException | ParseException | StreamedCourseXMLException e) { } catch (ParserConfigurationException | IOException | SAXException | ParseException | StreamedCourseXMLException e) {
e.printStackTrace(); e.printStackTrace();
@ -111,15 +111,15 @@ public class RaceTest{
try { try {
MockOutput mockOutput = Mockito.mock(MockOutput.class); MockOutput mockOutput = Mockito.mock(MockOutput.class);
RaceDataSource dataSource = new RaceXMLReader("mockXML/raceTest.xml", new BoatXMLReader("mockXML/boatTest.xml")); RaceDataSource dataSource = new RaceXMLReader("mockXML/raceTest.xml", new BoatXMLReader("mockXML/boatTest.xml", new Polars()));
Race testRace = new Race(dataSource, mockOutput); Race testRace = new Race(dataSource, mockOutput);
testRace.initialiseBoats(); testRace.initialiseBoats();
Boat testBoat = testRace.startingBoats.get(0); Boat testBoat = testRace.getBoats().get(0);
testBoat.setCurrentLeg(FINISH_LEG); testBoat.setCurrentLeg(FINISH_LEG);
testBoat.setDistanceTravelledInLeg(1); testBoat.setDistanceTravelledInLeg(1);
testRace.checkPosition(testBoat, 1); testRace.checkPosition(testBoat, 1);
assertEquals(testBoat.getVelocity(), 0, 1e-8); assertEquals(testBoat.getCurrentSpeed(), 0, 1e-8);
} catch (ParserConfigurationException | IOException | SAXException | ParseException | StreamedCourseXMLException e) { } catch (ParserConfigurationException | IOException | SAXException | ParseException | StreamedCourseXMLException e) {
e.printStackTrace(); e.printStackTrace();
@ -133,10 +133,10 @@ public class RaceTest{
try { try {
MockOutput mockOutput = Mockito.mock(MockOutput.class); MockOutput mockOutput = Mockito.mock(MockOutput.class);
RaceDataSource dataSource = new RaceXMLReader("mockXML/raceTest.xml", new BoatXMLReader("mockXML/boatTest.xml")); RaceDataSource dataSource = new RaceXMLReader("mockXML/raceTest.xml", new BoatXMLReader("mockXML/boatTest.xml", new Polars()));
Race testRace = new Race(dataSource, mockOutput); Race testRace = new Race(dataSource, mockOutput);
testRace.initialiseBoats(); testRace.initialiseBoats();
Boat testBoat = testRace.startingBoats.get(0); Boat testBoat = testRace.getBoats().get(0);
testBoat.setCurrentLeg(FINISH_LEG); testBoat.setCurrentLeg(FINISH_LEG);
testBoat.setDistanceTravelledInLeg(1); testBoat.setDistanceTravelledInLeg(1);
testRace.checkPosition(testBoat, 1); testRace.checkPosition(testBoat, 1);
@ -155,15 +155,15 @@ public class RaceTest{
try { try {
MockOutput mockOutput = Mockito.mock(MockOutput.class); MockOutput mockOutput = Mockito.mock(MockOutput.class);
RaceDataSource dataSource = new RaceXMLReader("mockXML/raceTest.xml", new BoatXMLReader("mockXML/boatTest.xml")); RaceDataSource dataSource = new RaceXMLReader("mockXML/raceTest.xml", new BoatXMLReader("mockXML/boatTest.xml", new Polars()));
Race testRace = new Race(dataSource, mockOutput); Race testRace = new Race(dataSource, mockOutput);
testRace.initialiseBoats(); testRace.initialiseBoats();
Boat testBoat = testRace.startingBoats.get(0); Boat testBoat = testRace.getBoats().get(0);
testBoat.setCurrentLeg(START_LEG); testBoat.setCurrentLeg(START_LEG);
testBoat.setDistanceTravelledInLeg(START_LEG_DISTANCE); testBoat.setDistanceTravelledInLeg(START_LEG_DISTANCE);
testRace.checkPosition(testBoat, 1); testRace.checkPosition(testBoat, 1);
assertEquals(testRace.boatsFinished, 0); assertEquals(testRace.getNumberOfActiveBoats(), 1);
} catch (ParserConfigurationException | IOException | SAXException | ParseException | StreamedCourseXMLException e) { } catch (ParserConfigurationException | IOException | SAXException | ParseException | StreamedCourseXMLException e) {
e.printStackTrace(); e.printStackTrace();
@ -178,10 +178,10 @@ public class RaceTest{
try { try {
MockOutput mockOutput = Mockito.mock(MockOutput.class); MockOutput mockOutput = Mockito.mock(MockOutput.class);
RaceDataSource dataSource = new RaceXMLReader("mockXML/raceTest.xml", new BoatXMLReader("mockXML/boatTest.xml")); RaceDataSource dataSource = new RaceXMLReader("mockXML/raceTest.xml", new BoatXMLReader("mockXML/boatTest.xml", new Polars()));
Race testRace = new Race(dataSource, mockOutput); Race testRace = new Race(dataSource, mockOutput);
testRace.initialiseBoats(); testRace.initialiseBoats();
Boat testBoat = testRace.startingBoats.get(0); Boat testBoat = testRace.getBoats().get(0);
testBoat.setCurrentLeg(START_LEG); testBoat.setCurrentLeg(START_LEG);
testBoat.setDistanceTravelledInLeg(START_LEG_DISTANCE + 1); testBoat.setDistanceTravelledInLeg(START_LEG_DISTANCE + 1);
testRace.checkPosition(testBoat, 0); testRace.checkPosition(testBoat, 0);
@ -200,7 +200,7 @@ public class RaceTest{
try { try {
MockOutput mockOutput = Mockito.mock(MockOutput.class); MockOutput mockOutput = Mockito.mock(MockOutput.class);
BoatDataSource boatDataSource = new BoatXMLReader("mockXML/boatTest.xml"); BoatDataSource boatDataSource = new BoatXMLReader("mockXML/boatTest.xml", new Polars());
RaceDataSource raceDataSource = new RaceXMLReader("mockXML/raceTest.xml", boatDataSource); RaceDataSource raceDataSource = new RaceXMLReader("mockXML/raceTest.xml", boatDataSource);
Race testRace = new Race(raceDataSource, mockOutput); Race testRace = new Race(raceDataSource, mockOutput);
@ -219,7 +219,7 @@ public class RaceTest{
try { try {
MockOutput mockOutput = Mockito.mock(MockOutput.class); MockOutput mockOutput = Mockito.mock(MockOutput.class);
BoatDataSource boatDataSource = new BoatXMLReader("mockXML/boatTest.xml"); BoatDataSource boatDataSource = new BoatXMLReader("mockXML/boatTest.xml", new Polars());
RaceDataSource raceDataSource = new RaceXMLReader("mockXML/raceTest.xml", boatDataSource); RaceDataSource raceDataSource = new RaceXMLReader("mockXML/raceTest.xml", boatDataSource);
Race testRace = new Race(raceDataSource, mockOutput); Race testRace = new Race(raceDataSource, mockOutput);
@ -237,11 +237,11 @@ public class RaceTest{
public void boatsAreSetToDNF() { public void boatsAreSetToDNF() {
try { try {
MockOutput mockOutput = Mockito.mock(MockOutput.class); MockOutput mockOutput = Mockito.mock(MockOutput.class);
BoatDataSource boatDataSource = new BoatXMLReader("mockXML/boatTest.xml"); BoatDataSource boatDataSource = new BoatXMLReader("mockXML/boatTest.xml", new Polars());
RaceDataSource raceDataSource = new RaceXMLReader("mockXML/raceTest.xml", boatDataSource); RaceDataSource raceDataSource = new RaceXMLReader("mockXML/raceTest.xml", boatDataSource);
Race testRace = new Race(raceDataSource, mockOutput); Race testRace = new Race(raceDataSource, mockOutput);
testRace.setDnfChance(100); testRace.setDnfChance(100);
Boat testBoat = testRace.startingBoats.get(0); Boat testBoat = testRace.getBoats().get(0);
testBoat.setCurrentLeg(START_LEG); testBoat.setCurrentLeg(START_LEG);
testBoat.setDistanceTravelledInLeg(START_LEG_DISTANCE + 1); testBoat.setDistanceTravelledInLeg(START_LEG_DISTANCE + 1);
testRace.checkPosition(testBoat, 1); testRace.checkPosition(testBoat, 1);
@ -259,13 +259,13 @@ public class RaceTest{
public void updatePositionIgnoresFinishedBoats() { public void updatePositionIgnoresFinishedBoats() {
try { try {
MockOutput mockOutput = Mockito.mock(MockOutput.class); MockOutput mockOutput = Mockito.mock(MockOutput.class);
BoatDataSource boatDataSource = new BoatXMLReader("mockXML/boatTest.xml"); BoatDataSource boatDataSource = new BoatXMLReader("mockXML/boatTest.xml", new Polars());
RaceDataSource raceDataSource = new RaceXMLReader("mockXML/raceTest.xml", boatDataSource); RaceDataSource raceDataSource = new RaceXMLReader("mockXML/raceTest.xml", boatDataSource);
Race testRace = new Race(raceDataSource, mockOutput); Race testRace = new Race(raceDataSource, mockOutput);
Boat testBoat = testRace.startingBoats.get(0); Boat testBoat = testRace.getBoats().get(0);
testBoat.setCurrentLeg(FINISH_LEG); testBoat.setCurrentLeg(FINISH_LEG);
testBoat.setCurrentPosition(ORIGIN.getAverageGPSCoordinate()); testBoat.setCurrentPosition(ORIGIN.getAverageGPSCoordinate());
testRace.updatePosition(testBoat, 1); testRace.updatePosition(testBoat, 1, 1);
assertEquals(testBoat.getCurrentPosition(), ORIGIN.getAverageGPSCoordinate()); assertEquals(testBoat.getCurrentPosition(), ORIGIN.getAverageGPSCoordinate());
} catch (ParserConfigurationException | IOException | SAXException | ParseException | StreamedCourseXMLException e) { } catch (ParserConfigurationException | IOException | SAXException | ParseException | StreamedCourseXMLException e) {
@ -279,15 +279,15 @@ public class RaceTest{
public void updatePositionChangesBoatPosition() { public void updatePositionChangesBoatPosition() {
try { try {
MockOutput mockOutput = Mockito.mock(MockOutput.class); MockOutput mockOutput = Mockito.mock(MockOutput.class);
BoatDataSource boatDataSource = new BoatXMLReader("mockXML/boatTest.xml"); BoatDataSource boatDataSource = new BoatXMLReader("mockXML/boatTest.xml", new Polars());
RaceDataSource raceDataSource = new RaceXMLReader("mockXML/raceTest.xml", boatDataSource); RaceDataSource raceDataSource = new RaceXMLReader("mockXML/raceTest.xml", boatDataSource);
Race testRace = new Race(raceDataSource, mockOutput); Race testRace = new Race(raceDataSource, mockOutput);
testRace.initialiseBoats(); testRace.initialiseBoats();
Boat testBoat = testRace.startingBoats.get(0); Boat testBoat = testRace.getBoats().get(0);
testBoat.setCurrentLeg(START_LEG); testBoat.setCurrentLeg(START_LEG);
testBoat.setDistanceTravelledInLeg(START_LEG_DISTANCE - 1); testBoat.setDistanceTravelledInLeg(START_LEG_DISTANCE - 1);
testBoat.setCurrentPosition(ORIGIN.getAverageGPSCoordinate()); testBoat.setCurrentPosition(ORIGIN.getAverageGPSCoordinate());
testRace.updatePosition(testBoat, 100); testRace.updatePosition(testBoat, 100, 100);
assertFalse(testBoat.getCurrentPosition() == ORIGIN.getAverageGPSCoordinate()); assertFalse(testBoat.getCurrentPosition() == ORIGIN.getAverageGPSCoordinate());
} catch (ParserConfigurationException | IOException | SAXException | ParseException | StreamedCourseXMLException e) { } catch (ParserConfigurationException | IOException | SAXException | ParseException | StreamedCourseXMLException e) {

@ -0,0 +1,8 @@
Tws,Twa0,Bsp0,Twa1,Bsp1,UpTwa,UpBsp,Twa2,Bsp2,Twa3,Bsp3,Twa4,Bsp4,Twa5,Bsp5,Twa6,Bsp6,DnTwa,DnBsp,Twa7,Bsp7
4,0,0,30,4,45,8,60,9,75,10,90,10,115,10,145,10,155,10,175,4
8,0,0,30,7,43,10,60,11,75,11,90,11,115,12,145,12,153,12,175,10
12,0,0,30,11,43,14.4,60,16,75,20,90,23,115,24,145,23,153,21.6,175,14
16,0,0,30,12,42,19.2,60,25,75,27,90,31,115,32,145,30,153,28.8,175,20
20,0,0,30,13,41,24,60,29,75,37,90,39,115,40,145,38,153,36,175,24
25,0,0,30,15,40,30,60,38,75,44,90,49,115,50,145,49,151,47,175,30
30,0,0,30,15,42,30,60,37,75,42,90,48,115,49,145,48,150,46,175,32
1 Tws Twa0 Bsp0 Twa1 Bsp1 UpTwa UpBsp Twa2 Bsp2 Twa3 Bsp3 Twa4 Bsp4 Twa5 Bsp5 Twa6 Bsp6 DnTwa DnBsp Twa7 Bsp7
2 4 0 0 30 4 45 8 60 9 75 10 90 10 115 10 145 10 155 10 175 4
3 8 0 0 30 7 43 10 60 11 75 11 90 11 115 12 145 12 153 12 175 10
4 12 0 0 30 11 43 14.4 60 16 75 20 90 23 115 24 145 23 153 21.6 175 14
5 16 0 0 30 12 42 19.2 60 25 75 27 90 31 115 32 145 30 153 28.8 175 20
6 20 0 0 30 13 41 24 60 29 75 37 90 39 115 40 145 38 153 36 175 24
7 25 0 0 30 15 40 30 60 38 75 44 90 49 115 50 145 49 151 47 175 30
8 30 0 0 30 15 42 30 60 37 75 42 90 48 115 49 145 48 150 46 175 32

@ -5,6 +5,7 @@ import seng302.Networking.Messages.*;
import java.nio.ByteBuffer; import java.nio.ByteBuffer;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List;
import static seng302.Networking.Utils.ByteConverter.*; import static seng302.Networking.Utils.ByteConverter.*;
@ -32,7 +33,7 @@ public class RaceVisionByteEncoder {
*/ */
public static byte[] raceStatus(RaceStatus raceStatus){ public static byte[] raceStatus(RaceStatus raceStatus){
ArrayList<BoatStatus> boatStatuses = raceStatus.getBoatStatuses(); List<BoatStatus> boatStatuses = raceStatus.getBoatStatuses();
ByteBuffer raceStatusMessage = ByteBuffer.allocate(24 + 20* boatStatuses.size()); ByteBuffer raceStatusMessage = ByteBuffer.allocate(24 + 20* boatStatuses.size());
//Version Number 1 bytes //Version Number 1 bytes

@ -251,7 +251,7 @@ public class BoatLocation extends AC35Data {
* @param angle Angle to convert. double. * @param angle Angle to convert. double.
* @return short representation of heading. * @return short representation of heading.
*/ */
public static short convertTrueWindAngleShortToDouble(double angle) { public static short convertTrueWindAngleDoubleToShort(double angle) {
short angleShort = (short) ((angle / 180.0) * 32768.0); short angleShort = (short) ((angle / 180.0) * 32768.0);

@ -31,10 +31,10 @@ public class BoatStatus {
this.sourceID = sourceID; this.sourceID = sourceID;
this.boatStatus = boatStatusEnum.getValue(); this.boatStatus = boatStatusEnum.getValue();
this.legNumber = ByteConverter.intToBytes(legNum)[0]; this.legNumber = ByteConverter.intToBytes(legNum)[0];
numPenaltiesAwarded = 0; this.numPenaltiesAwarded = 0;
numPenaltiesServed = 0; this.numPenaltiesServed = 0;
estTimeAtFinish = 0; this.estTimeAtFinish = 0;
estTimeAtNextMark = 0; this.estTimeAtNextMark = 0;
} }

@ -0,0 +1,108 @@
package seng302.Networking.Messages.Enums;
import java.util.HashMap;
import java.util.Map;
/**
* Enumeration that encapsulates the various statuses a race can have. See AC35 streaming spec, 4.2.
*/
public enum RaceStatusEnum {
NOT_ACTIVE(0),
/**
* Between 3:00 and 1:00 minutes before start.
*/
WARNING(1),
/**
* Less than 1:00 minutes before start.
*/
PREPARATORY(2),
STARTED(3),
/**
* Obsolete.
*/
FINISHED(4),
/**
* Obsolete.
*/
RETIRED(5),
ABANDONED(6),
POSTPONED(7),
TERMINATED(8),
RACE_START_TIME_NOT_SET(9),
/**
* More than 3:00 minutes until start.
*/
PRESTART(10),
/**
* Used to indicate that a given byte value is invalid.
*/
NOT_A_STATUS(-1);
/**
* Primitive value of the enum.
*/
private byte value;
/**
* Ctor. Creates a RaceStatusEnum from a given primitive integer value, cast to a byte.
* @param value Integer, which is cast to byte, to construct from.
*/
private RaceStatusEnum(int value) {
this.value = (byte) value;
}
/**
* Returns the primitive value of the enum.
* @return Primitive value of the enum.
*/
public byte getValue() {
return value;
}
/**
* Stores a mapping between Byte values and RaceStatusEnum values.
*/
private static final Map<Byte, RaceStatusEnum> byteToStatusMap = new HashMap<>();
/**
* Static initialization block. Initializes the byteToStatusMap.
*/
static {
for (RaceStatusEnum type : RaceStatusEnum.values()) {
RaceStatusEnum.byteToStatusMap.put(type.value, type);
}
}
/**
* Returns the enumeration value which corresponds to a given byte value.
* @param raceStatusByte Byte value to convert to a RaceStatusEnum value.
* @return The RaceStatusEnum value which corresponds to the given byte value.
*/
public static RaceStatusEnum fromByte(byte raceStatusByte) {
//Gets the corresponding MessageType from the map.
RaceStatusEnum type = RaceStatusEnum.byteToStatusMap.get(raceStatusByte);
if (type == null) {
//If the byte value wasn't found, return the NOT_A_STATUS RaceStatusEnum.
return RaceStatusEnum.NOT_A_STATUS;
} else {
//Otherwise, return the RaceStatusEnum.
return type;
}
}
}

@ -0,0 +1,87 @@
package seng302.Networking.Messages.Enums;
import java.util.HashMap;
import java.util.Map;
/**
* Enumeration that encapsulates the various types of races. See AC35 streaming spec, 4.2.
*/
public enum RaceTypeEnum {
/**
* A race between two boats.
*/
MATCH_RACE(1),
/**
* A race between a fleet of boats.
*/
FLEET_RACE(2),
/**
* Used to indicate that a given byte value is invalid.
*/
NOT_A_STATUS(-1);
/**
* Primitive value of the enum.
*/
private byte value;
/**
* Ctor. Creates a RaceTypeEnum from a given primitive integer value, cast to a byte.
* @param value Integer, which is cast to byte, to construct from.
*/
private RaceTypeEnum(int value) {
this.value = (byte) value;
}
/**
* Returns the primitive value of the enum.
* @return Primitive value of the enum.
*/
public byte getValue() {
return value;
}
/**
* Stores a mapping between Byte values and RaceStatusEnum values.
*/
private static final Map<Byte, RaceTypeEnum> byteToStatusMap = new HashMap<>();
/**
* Static initialization block. Initializes the byteToStatusMap.
*/
static {
for (RaceTypeEnum type : RaceTypeEnum.values()) {
RaceTypeEnum.byteToStatusMap.put(type.value, type);
}
}
/**
* Returns the enumeration value which corresponds to a given byte value.
* @param raceTypeEnum Byte value to convert to a RaceTypeEnum value.
* @return The RaceTypeEnum value which corresponds to the given byte value.
*/
public static RaceTypeEnum fromByte(byte raceTypeEnum) {
//Gets the corresponding MessageType from the map.
RaceTypeEnum type = RaceTypeEnum.byteToStatusMap.get(raceTypeEnum);
if (type == null) {
//If the byte value wasn't found, return the NOT_A_STATUS RaceTypeEnum.
return RaceTypeEnum.NOT_A_STATUS;
} else {
//Otherwise, return the RaceTypeEnum.
return type;
}
}
}

@ -3,6 +3,7 @@ package seng302.Networking.Messages;
import seng302.Networking.Messages.Enums.MessageType; import seng302.Networking.Messages.Enums.MessageType;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List;
/** /**
* Created by fwy13 on 25/04/17. * Created by fwy13 on 25/04/17.
@ -16,10 +17,10 @@ public class RaceStatus extends AC35Data {
private int windDirection; private int windDirection;
private int windSpeed; private int windSpeed;
private int raceType; private int raceType;
private ArrayList<BoatStatus> boatStatuses; private List<BoatStatus> boatStatuses;
private static final double windDirectionScalar = 360.0 / 32768.0; // 0x8000 / 360 private static final double windDirectionScalar = 360.0 / 32768.0; // 0x8000 / 360
public RaceStatus(long currentTime, int raceID, int raceStatus, long expectedStartTime, int windDirection, int windSpeed, int raceType, ArrayList<BoatStatus> boatStatuses){ public RaceStatus(long currentTime, int raceID, int raceStatus, long expectedStartTime, int windDirection, int windSpeed, int raceType, List<BoatStatus> boatStatuses){
super(MessageType.RACESTATUS); super(MessageType.RACESTATUS);
this.currentTime = currentTime; this.currentTime = currentTime;
this.raceID = raceID; this.raceID = raceID;
@ -74,7 +75,7 @@ public class RaceStatus extends AC35Data {
return raceType; return raceType;
} }
public ArrayList<BoatStatus> getBoatStatuses() public List<BoatStatus> getBoatStatuses()
{ {
return boatStatuses; return boatStatuses;
} }

@ -1,6 +1,7 @@
package seng302.Controllers; package seng302.Controllers;
import javafx.application.Platform;
import javafx.collections.ObservableList; import javafx.collections.ObservableList;
import javafx.fxml.FXML; import javafx.fxml.FXML;
import javafx.scene.chart.LineChart; import javafx.scene.chart.LineChart;
@ -187,7 +188,14 @@ public class RaceController extends Controller {
//Initialize save annotation array, fps listener, and annotation listeners //Initialize save annotation array, fps listener, and annotation listeners
timeZone.setText(raceClock.getTimeZone()); timeZone.setText(raceClock.getTimeZone());
timer.textProperty().bind(raceClock.durationProperty());
//RaceClock.duration isn't necessarily being changed in the javaFX thread, so we need to runlater the update.
raceClock.durationProperty().addListener((observable, oldValue, newValue) -> {
Platform.runLater(() -> {
timer.setText(newValue);
});
});
initializeFPS(); initializeFPS();
initializeAnnotations(); initializeAnnotations();

@ -54,11 +54,14 @@ public class StartController extends Controller implements Observer {
///Tracks whether the race has been started (that is, has startRaceNoScaling() be called). ///Tracks whether the race has been started (that is, has startRaceNoScaling() be called).
private boolean hasRaceStarted = false; private boolean hasRaceStarted = false;
//Tracks whether or not a clock has been created and setup, which occurs after receiving enough information.
private boolean hasCreatedClock = false;
/** /**
* Begins the race with a scale factor of 1 * Begins the race with a scale factor of 1
*/ */
private void startRaceNoScaling() { private void startRaceNoScaling() {
while(visualiserInput.getRaceStatus() == null);//TODO probably remove this. //while(visualiserInput.getRaceStatus() == null);//TODO probably remove this.
countdownTimer(); countdownTimer();
} }
@ -106,7 +109,14 @@ public class StartController extends Controller implements Observer {
private void setRaceClock() { private void setRaceClock() {
raceClock = new RaceClock(raceData.getZonedDateTime()); raceClock = new RaceClock(raceData.getZonedDateTime());
timeZoneTime.textProperty().bind(raceClock.timeStringProperty());
raceClock.timeStringProperty().addListener((observable, oldValue, newValue) -> {
Platform.runLater(() -> {
timeZoneTime.setText(newValue);
});
});
//TEMP REMOVE
//timeZoneTime.textProperty().bind(raceClock.timeStringProperty());
raceClock.run(); raceClock.run();
} }
@ -116,7 +126,12 @@ public class StartController extends Controller implements Observer {
long utcTime = visualiserInput.getRaceStatus().getExpectedStartTime(); long utcTime = visualiserInput.getRaceStatus().getExpectedStartTime();
raceClock.setStartingTime(raceClock.getLocalTime(utcTime)); raceClock.setStartingTime(raceClock.getLocalTime(utcTime));
raceStartLabel.setText(DateTimeFormatter.ofPattern(dateFormat).format(raceClock.getStartingTime())); raceStartLabel.setText(DateTimeFormatter.ofPattern(dateFormat).format(raceClock.getStartingTime()));
timer.textProperty().bind(raceClock.durationProperty());
raceClock.durationProperty().addListener((observable, oldValue, newValue) -> {
Platform.runLater(() -> {
timer.setText(newValue);
});
});
}); });
} }
@ -138,12 +153,15 @@ public class StartController extends Controller implements Observer {
} }
if (streamedCourse.hasReadCourse()) { if (streamedCourse.hasReadCourse()) {
Platform.runLater(() -> { Platform.runLater(() -> {
if (!this.hasCreatedClock) {
this.hasCreatedClock = true;
setRaceClock(); setRaceClock();
if(visualiserInput.getRaceStatus() == null){ if (visualiserInput.getRaceStatus() == null) {
return;//TEMP BUG FIX if the race isn't sending race status messages (our mock currently doesn't), then it would block the javafx thread with the previous while loop. return;//TEMP BUG FIX if the race isn't sending race status messages (our mock currently doesn't), then it would block the javafx thread with the previous while loop.
}// TODO - replace with observer on VisualiserInput }// TODO - replace with observer on VisualiserInput
setStartingTime(); setStartingTime();
setCurrentTime(); setCurrentTime();
}
}); });
} }

@ -97,6 +97,7 @@ public class BoatXMLReader extends XMLReader {
/** /**
* Reads the information about one boat * Reads the information about one boat
* Ignored values: ShapeID, StoweName, HullNum, Skipper, Type * Ignored values: ShapeID, StoweName, HullNum, Skipper, Type
* @param boat The node to read boat data from.
*/ */
private void readSingleBoat(Node boat) { private void readSingleBoat(Node boat) {
StreamedBoat streamedBoat; StreamedBoat streamedBoat;
@ -127,9 +128,12 @@ public class BoatXMLReader extends XMLReader {
} }
} }
/** /**
* Reads the positional information about a boat * Reads the positional information about a boat
* Ignored values: FlagPosition, MastTop, Z value of GPSposition * Ignored values: FlagPosition, MastTop, Z value of GPSposition
* @param sourceID The source ID of the boat.
* @param GPSPosition The relative GPS position of the boat.
*/ */
private void readBoatPositionInformation(int sourceID, Node GPSPosition) { private void readBoatPositionInformation(int sourceID, Node GPSPosition) {
// TODO Get relative point before implementing. (GPSposition is based off a relative point). // TODO Get relative point before implementing. (GPSposition is based off a relative point).

@ -122,6 +122,7 @@ public class StreamedCourseXMLReader extends XMLReader {
/** /**
* Indexes CompoundMark elements by their ID for use in generating the course, and populates list of Markers. * Indexes CompoundMark elements by their ID for use in generating the course, and populates list of Markers.
* @throws StreamedCourseXMLException if a CompoundMark element contains an unhandled number of compoundMarks.
* @see seng302.Model.Marker * @see seng302.Model.Marker
*/ */
private void readCompoundMarks() throws StreamedCourseXMLException { private void readCompoundMarks() throws StreamedCourseXMLException {

@ -84,6 +84,7 @@ public class StreamedRace implements Runnable {
int legNumber = boatStatusMessage.getLegNumber(); int legNumber = boatStatusMessage.getLegNumber();
if (legNumber >= 1 && legNumber < legs.size()) { if (legNumber >= 1 && legNumber < legs.size()) {
if (boat.getCurrentLeg() != legs.get(legNumber)){ if (boat.getCurrentLeg() != legs.get(legNumber)){
boat.setCurrentLeg(legs.get(legNumber)); boat.setCurrentLeg(legs.get(legNumber));
@ -99,7 +100,6 @@ public class StreamedRace implements Runnable {
boatsFinished++; boatsFinished++;
boat.setTimeFinished(timeElapsed); boat.setTimeFinished(timeElapsed);
boat.setFinished(true); boat.setFinished(true);
//System.out.println("Boat finished");
} }
} }
if (legChanged) { if (legChanged) {

@ -59,6 +59,8 @@ public class RaceClock implements Runnable {
this.time = time; this.time = time;
this.timeString.set(DateTimeFormatter.ofPattern("HH:mm:ss dd/MM/YYYY Z").format(time)); this.timeString.set(DateTimeFormatter.ofPattern("HH:mm:ss dd/MM/YYYY Z").format(time));
this.lastTime = System.currentTimeMillis(); this.lastTime = System.currentTimeMillis();
if(startingTime != null) { if(startingTime != null) {
long seconds = Duration.between(startingTime.toLocalDateTime(), time.toLocalDateTime()).getSeconds(); long seconds = Duration.between(startingTime.toLocalDateTime(), time.toLocalDateTime()).getSeconds();
if(seconds < 0) if(seconds < 0)
@ -66,6 +68,7 @@ public class RaceClock implements Runnable {
else else
duration.set(String.format("Time: %02d:%02d:%02d", seconds/3600, (seconds%3600)/60, seconds%60)); duration.set(String.format("Time: %02d:%02d:%02d", seconds/3600, (seconds%3600)/60, seconds%60));
} }
} }
/** /**

@ -304,6 +304,7 @@ public class ResizableRaceCanvas extends ResizableCanvas {
/** /**
* Draws all track points for a given boat. Colour is set by boat, opacity by track point. * Draws all track points for a given boat. Colour is set by boat, opacity by track point.
* @param boat whose track is displayed * @param boat whose track is displayed
* @param colour The color to use for the track.
* @see seng302.Model.TrackPoint * @see seng302.Model.TrackPoint
*/ */
private void drawTrack(Boat boat, Color colour) { private void drawTrack(Boat boat, Color colour) {

@ -148,6 +148,7 @@ public class VisualiserInput implements Runnable {
/** /**
* Sets the wind direction for the current course. * Sets the wind direction for the current course.
* @param direction The new wind direction for the course.
*/ */
private void setCourseWindDirection(double direction) { private void setCourseWindDirection(double direction) {
this.course.setWindDirection(direction); this.course.setWindDirection(direction);

Loading…
Cancel
Save