au.gov.amsa.ais

Class AisNmeaMessage

java.lang.Object

au.gov.amsa.ais.AisNmeaMessage

public class AisNmeaMessage
extends Object

Wraps an NMEA line containing an AIS message with accessor methods.

Author:

dxm

Constructor Summary

Constructors

Constructor and Description
AisNmeaMessage(NmeaMessage nmea)
AisNmeaMessage(String line) Constructor.

Method Summary

Modifier and Type	Method and Description
static AisNmeaMessage	from(String line)
String	getChannel() Returns the channel.
String	getChecksum() Returns the checksum (last field in the NMEA line).
String	getFormat() Returns the NMEA format (from the first column after the tag block if it exists).
int	getFragmentCount() Returns the count of fragments.
int	getFragmentNumber() Returns the current fragment number.
AisMessage	getMessage() Returns the parsed contents of column 5 of the AIS NMEA line.
NmeaMessage	getNmea()
int	getPadBits()
String	getSequentialMessageId() Returns the sequential message id.
Talker	getTalker() Returns the Talker corresponding to the first two characters of the message format type (e.g.
Long	getTime() Returns the tag block unix time value.
Timestamped<AisMessage>	getTimestampedMessage()
Timestamped<AisMessage>	getTimestampedMessage(long defaultTime)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AisNmeaMessage

public AisNmeaMessage(String line)

Constructor.

Parameters:

line - is an NMEA line containing an AIS message.

AisNmeaMessage

public AisNmeaMessage(NmeaMessage nmea)

Method Detail

from

public static AisNmeaMessage from(String line)

getTime

public Long getTime()

Returns the tag block unix time value.

Returns:

getTalker

public Talker getTalker()

Returns the Talker corresponding to the first two characters of the message format type (e.g. AIVDM -> AI).

Returns:

getFormat

public String getFormat()

Returns the NMEA format (from the first column after the tag block if it exists).

Returns:

getFragmentCount

public int getFragmentCount()

Returns the count of fragments.

Returns:

getFragmentNumber

public int getFragmentNumber()

Returns the current fragment number.

Returns:

getSequentialMessageId

public String getSequentialMessageId()

Returns the sequential message id.

Returns:

getChannel

public String getChannel()

Returns the channel.

Returns:

getPadBits

public int getPadBits()

getMessage

public AisMessage getMessage()

Returns the parsed contents of column 5 of the AIS NMEA line.

Returns:

getTimestampedMessage

public Timestamped<AisMessage> getTimestampedMessage(long defaultTime)

getTimestampedMessage

public Timestamped<AisMessage> getTimestampedMessage()

getChecksum

public String getChecksum()

Returns the checksum (last field in the NMEA line).

Returns:

getNmea

public NmeaMessage getNmea()