LocationData (GPS Survey 2.0.0 API)

java.lang.Object
- uk.theretiredprogrammer.gpssurvey.informationstore.LocationData

```
public class LocationData
extends Object
```
The Location Data Class. Central register of current location data.

Author:

Richard Linsdale (richard at theretiredprogrammer.uk)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LocationData.Location
The data object holding current location information

Nested Classes
Modifier and Type	Class and Description
`static class`	`LocationData.Location` The data object holding current location information

Constructor Summary

Constructors
Modifier Constructor and Description

protected LocationData()
Constructor

protected LocationData(GPSMessageConsolidator.ConsolidatedGPSData gpsdata)
Constructor

Constructors
Modifier	Constructor and Description
`protected`	`LocationData()` Constructor
`protected`	`LocationData(GPSMessageConsolidator.ConsolidatedGPSData gpsdata)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPoint()` Add the current location to the track
`void`	`addStartEndPoints()` Add the current track to the start and end point lists.
`void`	`clearStartPosition()` Clear the start position (of a track)
`Altitude`	`getAltitude()` Get the current altitude
`Position`	`getCurrentFromEnd()` Get the relative position of the current position relation to the end point of the last recorded track.
`Position`	`getCurrentFromLastPoint()` Get the current position relation to the last position recorded on the track.
`Position`	`getCurrentFromPoint(int i)` Get the current position relation to a selected position recorded on the track.
`Position`	`getCurrentFromStart()` Get the relative position of the current position relative to the start position of the current track.
`String`	`getDatedisplay()` Get the gps date
`Depth`	`getDepth()` Get the current depth
`List<Position>`	`getEndPoints()` Get a set of end points for recorded tracks.
`Position`	`getFirstStartEnd()` Get the position of the first end point relative to first start point.
`HDOP`	`getHDOP()` Get the current HDOP
`double`	`getHeading()` Get the current course.
`String`	`getIsodatedisplay()` Get the gps date
`String`	`getIsotimedisplay()` Get the gps time
`double`	`getKnots()` Get the current speed (in knots)
`LocationData.Location`	`getLocation()` Get the current location.
`Position`	`getPointFromPreviousPoint(int i)` Get the position of a point on the track relative to the previous point on the track.
`List<Position>`	`getPoints()` Get the set of position which are recorded as the current track
`int`	`getPointsSize()` Get the size of the track
`Position`	`getPosition()` Get the current position
`LocationData.Location`	`getReferenceLocation()` Get the Reference location
`double`	`getSpeed()` Get the current speed.
`int`	`getStartEndPointsSize()` Get the number of tracks recorded.
`List<Position>`	`getStartPoints()` Get the set of start points for recorded tracks.
`Position`	`getStartPosition()` Get the start position (of a track)
`String`	`getTimedisplay()` Get the gps time
`boolean`	`hasNoPoints()` test if track has no points defined.
`boolean`	`hasNoStartEndPoints()` Test if any tracks have been recorded.
`boolean`	`isRecording()` Test if recording is in progress.
`protected LocationData`	`setLocation(GPSMessageConsolidator.ConsolidatedGPSData gpsdata)` Update the Location data with new gps data.
`void`	`setRecording(boolean recording)` Set recording state.
`protected LocationData`	`setReferenceLocation(LocationData.Location location)` Set the reference location
`void`	`setStartPosition()` Set the start position (of a track)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LocationData
```
protected LocationData()
```
    Constructor
  - LocationData
```
protected LocationData(GPSMessageConsolidator.ConsolidatedGPSData gpsdata)
```
    Constructor
    
    Parameters:
    
    gpsdata - the gps data to used to define the location
- Method Detail
  - setLocation
```
protected final LocationData setLocation(GPSMessageConsolidator.ConsolidatedGPSData gpsdata)
```
    Update the Location data with new gps data.
    
    Parameters:
    
    gpsdata - the gps data to used to define the location
    
    Returns:
    
    this location data object
  - setReferenceLocation
```
protected final LocationData setReferenceLocation(LocationData.Location location)
```
    Set the reference location
    
    Parameters:
    
    location - the reference location.
    
    Returns:
    
    this location data object
  - getDatedisplay
```
public final String getDatedisplay()
```
    Get the gps date
    
    Returns:
    
    the GPS date
  - getIsodatedisplay
```
public final String getIsodatedisplay()
```
    Get the gps date
    
    Returns:
    
    the GPS data in yyymmdd format
  - getTimedisplay
```
public final String getTimedisplay()
```
    Get the gps time
    
    Returns:
    
    the gps time
  - getIsotimedisplay
```
public final String getIsotimedisplay()
```
    Get the gps time
    
    Returns:
    
    the GPS time in hhmmss format
  - getLocation
```
public final LocationData.Location getLocation()
```
    Get the current location.
    
    Returns:
    
    the current location
  - getHeading
```
public final double getHeading()
```
    Get the current course.
    
    Returns:
    
    the current course
  - getSpeed
```
public final double getSpeed()
```
    Get the current speed.
    
    Returns:
    
    the current speed.
  - getKnots
```
public final double getKnots()
```
    Get the current speed (in knots)
    
    Returns:
    
    the current speed (in knots)
  - getPosition
```
public final Position getPosition()
```
    Get the current position
    
    Returns:
    
    the current position
  - getHDOP
```
public final HDOP getHDOP()
```
    Get the current HDOP
    
    Returns:
    
    the current HDOP
  - getAltitude
```
public final Altitude getAltitude()
```
    Get the current altitude
    
    Returns:
    
    the current altitude
  - getDepth
```
public final Depth getDepth()
```
    Get the current depth
    
    Returns:
    
    the current depth
  - getReferenceLocation
```
public final LocationData.Location getReferenceLocation()
```
    Get the Reference location
    
    Returns:
    
    the reference location
  - getStartPosition
```
public final Position getStartPosition()
```
    Get the start position (of a track)
    
    Returns:
    
    the start position
  - setStartPosition
```
public final void setStartPosition()
```
    Set the start position (of a track)
  - clearStartPosition
```
public final void clearStartPosition()
```
    Clear the start position (of a track)
  - getPoints
```
public final List<Position> getPoints()
```
    Get the set of position which are recorded as the current track
    
    Returns:
    
    list of positions
  - getCurrentFromLastPoint
```
public final Position getCurrentFromLastPoint()
```
    Get the current position relation to the last position recorded on the track.
    
    Returns:
    
    the current position
  - getCurrentFromPoint
```
public final Position getCurrentFromPoint(int i)
```
    Get the current position relation to a selected position recorded on the track.
    
    Parameters:
    
    i - the index of the position on the track to be used as origin position
    
    Returns:
    
    the current position
  - getPointFromPreviousPoint
```
public final Position getPointFromPreviousPoint(int i)
```
    Get the position of a point on the track relative to the previous point on the track.
    
    Parameters:
    
    i - the index of the position on the track to be calculated
    
    Returns:
    
    the indexed items relative position
  - hasNoPoints
```
public final boolean hasNoPoints()
```
    test if track has no points defined.
    
    Returns:
    
    true if track is empty
  - getPointsSize
```
public final int getPointsSize()
```
    Get the size of the track
    
    Returns:
    
    the number of points in the track
  - addPoint
```
public final void addPoint()
```
    Add the current location to the track
  - getStartPoints
```
public final List<Position> getStartPoints()
```
    Get the set of start points for recorded tracks.
    
    Returns:
    
    list of start points
  - getEndPoints
```
public final List<Position> getEndPoints()
```
    Get a set of end points for recorded tracks.
    
    Returns:
    
    list of end points
  - addStartEndPoints
```
public final void addStartEndPoints()
```
    Add the current track to the start and end point lists.
  - getFirstStartEnd
```
public final Position getFirstStartEnd()
```
    Get the position of the first end point relative to first start point.
    
    Returns:
    
    the relative position of the first end point
  - getCurrentFromStart
```
public final Position getCurrentFromStart()
```
    Get the relative position of the current position relative to the start position of the current track.
    
    Returns:
    
    the current position
  - getCurrentFromEnd
```
public final Position getCurrentFromEnd()
```
    Get the relative position of the current position relation to the end point of the last recorded track.
    
    Returns:
    
    the current position
  - hasNoStartEndPoints
```
public final boolean hasNoStartEndPoints()
```
    Test if any tracks have been recorded.
    
    Returns:
    
    true if no tracks have yet been recorded
  - getStartEndPointsSize
```
public final int getStartEndPointsSize()
```
    Get the number of tracks recorded.
    
    Returns:
    
    the number of tracks recorded.
  - isRecording
```
public final boolean isRecording()
```
    Test if recording is in progress.
    
    Returns:
    
    true if recording is in progress
  - setRecording
```
public final void setRecording(boolean recording)
```
    Set recording state.
    
    Parameters:
    
    recording - true if recording to start

Class LocationData

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LocationData

LocationData

Method Detail

setLocation

setReferenceLocation

getDatedisplay

getIsodatedisplay

getTimedisplay

getIsotimedisplay

getLocation

getHeading

getSpeed

getKnots

getPosition

getHDOP

getAltitude

getDepth

getReferenceLocation

getStartPosition

setStartPosition

clearStartPosition

getPoints

getCurrentFromLastPoint

getCurrentFromPoint

getPointFromPreviousPoint

hasNoPoints

getPointsSize

addPoint

getStartPoints

getEndPoints

addStartEndPoints

getFirstStartEnd

getCurrentFromStart

getCurrentFromEnd

hasNoStartEndPoints

getStartEndPointsSize

isRecording

setRecording