Final commit for yacht refactor

tags: #story[1124] #pair[hyi25, wmu16]
2026-05-09 06:18:44 +00:00 · 2017-08-15 14:49:16 +12:00
parent 2dc0ba07d9
commit c125708a4a
7 changed files with 76 additions and 75 deletions
@@ -0,0 +1,258 @@
+package seng302.model;
+
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Observable;
+import java.util.Observer;
+import javafx.beans.property.ReadOnlyDoubleProperty;
+import javafx.beans.property.ReadOnlyDoubleWrapper;
+import javafx.beans.property.ReadOnlyLongProperty;
+import javafx.beans.property.ReadOnlyLongWrapper;
+import javafx.scene.paint.Color;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import seng302.model.mark.CompoundMark;
+
+/**
+ * Yacht class for the racing boat. <p> Class created to store more variables (eg. boat statuses)
+ * compared to the XMLParser boat class, also done outside Boat class because some old variables are
+ * not used anymore.
+ */
+public class ClientYacht extends Observable {
+
+    @FunctionalInterface
+    public interface YachtLocationListener {
+
+        void notifyLocation(ClientYacht clientYacht, double lat, double lon, double heading,
+            double velocity);
+    }
+
+    private Logger logger = LoggerFactory.getLogger(ClientYacht.class);
+
+
+    //BOTH AFAIK
+    private String boatType;
+    private Integer sourceId;
+    private String hullID; //matches HullNum in the XML spec.
+    private String shortName;
+    private String boatName;
+    private String country;
+
+    private Long estimateTimeAtFinish;
+    private Integer currentMarkSeqID = 0;
+    private Long markRoundTime;
+    private Long timeTillNext;
+    private Double heading;
+    private Integer legNumber = 0;
+    private GeoPoint location;
+    private Integer boatStatus;
+    private Double currentVelocity;
+
+    //CLIENT SIDE
+    private List<YachtLocationListener> locationListeners = new ArrayList<>();
+    private ReadOnlyDoubleWrapper velocityProperty = new ReadOnlyDoubleWrapper();
+    private ReadOnlyLongWrapper timeTillNextProperty = new ReadOnlyLongWrapper();
+    private ReadOnlyLongWrapper timeSinceLastMarkProperty = new ReadOnlyLongWrapper();
+    private CompoundMark lastMarkRounded;
+    private Integer positionInt = 0;
+    private Color colour;
+
+    public ClientYacht(String boatType, Integer sourceId, String hullID, String shortName,
+        String boatName, String country) {
+        this.boatType = boatType;
+        this.sourceId = sourceId;
+        this.hullID = hullID;
+        this.shortName = shortName;
+        this.boatName = boatName;
+        this.country = country;
+        this.location = new GeoPoint(57.670341, 11.826856);
+        this.heading = 120.0;   //In degrees
+        this.currentVelocity = 0d;
+    }
+
+    /**
+     * Add ServerToClientThread as the observer, this observer pattern mainly server for the boat
+     * rounding package.
+     */
+    @Override
+    public void addObserver(Observer o) {
+        super.addObserver(o);
+    }
+
+    public String getBoatType() {
+        return boatType;
+    }
+
+    public Integer getSourceId() {
+        //@TODO Remove and merge with Creating Game Loop
+        if (sourceId == null) {
+            return 0;
+        }
+        return sourceId;
+    }
+
+    public String getHullID() {
+        if (hullID == null) {
+            return "";
+        }
+        return hullID;
+    }
+
+    public String getShortName() {
+        return shortName;
+    }
+
+    public String getBoatName() {
+        return boatName;
+    }
+
+    public String getCountry() {
+        if (country == null) {
+            return "";
+        }
+        return country;
+    }
+
+    public Integer getBoatStatus() {
+        return boatStatus;
+    }
+
+    public void setBoatStatus(Integer boatStatus) {
+        this.boatStatus = boatStatus;
+    }
+
+    public Integer getLegNumber() {
+        return legNumber;
+    }
+
+    public void setLegNumber(Integer legNumber) {
+        this.legNumber = legNumber;
+    }
+
+    public void setEstimateTimeTillNextMark(Long estimateTimeTillNextMark) {
+        timeTillNext = estimateTimeTillNextMark;
+    }
+
+    public String getEstimateTimeAtFinish() {
+        DateFormat format = new SimpleDateFormat("dd/MM/yyyy HH:mm:ss");
+        return format.format(estimateTimeAtFinish);
+    }
+
+    public void setEstimateTimeAtFinish(Long estimateTimeAtFinish) {
+        this.estimateTimeAtFinish = estimateTimeAtFinish;
+    }
+
+    public Integer getPositionInteger() {
+        return positionInt;
+    }
+
+    public void setPositionInteger(Integer position) {
+        this.positionInt = position;
+    }
+
+    public void updateVelocityProperty(double velocity) {
+        this.velocityProperty.set(velocity);
+    }
+
+    public void setMarkRoundingTime(Long markRoundingTime) {
+        this.markRoundTime = markRoundingTime;
+    }
+
+    public ReadOnlyDoubleProperty getVelocityProperty() {
+        return velocityProperty.getReadOnlyProperty();
+    }
+
+    public ReadOnlyLongProperty timeTillNextProperty() {
+        return timeTillNextProperty.getReadOnlyProperty();
+    }
+
+    public Long getTimeTillNext() {
+        return timeTillNext;
+    }
+
+    public Long getMarkRoundTime() {
+        return markRoundTime;
+    }
+
+    public CompoundMark getLastMarkRounded() {
+        return lastMarkRounded;
+    }
+
+    public void setLastMarkRounded(CompoundMark lastMarkRounded) {
+        this.lastMarkRounded = lastMarkRounded;
+    }
+
+    public GeoPoint getLocation() {
+        return location;
+    }
+
+    /**
+     * Sets the current location of the boat in lat and long whilst preserving the last location
+     *
+     * @param lat Latitude
+     * @param lng Longitude
+     */
+    public void setLocation(Double lat, Double lng) {
+        location.setLat(lat);
+        location.setLng(lng);
+    }
+
+    public Double getHeading() {
+        return heading;
+    }
+
+    public void setHeading(Double heading) {
+        this.heading = heading;
+    }
+
+    @Override
+    public String toString() {
+        return boatName;
+    }
+
+    public void updateTimeSinceLastMarkProperty(long timeSinceLastMark) {
+        this.timeSinceLastMarkProperty.set(timeSinceLastMark);
+    }
+
+    public ReadOnlyLongProperty timeSinceLastMarkProperty() {
+        return timeSinceLastMarkProperty.getReadOnlyProperty();
+    }
+
+    public void setTimeTillNext(Long timeTillNext) {
+        this.timeTillNext = timeTillNext;
+    }
+
+
+    public Color getColour() {
+        return colour;
+    }
+
+    public void setColour(Color colour) {
+        this.colour = colour;
+    }
+
+//    public Double getCurrentVelocity() {
+//        return currentVelocity;
+//    }
+//
+//    public void setCurrentVelocity(Double currentVelocity) {
+//        this.currentVelocity = currentVelocity;
+//    }
+
+
+    public void updateLocation(double lat, double lng, double heading, double velocity) {
+        setLocation(lat, lng);
+        this.heading = heading;
+//        this.currentVelocity = velocity;
+        updateVelocityProperty(velocity);
+        for (YachtLocationListener yll : locationListeners) {
+            yll.notifyLocation(this, lat, lng, heading, velocity);
+        }
+    }
+
+    public void addLocationListener(YachtLocationListener listener) {
+        locationListeners.add(listener);
+    }
+}