dk.dma.ais.packet

Class AisPacket

java.lang.Object

dk.dma.ais.packet.AisPacket

All Implemented Interfaces:

Comparable<AisPacket>

@NotThreadSafe
public class AisPacket
extends Object
implements Comparable<AisPacket>

Encapsulation of the VDM lines containing a single AIS message including leading proprietary tags and comment/tag blocks.

Author:

Kasper Nielsen

Method Summary

Modifier and Type	Method and Description
int	compareTo(AisPacket p)
static AisPacket	from(String stringMessage) From ais packet.
static AisPacket	fromByteArray(byte[] array) From byte array ais packet.
static AisPacket	fromByteBuffer(ByteBuffer buffer) From byte buffer ais packet.
AisMessage	getAisMessage() Try to get AIS message from packet
long	getBestTimestamp() Returns the timestamp of the packet, or -1 if no timestamp is available.
String	getStringMessage() Gets string message.
List<String>	getStringMessageLines() Gets string message lines.
AisPacketTags	getTags() Returns the tags of the packet.
Date	getTimestamp() Try to get timestamp for packet.
Vdm	getVdm() Get existing VDM or parse one from message string
boolean	isValidMessage() Check if VDM contains a valid AIS message
static AisPacket	readFromString(String messageString) Construct AisPacket from raw packet string
byte[]	toByteArray() To byte array byte [ ].
AisMessage	tryGetAisMessage() Try get ais message ais message.
dk.dma.enav.model.geometry.PositionTime	tryGetPositionTime() Try get position time position time.

Methods inherited from class java.lang.Object

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

Method Detail

fromByteBuffer

public static AisPacket fromByteBuffer(ByteBuffer buffer)

From byte buffer ais packet.

Parameters:

buffer - the buffer

Returns:

the ais packet

fromByteArray

public static AisPacket fromByteArray(byte[] array)

From byte array ais packet.

Parameters:

array - the array

Returns:

the ais packet

toByteArray

public byte[] toByteArray()

To byte array byte [ ].

Returns:

the byte [ ]

getBestTimestamp

public long getBestTimestamp()

Returns the timestamp of the packet, or -1 if no timestamp is available.

Returns:

the timestamp of the packet, or -1 if no timestamp is available

getStringMessage

public String getStringMessage()

Gets string message.

Returns:

the string message

getStringMessageLines

public List<String> getStringMessageLines()

Gets string message lines.

Returns:

the string message lines

getVdm

public Vdm getVdm()

Get existing VDM or parse one from message string

Returns:

Vdm vdm

getTags

public AisPacketTags getTags()

Returns the tags of the packet.

Returns:

the tags of the packet

tryGetAisMessage

public AisMessage tryGetAisMessage()

Try get ais message ais message.

Returns:

the ais message

getAisMessage

public AisMessage getAisMessage()
                         throws AisMessageException,
                                SixbitException

Try to get AIS message from packet

Returns:

ais message

Throws:

AisMessageException - the ais message exception

SixbitException - the sixbit exception

isValidMessage

public boolean isValidMessage()

Check if VDM contains a valid AIS message

Returns:

boolean boolean

getTimestamp

public Date getTimestamp()

Try to get timestamp for packet.

Returns:

timestamp timestamp

tryGetPositionTime

public dk.dma.enav.model.geometry.PositionTime tryGetPositionTime()

Try get position time position time.

Returns:

the position time

from

public static AisPacket from(String stringMessage)

From ais packet.

Parameters:

stringMessage - the string message

Returns:

the ais packet

readFromString

public static AisPacket readFromString(String messageString)
                                throws SentenceException

Construct AisPacket from raw packet string

Parameters:

messageString - the message string

Returns:

ais packet

Throws:

SentenceException - the sentence exception

compareTo

public int compareTo(AisPacket p)

Specified by:

compareTo in interface Comparable<AisPacket>