dk.dma.ais.sentence

Class Abk

java.lang.Object

dk.dma.ais.sentence.Sentence

dk.dma.ais.sentence.ParametricSentence

dk.dma.ais.sentence.Abk

public class Abk
extends ParametricSentence

Addressed Binary Acknowledgement as defined by IEC 61162

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Abk.Result Type of acknowledgement

Field Summary

Fields inherited from class dk.dma.ais.sentence.Sentence

checksum, commentBlock, delimiter, encodedFields, formatter, msgChecksum, mssisTimestamp, orgLines, rawSentences, sentenceStr, tags, talker

Constructor Summary

Constructors

Constructor and Description
Abk() Instantiates a new Abk.

Method Summary

Modifier and Type	Method and Description
Character	getChannel() Gets channel.
int	getDestination() Gets destination.
String	getEncoded() Get the encoded sentence
int	getMsgId() Gets msg id.
Abk.Result	getResult() Gets result.
int	getSequence() Gets sequence.
static boolean	isAbk(String line) Is abk boolean.
boolean	isSuccess() Returns if result indicates success
int	parse(SentenceLine sl) Parse method.
void	setChannel(Character channel) Sets channel.
void	setDestination(int destination) Sets destination.
void	setMsgId(int msgId) Sets msg id.
void	setResult(Abk.Result result) Sets result.
void	setSequence(int sequence) Sets sequence.
String	toString()

Methods inherited from class dk.dma.ais.sentence.ParametricSentence

baseParse

Methods inherited from class dk.dma.ais.sentence.Sentence

addSingleCommentBlock, convert, encode, finalEncode, findMssisTimestamp, getChecksum, getCommentBlock, getMssisTimestamp, getOrgLines, getOrgLinesJoined, getRawSentences, getRawSentencesJoined, getSourceTag, getStringChecksum, getTags, getTimestamp, hasSentence, parseInt, setDelimiter, setFormatter, setTag, setTags, setTalker

Methods inherited from class java.lang.Object

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

Constructor Detail

Abk

public Abk()

Instantiates a new Abk.

Method Detail

isAbk

public static boolean isAbk(String line)

Is abk boolean.

Parameters:

line - the line

Returns:

the boolean

parse

public int parse(SentenceLine sl)
          throws SentenceException

Parse method. Will always return 0 as sentence will always be in a single line.

Specified by:

parse in class Sentence

Parameters:

sl - the sl

Returns:

0 Complete packet - 1 Incomplete packet

Throws:

SentenceException - the sentence exception

getEncoded

public String getEncoded()

Get the encoded sentence

Specified by:

getEncoded in class Sentence

Returns:

encoded

isSuccess

public boolean isSuccess()

Returns if result indicates success

Returns:

success boolean

getDestination

public int getDestination()

Gets destination.

Returns:

the destination

setDestination

public void setDestination(int destination)

Sets destination.

Parameters:

destination - the destination

getChannel

public Character getChannel()

Gets channel.

Returns:

the channel

setChannel

public void setChannel(Character channel)

Sets channel.

Parameters:

channel - the channel

getMsgId

public int getMsgId()

Gets msg id.

Returns:

the msg id

setMsgId

public void setMsgId(int msgId)

Sets msg id.

Parameters:

msgId - the msg id

getSequence

public int getSequence()

Gets sequence.

Returns:

the sequence

setSequence

public void setSequence(int sequence)

Sets sequence.

Parameters:

sequence - the sequence

getResult

public Abk.Result getResult()

Gets result.

Returns:

the result

setResult

public void setResult(Abk.Result result)

Sets result.

Parameters:

result - the result

toString

public String toString()

Overrides:

toString in class Object