Track (AIS Communication 2.4 API)

java.lang.Object
- dk.dma.ais.tracker.Target
- - dk.dma.ais.tracker.eventEmittingTracker.Track

All Implemented Interfaces:

Serializable, Cloneable
```
@ThreadSafe
public final class Track
extends Target
implements Cloneable
```
The Track class contains the consolidated information known about a given target - likely as the result of several received AIS messages.
Track supports dynamic storage of track properties via the getProperty()/setProperty() methods, but also contains some business logic and knowledge of what it stores; e.g. via the getMmsi(), and get/setPosition() methods.
Information which is available directly in AisPackets is stored and retrieved from these. Other information, such as cell-id's, event booking-keeping, etc. is set dynamically as custom properties.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CELL_ID` The constant CELL_ID.
`static String`	`EXTENT` The constant EXTENT.
`static int`	`MAX_AGE_POSITION_REPORTS_MINUTES` The constant MAX_AGE_POSITION_REPORTS_MINUTES.
`static String`	`SAFETY_ZONE` The constant SAFETY_ZONE.

Constructor Summary

Constructors
Constructor and Description

Track(int mmsi)
Create a new track with the given MMSI no.

Constructors
Constructor and Description
`Track(int mmsi)` Create a new track with the given MMSI no.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Track`	`clone()` Deep copy/clone a track
`String`	`getCallsign()` Convenience method to return track's last reported callsign or null @return the callsign
`Float`	`getCourseOverGround()` Convenience method to return track's last reported COG or null @return the course over ground
`Integer`	`getIMO()` Convenience method to return track's last reported IMO no. or null @return the imo
`AisPacket`	`getLastStaticReport()` Return the last received static report (if any) @return the last static report
`TrackingReport`	`getNewestTrackingReport()` Get the most recently reported position report.
`TrackingReport`	`getOldestTrackingReport()` Get the oldest reported position report kept.
`dk.dma.enav.model.geometry.Position`	`getPosition()` Convenience method to return track's last reported position or null @return the position
`Object`	`getProperty(String propertyName)` Get a custom property previously set on this track.
`Integer`	`getShipDimensionBow()` Gets ship dimension bow.
`Integer`	`getShipDimensionPort()` Gets ship dimension port.
`Integer`	`getShipDimensionStarboard()` Gets ship dimension starboard.
`Integer`	`getShipDimensionStern()` Gets ship dimension stern.
`String`	`getShipName()` Convenience method to return track's last reported ship name or null @return the ship name
`Integer`	`getShipType()` Convenience method to return track's last reported ship type or null @return the ship type
`Float`	`getSpeedOverGround()` Convenience method to return track's last reported SOG or null @return the speed over ground
`long`	`getTimeOfLastAisTrackingReport()` Get time timestamp of the last non-predicted position report @return the time of last ais tracking report
`LocalDateTime`	`getTimeOfLastAisTrackingReportTyped()` Get time timestamp of the last non-predicted position report @return the time of last ais tracking report typed
`long`	`getTimeOfLastPositionReport()` Get the timestamp of the last position report.
`LocalDateTime`	`getTimeOfLastPositionReportTyped()` Get the timestamp of the last position report.
`long`	`getTimeOfLastUpdate()` Get the timestamp of the last update of any type.
`LocalDateTime`	`getTimeOfLastUpdateTyped()` Get the timestamp of the last update of any type.
`TrackingReport`	`getTrackingReportAt(long t)` Get the the position report at time t.
`List<TrackingReport>`	`getTrackingReports()` Get a trail of historic position reports.
`Float`	`getTrueHeading()` Convenience method to return track's last reported heading or null @return the true heading
`Integer`	`getVesselBeam()` Convenience method to return track's last reported vessel beam or null @return the vessel beam
`Integer`	`getVesselLength()` Convenience method to return track's last reported vessel length or null @return the vessel length
`int`	`hashCode()`
`void`	`predict(long atTime)` Predict this track's position forward to time atTime.
`void`	`removeProperty(String propertyName)` Remove a custom property previously set on this track.
`void`	`setPositionReportPurgeEnable(boolean positionReportPurgeEnable)` Enable or disable purging of old position reports from the track.
`void`	`setProperty(String propertyName, Object propertyValue)` Attach/set a custom property on this track.
`String`	`toString()`
`void`	`update(AisPacket p)` Update.
`void`	`update(long timestamp, AisMessage m)` Update this track with a new AisPacket.
`void`	`update(long timestamp, dk.dma.enav.model.geometry.Position position, float cog, float sog, float hdg)` Update this track with interpolated or predicted information (as opposed to information received from an AIS receiver or basestation).

Methods inherited from class dk.dma.ais.tracker.Target
equals, getMmsi

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - CELL_ID
```
public static final String CELL_ID
```
    The constant CELL_ID.
    
    See Also:
    
    Constant Field Values
  - SAFETY_ZONE
```
public static final String SAFETY_ZONE
```
    The constant SAFETY_ZONE.
    
    See Also:
    
    Constant Field Values
  - EXTENT
```
public static final String EXTENT
```
    The constant EXTENT.
    
    See Also:
    
    Constant Field Values
  - MAX_AGE_POSITION_REPORTS_MINUTES
```
public static final int MAX_AGE_POSITION_REPORTS_MINUTES
```
    The constant MAX_AGE_POSITION_REPORTS_MINUTES.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Track
```
public Track(int mmsi)
```
    Create a new track with the given MMSI no.
    
    Parameters:
    
    mmsi - the MMSI no. assigned to this track.
- Method Detail
  - clone
```
public Track clone()
            throws CloneNotSupportedException
```
    Deep copy/clone a track
    
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Target
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - update
```
public void update(AisPacket p)
```
    Update.
    
    Parameters:
    
    p - the p
  - update
```
public void update(long timestamp,
                   AisMessage m)
```
    Update this track with a new AisPacket. The MMSI no. inside the packet must match this Track's MMSI no. and in order to maintain low insertion-cost only packets newer than the previously received are accepted.
    This update is treated as an interpolated (artifical, non-real) update.
    
    Parameters:
    
    timestamp - the timestamp
    
    m - the m
  - update
```
public void update(long timestamp,
                   dk.dma.enav.model.geometry.Position position,
                   float cog,
                   float sog,
                   float hdg)
```
    Update this track with interpolated or predicted information (as opposed to information received from an AIS receiver or basestation).
    
    Parameters:
    
    timestamp - the timestamp
    
    position - the position
    
    cog - the cog
    
    sog - the sog
    
    hdg - the hdg
  - getProperty
```
public Object getProperty(String propertyName)
```
    Get a custom property previously set on this track.
    
    Parameters:
    
    propertyName - the property name
    
    Returns:
    
    property property
  - setProperty
```
public void setProperty(String propertyName,
                        Object propertyValue)
```
    Attach/set a custom property on this track.
    
    Parameters:
    
    propertyName - the property name
    
    propertyValue - the property value
  - removeProperty
```
public void removeProperty(String propertyName)
```
    Remove a custom property previously set on this track.
    
    Parameters:
    
    propertyName - the property name
  - getTimeOfLastUpdate
```
public long getTimeOfLastUpdate()
```
    Get the timestamp of the last update of any type. @return the time of last update
    
    Returns:
    
    the time of last update
  - getTimeOfLastUpdateTyped
```
public LocalDateTime getTimeOfLastUpdateTyped()
```
    Get the timestamp of the last update of any type. @return the time of last update typed
    
    Returns:
    
    the time of last update typed
  - getTimeOfLastPositionReport
```
public long getTimeOfLastPositionReport()
```
    Get the timestamp of the last position report. @return the time of last position report
    
    Returns:
    
    the time of last position report
  - getTimeOfLastPositionReportTyped
```
public LocalDateTime getTimeOfLastPositionReportTyped()
```
    Get the timestamp of the last position report. @return the time of last position report typed
    
    Returns:
    
    the time of last position report typed
  - getTimeOfLastAisTrackingReport
```
public long getTimeOfLastAisTrackingReport()
```
    Get time timestamp of the last non-predicted position report @return the time of last ais tracking report
    
    Returns:
    
    the time of last ais tracking report
  - getTimeOfLastAisTrackingReportTyped
```
public LocalDateTime getTimeOfLastAisTrackingReportTyped()
```
    Get time timestamp of the last non-predicted position report @return the time of last ais tracking report typed
    
    Returns:
    
    the time of last ais tracking report typed
  - getLastStaticReport
```
public AisPacket getLastStaticReport()
```
    Return the last received static report (if any) @return the last static report
    
    Returns:
    
    the last static report
  - setPositionReportPurgeEnable
```
public void setPositionReportPurgeEnable(boolean positionReportPurgeEnable)
```
    Enable or disable purging of old position reports from the track.
    
    Parameters:
    
    positionReportPurgeEnable - the position report purge enable
  - getOldestTrackingReport
```
public TrackingReport getOldestTrackingReport()
```
    Get the oldest reported position report kept. @return the oldest tracking report
    
    Returns:
    
    the oldest tracking report
  - getNewestTrackingReport
```
public TrackingReport getNewestTrackingReport()
```
    Get the most recently reported position report. @return the newest tracking report
    
    Returns:
    
    the newest tracking report
  - getTrackingReportAt
```
public TrackingReport getTrackingReportAt(long t)
```
    Get the the position report at time t. @param t the t
    
    Parameters:
    
    t - the t
    
    Returns:
    
    the tracking report at
  - getTrackingReports
```
public List<TrackingReport> getTrackingReports()
```
    Get a trail of historic position reports. The oldest will be a maximum of MAX_AGE_POSITION_REPORTS_MINUTES minutes older than the newest (if position report purging is enabled; otherwise there is no limit).
    
    Returns:
    
    tracking reports
  - predict
```
public void predict(long atTime)
```
    Predict this track's position forward to time atTime.
    
    Parameters:
    
    atTime - timestamp in milliseconds since the Epoch
  - getShipType
```
public Integer getShipType()
```
    Convenience method to return track's last reported ship type or null @return the ship type
    
    Returns:
    
    the ship type
  - getShipName
```
public String getShipName()
```
    Convenience method to return track's last reported ship name or null @return the ship name
    
    Returns:
    
    the ship name
  - getCallsign
```
public String getCallsign()
```
    Convenience method to return track's last reported callsign or null @return the callsign
    
    Returns:
    
    the callsign
  - getIMO
```
public Integer getIMO()
```
    Convenience method to return track's last reported IMO no. or null @return the imo
    
    Returns:
    
    the imo
  - getVesselLength
```
public Integer getVesselLength()
```
    Convenience method to return track's last reported vessel length or null @return the vessel length
    
    Returns:
    
    the vessel length
  - getVesselBeam
```
public Integer getVesselBeam()
```
    Convenience method to return track's last reported vessel beam or null @return the vessel beam
    
    Returns:
    
    the vessel beam
  - getShipDimensionBow
```
public Integer getShipDimensionBow()
```
    Gets ship dimension bow.
    
    Returns:
    
    the ship dimension bow
  - getShipDimensionStern
```
public Integer getShipDimensionStern()
```
    Gets ship dimension stern.
    
    Returns:
    
    the ship dimension stern
  - getShipDimensionPort
```
public Integer getShipDimensionPort()
```
    Gets ship dimension port.
    
    Returns:
    
    the ship dimension port
  - getShipDimensionStarboard
```
public Integer getShipDimensionStarboard()
```
    Gets ship dimension starboard.
    
    Returns:
    
    the ship dimension starboard
  - getPosition
```
public dk.dma.enav.model.geometry.Position getPosition()
```
    Convenience method to return track's last reported position or null @return the position
    
    Returns:
    
    the position
  - getSpeedOverGround
```
public Float getSpeedOverGround()
```
    Convenience method to return track's last reported SOG or null @return the speed over ground
    
    Returns:
    
    the speed over ground
  - getCourseOverGround
```
public Float getCourseOverGround()
```
    Convenience method to return track's last reported COG or null @return the course over ground
    
    Returns:
    
    the course over ground
  - getTrueHeading
```
public Float getTrueHeading()
```
    Convenience method to return track's last reported heading or null @return the true heading
    
    Returns:
    
    the true heading

Class Track

Field Summary

Constructor Summary

Method Summary

Methods inherited from class dk.dma.ais.tracker.Target

Methods inherited from class java.lang.Object

Field Detail

CELL_ID

SAFETY_ZONE

EXTENT

MAX_AGE_POSITION_REPORTS_MINUTES

Constructor Detail

Track

Method Detail

clone

toString

hashCode

update

update

update

getProperty

setProperty

removeProperty

getTimeOfLastUpdate

getTimeOfLastUpdateTyped

getTimeOfLastPositionReport

getTimeOfLastPositionReportTyped

getTimeOfLastAisTrackingReport

getTimeOfLastAisTrackingReportTyped

getLastStaticReport

setPositionReportPurgeEnable

getOldestTrackingReport

getNewestTrackingReport

getTrackingReportAt

getTrackingReports

predict

getShipType

getShipName

getCallsign

getIMO

getVesselLength

getVesselBeam

getShipDimensionBow

getShipDimensionStern

getShipDimensionPort

getShipDimensionStarboard

getPosition

getSpeedOverGround

getCourseOverGround

getTrueHeading