Module dk.tbsalling.ais.messages

Package dk.tbsalling.aismessages.ais.messages

Class ShipAndVoyageData

java.lang.Object

dk.tbsalling.aismessages.ais.messages.AISMessage

dk.tbsalling.aismessages.ais.messages.ShipAndVoyageData

All Implemented Interfaces:

CachedDecodedValues, DataReport, StaticDataReport, Serializable

public class ShipAndVoyageData
extends AISMessage
implements StaticDataReport

Message has a total of 424 bits, occupying two AIVDM sentences. In practice, the information in these fields (especially ETA and destination) is not reliable, as it has to be hand-updated by humans rather than gathered automatically from sensors.

Author:

tbsalling

See Also:

Serialized Form

Field Summary

Fields inherited from class dk.tbsalling.aismessages.ais.messages.AISMessage

VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
	ShipAndVoyageData(dk.tbsalling.aismessages.nmea.messages.NMEAMessage[] nmeaMessages)
protected	ShipAndVoyageData(dk.tbsalling.aismessages.nmea.messages.NMEAMessage[] nmeaMessages, String bitString)

Method Summary

Modifier and Type	Method	Description
protected void	checkAISMessage()	This method performs a rudimentary sanity check of the AIS data payload contained in the NMEA sentence(s).
String	getCallsign()
Boolean	getDataTerminalReady()
String	getDestination()
Float	getDraught()
String	getEta()	Deprecated.
Integer	getEtaDay()
Integer	getEtaHour()
Integer	getEtaMinute()
Integer	getEtaMonth()
Optional<ZonedDateTime>	getEtaAfterReceived()
IMO	getImo()
AISMessageType	getMessageType()
PositionFixingDevice	getPositionFixingDevice()
Integer	getRawDraught()
String	getShipName()
ShipType	getShipType()
Integer	getToBow()
Integer	getToPort()
Integer	getToStarboard()
Integer	getToStern()
TransponderClass	getTransponderClass()
String	toString()

Methods inherited from class dk.tbsalling.aismessages.ais.messages.AISMessage

create, create, dataFields, decodePayloadToBitString, digest, equals, getBits, getBitString, getMetadata, getNmeaMessages, getNmeaTagBlock, getNumberOfBits, getRepeatIndicator, getSourceMmsi, getZeroBitStuffedString, hashCode, isValid, setMetadata, setTagBlock, tagBlockToString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dk.tbsalling.aismessages.ais.messages.CachedDecodedValues

getDecodedValue, getDecodedValueByWeakReference

Constructor Details

ShipAndVoyageData

public ShipAndVoyageData(dk.tbsalling.aismessages.nmea.messages.NMEAMessage[] nmeaMessages)

ShipAndVoyageData

protected ShipAndVoyageData(dk.tbsalling.aismessages.nmea.messages.NMEAMessage[] nmeaMessages, String bitString)

Method Details

checkAISMessage

protected void checkAISMessage()

Description copied from class: AISMessage

This method performs a rudimentary sanity check of the AIS data payload contained in the NMEA sentence(s). These tests are mainly based on bitwise message length, even though other types of tests may occur.

Overrides:

checkAISMessage in class AISMessage

getMessageType

public final AISMessageType getMessageType()

Specified by:

getMessageType in class AISMessage

getTransponderClass

public TransponderClass getTransponderClass()

Specified by:

getTransponderClass in interface DataReport

getImo

public IMO getImo()

getCallsign

public String getCallsign()

Specified by:

getCallsign in interface StaticDataReport

getShipName

public String getShipName()

Specified by:

getShipName in interface StaticDataReport

getShipType

public ShipType getShipType()

Specified by:

getShipType in interface StaticDataReport

getToBow

public Integer getToBow()

Specified by:

getToBow in interface StaticDataReport

getToStern

public Integer getToStern()

Specified by:

getToStern in interface StaticDataReport

getToStarboard

public Integer getToStarboard()

Specified by:

getToStarboard in interface StaticDataReport

getToPort

public Integer getToPort()

Specified by:

getToPort in interface StaticDataReport

getPositionFixingDevice

public PositionFixingDevice getPositionFixingDevice()

getEtaMonth

public Integer getEtaMonth()

Returns:

The UTC ETA Month (1-12) 0 = not available.

getEtaDay

public Integer getEtaDay()

Returns:

The UTC ETA Day (1-31) 0 = not available.

getEtaHour

public Integer getEtaHour()

Returns:

The UTC ETA Hour (0-23) 24 = not available.

getEtaMinute

public Integer getEtaMinute()

Returns:

The UTC ETA Minute (0-59) 60 = not available.

getEta

@Deprecated public String getEta()

Deprecated.

getEtaAfterReceived

public Optional<ZonedDateTime> getEtaAfterReceived()

Returns:

The vessel AIS ETA, with the year filled in based on the metadata received time. If the AIS Month and day are the received date or later, the first calendar date after the received is used for the year. Unavailable hour (24) or minute (60) will be treated as 0 Examples: Received on 2018-06-01 and ETA AIS is 06-03, this will return 2018-06-03 Received on 2018-12-31 and ETA AIS is 01-02, this will return 2019-01-02 Received on 2018-06-01 and ETA AIS is 05-31, this will return 2019-05-31 Received on 2018-06-01 and ETA AIS is 06-03 24:00, this will return 2018-06-01 00:00 Received on 2018-06-01 and ETA AIS is 06-03 12:60, this will return 2018-06-03 12:00

getDraught

public Float getDraught()

getRawDraught

public Integer getRawDraught()

getDestination

public String getDestination()

getDataTerminalReady

public Boolean getDataTerminalReady()

toString

public String toString()

Overrides:

toString in class AISMessage