alchemist/it.unibo.alchemist.boundary.gps.loaders.ais/AISPayload

AISPayload

data class AISPayload(val vesselMMSI: Int, val timestamp: Instant, val latitude: Double? = null, val longitude: Double? = null, val courseOverGroundDegrees: Double? = null, val speedOverGroundKnots: Double? = null, val headingDegrees: Double? = null, val navigationalStatus: AISNavigationStatus? = null, val imoNumber: Long? = null, val vesselName: String? = null, val callsign: String? = null, val shipType: AISShipType? = null, val dimensionToBow: Int? = null, val dimensionToStern: Int? = null, val dimensionToPort: Int? = null, val dimensionToStarboard: Int? = null, val draughtMeters: Double? = null, val destination: String? = null, val eta: Instant? = null, val positionAccuracy: Double? = null, val rateOfTurn: Double? = null, val isEquippedWithRAIM: Boolean? = null, val positioningDevice: Int? = null, val dataTerminalReady: Int? = null, val vendorId: String? = null) : Comparable<AISPayload>

Decoded AIS message data.

Position data is optional: AIS messages can carry static vessel information without coordinates.

Constructors

constructor(vesselMMSI: Int, timestamp: Instant, latitude: Double? = null, longitude: Double? = null, courseOverGroundDegrees: Double? = null, speedOverGroundKnots: Double? = null, headingDegrees: Double? = null, navigationalStatus: AISNavigationStatus? = null, imoNumber: Long? = null, vesselName: String? = null, callsign: String? = null, shipType: AISShipType? = null, dimensionToBow: Int? = null, dimensionToStern: Int? = null, dimensionToPort: Int? = null, dimensionToStarboard: Int? = null, draughtMeters: Double? = null, destination: String? = null, eta: Instant? = null, positionAccuracy: Double? = null, rateOfTurn: Double? = null, isEquippedWithRAIM: Boolean? = null, positioningDevice: Int? = null, dataTerminalReady: Int? = null, vendorId: String? = null)

Types

object Companion

Static factory for AISPayload.

Properties

val callsign: String?

callsign of the vessel.

courseOverGroundDegrees

val courseOverGroundDegrees: Double?

course over ground, expressed in degrees.

courseOverGroundRadians

val courseOverGroundRadians: Double?

course over ground, expressed in radians.

dataTerminalReady

val dataTerminalReady: Int?

AIS data terminal ready flag.

val destination: String?

destination manually entered in AIS.

val dimensionToBow: Int?

distance from AIS antenna to the bow, in meters.

dimensionToPort

val dimensionToPort: Int?

distance from AIS antenna to port, in meters.

dimensionToStarboard

val dimensionToStarboard: Int?

distance from AIS antenna to starboard, in meters.

dimensionToStern

val dimensionToStern: Int?

distance from AIS antenna to the stern, in meters.

val draughtMeters: Double?

current draught, in meters.

val eta: Instant?

estimated time of arrival.

val hasPosition: Boolean

whether both latitude and longitude are available.

val headingDegrees: Double?

vessel heading, expressed in degrees.

val headingRadians: Double?

vessel heading, expressed in radians.

val imoNumber: Long?

IMO number of the vessel.

isEquippedWithRAIM

val isEquippedWithRAIM: Boolean?

whether AIS reports receiver autonomous integrity monitoring.

val latitude: Double?

latitude of the vessel, when available.

val longitude: Double?

longitude of the vessel, when available.

navigationalStatus

val navigationalStatus: AISNavigationStatus?

AIS navigational status.

positionAccuracy

val positionAccuracy: Double?

raw AIS position accuracy flag.

positioningDevice

val positioningDevice: Int?

AIS positioning device code.

val rateOfTurn: Double?

rate of turn, expressed according to the AIS library conversion.

val shipType: AISShipType?

AIS ship type.

speedOverGroundKnots

val speedOverGroundKnots: Double?

speed over ground, expressed in knots.

speedOverGroundMetersPerSecond

val speedOverGroundMetersPerSecond: Double?

speed over ground, expressed in meters per second.

val timestamp: Instant

the timestamp related to the receipt or content of the message.

val vendorId: String?

vendor identifier from AIS static data.

val vesselMMSI: Int

AIS MMSI.

val vesselName: String?

name of the vessel.

Functions

open operator override fun compareTo(other: AISPayload): Int