dk.dma.ais.sentence

Class EncapsulatedSentence

java.lang.Object

dk.dma.ais.sentence.Sentence

dk.dma.ais.sentence.EncapsulatedSentence

Direct Known Subclasses:

SendSentence, Vdm

public abstract class EncapsulatedSentence
extends Sentence

Abstract base class for encapsulating sentences VDM, ABM and BBM

Field Summary

Fields

Modifier and Type	Field and Description
protected BinArray	binArray The Bin array.
protected Character	channel The Channel.
protected boolean	completePacket The Complete packet.
protected int	msgId The Msg id.
protected int	num The Num.
protected int	padBits The Pad bits.
protected Integer	sequence The Sequence.
protected StringBuilder	sixbitString The Sixbit string.
protected int	total The Total.

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
EncapsulatedSentence()

Method Summary

Modifier and Type	Method and Description
protected void	baseParse(SentenceLine sl) Base parse method to be used by extending classes
protected void	encode() Encode method to be used by extending classes
BinArray	getBinArray() Get binary encapsulated data
Character	getChannel() Gets channel.
int	getMsgId() Gets msg id.
int	getNum() Get sentence number
int	getPadBits() Gets pad bits.
int	getSequence() Gets sequence.
String	getSixbitString() Gets sixbit string.
int	getTotal() Get total number of actual sentences
boolean	isCompletePacket() Is complete packet boolean.
void	setBinArray(BinArray binArray) Set binary encapsulated data
void	setChannel(Character channel) Sets channel.
void	setEncodedMessage(SixbitEncoder encoder) Set binary part and pad bits from encoder
void	setMessageData(AisMessage aisMessage) Set the binary encapsulated data from AIS message
void	setMsgId(int msgId) Sets msg id.
void	setNum(int num) Sets num.
void	setPadBits(int padBits) Sets pad bits.
void	setSequence(int sequence) Sets sequence.
void	setSixbitString(String sixbitString) Set the six bit string of the sentence
void	setTotal(int total) Sets total.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

msgId

protected int msgId

The Msg id.

total

protected int total

The Total.

sequence

protected Integer sequence

The Sequence.

num

protected int num

The Num.

channel

protected Character channel

The Channel.

binArray

protected BinArray binArray

The Bin array.

completePacket

protected boolean completePacket

The Complete packet.

sixbitString

protected StringBuilder sixbitString

The Sixbit string.

padBits

protected int padBits

The Pad bits.

Constructor Detail

EncapsulatedSentence

public EncapsulatedSentence()

Method Detail

baseParse

protected void baseParse(SentenceLine sl)
                  throws SentenceException

Base parse method to be used by extending classes

Overrides:

baseParse in class Sentence

Parameters:

sl - the sl

Throws:

SentenceException - the sentence exception

encode

protected void encode()

Encode method to be used by extending classes

Overrides:

encode in class Sentence

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

getTotal

public int getTotal()

Get total number of actual sentences

Returns:

number of sentences

setTotal

public void setTotal(int total)

Sets total.

Parameters:

total - the total

getNum

public int getNum()

Get sentence number

Returns:

num

setNum

public void setNum(int num)

Sets num.

Parameters:

num - the num

getChannel

public Character getChannel()

Gets channel.

Returns:

the channel

setChannel

public void setChannel(Character channel)

Sets channel.

Parameters:

channel - the channel

getBinArray

public BinArray getBinArray()

Get binary encapsulated data

Returns:

bin array

setBinArray

public void setBinArray(BinArray binArray)

Set binary encapsulated data

Parameters:

binArray - the bin array

setEncodedMessage

public void setEncodedMessage(SixbitEncoder encoder)
                       throws SixbitException

Set binary part and pad bits from encoder

Parameters:

encoder - the encoder

Throws:

SixbitException - the sixbit exception

setMessageData

public void setMessageData(AisMessage aisMessage)
                    throws SixbitException

Set the binary encapsulated data from AIS message

Parameters:

aisMessage - the ais message

Throws:

SixbitException - the sixbit exception

getPadBits

public int getPadBits()

Gets pad bits.

Returns:

the pad bits

isCompletePacket

public boolean isCompletePacket()

Is complete packet boolean.

Returns:

is complete packet has been received

setSixbitString

public void setSixbitString(String sixbitString)

Set the six bit string of the sentence

Parameters:

sixbitString - the sixbit string

setPadBits

public void setPadBits(int padBits)

Sets pad bits.

Parameters:

padBits - the pad bits

getSixbitString

public String getSixbitString()

Gets sixbit string.

Returns:

the sixbit string