From e3d958087b33124122608f7ba7cb202c72f82612 Mon Sep 17 00:00:00 2001
From: Richard Cordovano <rcordovano@basistech.com>
Date: Mon, 9 Mar 2020 11:40:36 -0400
Subject: [PATCH] Update geo artifacts util docs
---
.../blackboardutils/GeoArtifactsHelper.java | 6 +--
.../attributes/TskGeoTrackpointsUtil.java | 7 ++-
.../attributes/TskGeoWaypointsUtil.java | 43 ++++++++-----------
3 files changed, 23 insertions(+), 33 deletions(-)
diff --git a/bindings/java/src/org/sleuthkit/datamodel/blackboardutils/GeoArtifactsHelper.java b/bindings/java/src/org/sleuthkit/datamodel/blackboardutils/GeoArtifactsHelper.java
index 28a74d3e5..838c8e601 100755
--- a/bindings/java/src/org/sleuthkit/datamodel/blackboardutils/GeoArtifactsHelper.java
+++ b/bindings/java/src/org/sleuthkit/datamodel/blackboardutils/GeoArtifactsHelper.java
@@ -112,9 +112,9 @@ public BlackboardArtifact addTrack(String trackName, GeoTrackPointList trackPoin
/**
* Adds a TSK_GPS_ROUTE artifact to the case database. A Global Positioning
* System (GPS) route artifact records one or more waypoints entered into a
- * GPS-enabled device as a route as a route to be navigated from waypoint to
- * waypoint. A waypoint is a location in a geographic coordinate system with
- * latitude, longitude and altitude (elevation) axes.
+ * GPS-enabled device as a route to be navigated from waypoint to waypoint.
+ * A waypoint is a location in a geographic coordinate system with latitude,
+ * longitude and altitude (elevation) axes.
*
* @param routeName The name of the GPS route, may be null.
* @param creationTime The time at which the route was created as
diff --git a/bindings/java/src/org/sleuthkit/datamodel/blackboardutils/attributes/TskGeoTrackpointsUtil.java b/bindings/java/src/org/sleuthkit/datamodel/blackboardutils/attributes/TskGeoTrackpointsUtil.java
index 4ef1879a4..44cf09216 100755
--- a/bindings/java/src/org/sleuthkit/datamodel/blackboardutils/attributes/TskGeoTrackpointsUtil.java
+++ b/bindings/java/src/org/sleuthkit/datamodel/blackboardutils/attributes/TskGeoTrackpointsUtil.java
@@ -33,9 +33,9 @@
* GeoTrackPoint represents a track point, which is a location in a geographic
* coordinate system with latitude, longitude and altitude (elevation) axes.
*
- * A TSK_GPS_TRACK artifact uses a TSK_GEO_TRACKPOINTS attribute to record a
- * track, or path, of a GPS-enabled device as a connected series of track points
- * .
+ * TSK_GEO_TRACKPOINTS attributes are used by TSK_GPS_TRACK artifacts to record
+ * a track, or path, of a GPS-enabled device as a connected series of track
+ * points.
*/
public final class TskGeoTrackpointsUtil implements BlackboardAttributeUtil<TskGeoTrackpointsUtil.GeoTrackPointList> {
@@ -263,7 +263,6 @@ public Double getDistanceFromHomePoint() {
* Gets the distance the device has traveled in meters at the time
* this track point was created, if known.
*
- *
* @return The distance traveled in meters, may be null or zero.
*/
public Double getDistanceTraveled() {
diff --git a/bindings/java/src/org/sleuthkit/datamodel/blackboardutils/attributes/TskGeoWaypointsUtil.java b/bindings/java/src/org/sleuthkit/datamodel/blackboardutils/attributes/TskGeoWaypointsUtil.java
index d4689050d..a8d4a5e10 100755
--- a/bindings/java/src/org/sleuthkit/datamodel/blackboardutils/attributes/TskGeoWaypointsUtil.java
+++ b/bindings/java/src/org/sleuthkit/datamodel/blackboardutils/attributes/TskGeoWaypointsUtil.java
@@ -28,13 +28,15 @@
/**
* A utility class for converting between a TSK_GEO_WAYPOINTS attribute and a
- * GeoWaypointList. A GeoWaypointList is a collection of GeoWaypoints. A
- * GeoWaypoint represents a waypoint, which is a location in a geographic
- * coordinate system with latitude, longitude and altitude (elevation) axes.
+ * GeoWaypointList object. A GeoWaypointList is a collection of GeoWaypoints
+ * objects. A GeoWaypoint represents a waypoint for a GPS-enabled device with a
+ * navigation capability. Every waypoint is a location, possibly named, in a
+ * geographic coordinate system with latitude, longitude and altitude
+ * (elevation) axes.
*
- * A TSK_GPS_ROUTE artifact uses a TSK_GEO_WAYPOINTS attribute to record one or
- * more waypoints entered into a GPS-enabled device as a route to be navigated
- * from waypoint to waypoint.
+ * TSK_GEO_WAYPOINTS attributes are used by TSK_GPS_ROUTE artifacts to record
+ * one or more waypoints linked together as a route to be navigated from
+ * waypoint to waypoint.
*/
public final class TskGeoWaypointsUtil implements BlackboardAttributeUtil<GeoWaypointList> {
@@ -92,9 +94,9 @@ private static String toJSON(GeoWaypointList waypoints) {
}
/**
- * A list of GeoWaypoints. A GeoWaypoint represents a waypoint, which is a
- * location in a geographic coordinate system with latitude, longitude and
- * altitude (elevation) axes.
+ * A list of GeoWaypoints. A GeoWaypoint represents a waypoint, which is a a
+ * location, possibly named, in a geographic coordinate system with
+ * latitude, longitude and altitude (elevation) axes.
*/
public static final class GeoWaypointList implements Iterable<GeoWaypointList.GeoWaypoint> {
@@ -107,17 +109,6 @@ public GeoWaypointList() {
points = new ArrayList<>();
}
-// /**
-// * Adds a point to the list of waypoints.
-// *
-// * @param latitude The latitude, required
-// * @param longitude The longitude, required
-// * @param altitude The altitude, can be null
-// * @param name A name for the point, can be null
-// */
-// public void addPoint(Double latitude, Double longitude, Double altitude, String name) {
-// points.add(new GeoWaypoint(latitude, longitude, altitude, name));
-// }
/**
* Adds a waypoint to this list of waypoints.
*
@@ -146,9 +137,9 @@ public Iterator<GeoWaypointList.GeoWaypoint> iterator() {
}
/**
- * A representation of a waypoint, which is a location in a geographic
- * coordinate system with latitude, longitude and altitude (elevation)
- * axes.
+ * A representation of a waypoint, which is a a location, possibly
+ * named, in a geographic coordinate system with latitude, longitude and
+ * altitude (elevation) axes.
*/
public static class GeoWaypoint {
@@ -158,9 +149,9 @@ public static class GeoWaypoint {
private final String name;
/**
- * Constructs a representation of a track point, which is a location
- * in a geographic coordinate system with latitude, longitude and
- * altitude (elevation) axes.
+ * Constructs a representation of a waypoint, which is a a location,
+ * possibly named, in a geographic coordinate system with latitude,
+ * longitude and altitude (elevation) axes.
*
* @param latitude The latitude of the waypoint.
* @param longitude The longitude of the waypoint.
--
GitLab