Improved documentation

Author: tsmarques

src/main/java/pt/lsts/aismanager/ShipAisSnapshot.java

@@ -19,20 +19,20 @@ public class ShipAisSnapshot {
      * Create a snapshot of ship's AIS information
      *
      * @param mmsi Maritime Mobile Service Identity
-     * @param sog Speed over ground
-     * @param cog Course over ground
-     * @param heading Heading
+     * @param sogKnots Speed over ground in knots
+     * @param cogRads Course over ground in radians
+     * @param headingRads Heading in radians
      * @param latRads Latitude in radians
      * @param lonRads Longitude in radians
      * @param timestampMs Timestamp in Milliseconds
      * @param label AIS label
      * */
-    public ShipAisSnapshot(int mmsi, double sog, double cog, double heading, double latRads, double lonRads,
+    public ShipAisSnapshot(int mmsi, double sogKnots, double cogRads, double headingRads, double latRads, double lonRads,
                            long timestampMs, String label) {
         this.mmsi = mmsi;
-        this.sog = sog;
-        this.cog = cog;
-        this.heading = heading;
+        this.sog = sogKnots;
+        this.cog = cogRads;
+        this.heading = headingRads;
         this.latRads = latRads;
         this.lonRads = lonRads;
         this.timestampMs = timestampMs;
@@ -68,7 +68,7 @@ public double getCog() {
     }
 
     /**
-     * Ship's Heading
+     * Ship's Heading in radians
      * */
     public double getHeading() {
         return heading;
@@ -88,10 +88,16 @@ public double getLonRads() {
         return lonRads;
     }
 
+    /**
+     * Ship's latitude in degrees
+     * */
     public double getLatDegs() {
         return Math.toDegrees(latRads);
     }
 
+    /**
+     * Ship's longitude in degrees
+     * */
     public double getLonDegs() {
         return Math.toDegrees(lonRads);
     }

src/main/java/pt/lsts/aismanager/api/AisContactManager.java

@@ -35,9 +35,12 @@ private AisContactManager() {
      */
     private final HashMap<Integer, Deque<ShipAisSnapshot>> snapshots = new HashMap<>();
 
-    public void setShipPosition(int mmsi, double sog, double cog, double heading, double latRads, double lonRads,
+    /***
+     *
+     * */
+    public void setShipPosition(int mmsi, double sogKnots, double cog, double heading, double latRads, double lonRads,
                                 long timestamp, String label) {
-        ShipAisSnapshot shipSnapshot = new ShipAisSnapshot(mmsi, sog, cog, heading, latRads, lonRads, timestamp, label);
+        ShipAisSnapshot shipSnapshot = new ShipAisSnapshot(mmsi, sogKnots, cog, heading, latRads, lonRads, timestamp, label);
 
         synchronized (manager.snapshots) {
             Deque<ShipAisSnapshot> stack = manager.snapshots.get(mmsi);