dk.dma.ais.message

Class AisMessage18

java.lang.Object

dk.dma.ais.message.AisMessage

dk.dma.ais.message.AisMessage18

All Implemented Interfaces:

IPositionMessage, IVesselPositionMessage, Serializable

public class AisMessage18
extends AisMessage
implements IVesselPositionMessage

AIS message 18

CLASS B position report implemented according to ITU-R M.1371-4

See Also:

Serialized Form

Field Summary

Fields inherited from class dk.dma.ais.message.AisMessage

msgId, repeat, userId, VALID_MESSAGE_TYPES, vdm

Constructor Summary

Constructors

Constructor and Description
AisMessage18() Instantiates a new Ais message 18.
AisMessage18(Vdm vdm) Instantiates a new Ais message 18.

Method Summary

Modifier and Type	Method and Description
int	getClassBBandFlag() Gets class b band flag.
int	getClassBDisplayFlag() Gets class b display flag.
int	getClassBDscFlag() Gets class b dsc flag.
int	getClassBMsg22Flag() Gets class b msg 22 flag.
int	getClassBUnitFlag() Gets class b unit flag.
int	getCog() Course over ground
int	getCommState() Gets comm state.
int	getCommStateSelectorFlag() Gets comm state selector flag.
SixbitEncoder	getEncoded() Abstract method to be implemented by all extending classes
int	getModeFlag() Gets mode flag.
AisPosition	getPos() Get position
int	getPosAcc() Position accuracy
int	getRaim() Get raim
int	getSog() Speed over ground
int	getSpare() Gets spare.
int	getSpareAfterUserId() Gets spare after user id.
int	getTrueHeading() True heading
int	getUtcSec() UTC sec
dk.dma.enav.model.geometry.Position	getValidPosition() Returns a valid position if this message has a valid position, otherwise null.
boolean	isCogValid() Course over ground valid
boolean	isHeadingValid() Heading valid
boolean	isPositionValid() Determine if position is valid
boolean	isSogValid() Speed over ground valid
void	parse() Parse.
void	setClassBBandFlag(int classBBandFlag) Sets class b band flag.
void	setClassBDisplayFlag(int classBDisplayFlag) Sets class b display flag.
void	setClassBDscFlag(int classBDscFlag) Sets class b dsc flag.
void	setClassBMsg22Flag(int classBMsg22Flag) Sets class b msg 22 flag.
void	setClassBUnitFlag(int classBUnitFlag) Sets class b unit flag.
void	setCog(int cog) Sets cog.
void	setCommState(int commState) Sets comm state.
void	setCommStateSelectorFlag(int commStateSelectorFlag) Sets comm state selector flag.
void	setModeFlag(int modeFlag) Sets mode flag.
void	setPos(AisPosition pos) Sets pos.
void	setPosAcc(int posAcc) Sets pos acc.
void	setRaim(int raim) Sets raim.
void	setSog(int sog) Sets sog.
void	setSpare(int spare) Sets spare.
void	setSpareAfterUserId(int spareAfterUserId) Sets spare after user id.
void	setTrueHeading(int trueHeading) Sets true heading.
void	setUtcSec(int utcSec) Sets utc sec.
String	toString()

Methods inherited from class dk.dma.ais.message.AisMessage

encode, getInstance, getMsgId, getRepeat, getSourceTag, getTags, getTargetType, getUserId, getVdm, parse, reassemble, setRepeat, setTag, setTags, setUserId, trimText

Methods inherited from class java.lang.Object

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

Constructor Detail

AisMessage18

public AisMessage18()

Instantiates a new Ais message 18.

AisMessage18

public AisMessage18(Vdm vdm)
             throws AisMessageException,
                    SixbitException

Instantiates a new Ais message 18.

Parameters:

vdm - the vdm

Throws:

AisMessageException - the ais message exception

SixbitException - the sixbit exception

Method Detail

parse

public void parse()
           throws AisMessageException,
                  SixbitException

Parse.

Throws:

AisMessageException - the ais message exception

SixbitException - the sixbit exception

getEncoded

public SixbitEncoder getEncoded()

Description copied from class: AisMessage

Abstract method to be implemented by all extending classes

Specified by:

getEncoded in class AisMessage

Returns:

SixbitEncoder encoded

getSpareAfterUserId

public int getSpareAfterUserId()

Gets spare after user id.

Returns:

the spareAfterUserId

setSpareAfterUserId

public void setSpareAfterUserId(int spareAfterUserId)

Sets spare after user id.

Parameters:

spareAfterUserId - the spareAfterUserId to set

getSog

public int getSog()

Description copied from interface: IVesselPositionMessage

Speed over ground

Specified by:

getSog in interface IVesselPositionMessage

Returns:

the sog

setSog

public void setSog(int sog)

Sets sog.

Parameters:

sog - the sog to set

getPosAcc

public int getPosAcc()

Description copied from interface: IPositionMessage

Position accuracy

Specified by:

getPosAcc in interface IPositionMessage

Returns:

the posAcc

setPosAcc

public void setPosAcc(int posAcc)

Sets pos acc.

Parameters:

posAcc - the posAcc to set

getPos

public AisPosition getPos()

Description copied from interface: IPositionMessage

Get position

Specified by:

getPos in interface IPositionMessage

Returns:

the pos

getValidPosition

public dk.dma.enav.model.geometry.Position getValidPosition()

Description copied from class: AisMessage

Returns a valid position if this message has a valid position, otherwise null.

Specified by:

getValidPosition in interface IVesselPositionMessage

Overrides:

getValidPosition in class AisMessage

Returns:

a valid position if this message has a valid position, otherwise null

setPos

public void setPos(AisPosition pos)

Sets pos.

Parameters:

pos - the pos to set

getCog

public int getCog()

Description copied from interface: IVesselPositionMessage

Course over ground

Specified by:

getCog in interface IVesselPositionMessage

Returns:

the cog

setCog

public void setCog(int cog)

Sets cog.

Parameters:

cog - the cog to set

getTrueHeading

public int getTrueHeading()

Description copied from interface: IVesselPositionMessage

True heading

Specified by:

getTrueHeading in interface IVesselPositionMessage

Returns:

the trueHeading

setTrueHeading

public void setTrueHeading(int trueHeading)

Sets true heading.

Parameters:

trueHeading - the trueHeading to set

getUtcSec

public int getUtcSec()

Description copied from interface: IVesselPositionMessage

UTC sec

Specified by:

getUtcSec in interface IVesselPositionMessage

Returns:

the utcSec

setUtcSec

public void setUtcSec(int utcSec)

Sets utc sec.

Parameters:

utcSec - the utcSec to set

getSpare

public int getSpare()

Gets spare.

Returns:

the spare

setSpare

public void setSpare(int spare)

Sets spare.

Parameters:

spare - the spare to set

getClassBUnitFlag

public int getClassBUnitFlag()

Gets class b unit flag.

Returns:

the classBUnitFlag

setClassBUnitFlag

public void setClassBUnitFlag(int classBUnitFlag)

Sets class b unit flag.

Parameters:

classBUnitFlag - the classBUnitFlag to set

getClassBDisplayFlag

public int getClassBDisplayFlag()

Gets class b display flag.

Returns:

the classBDisplayFlag

setClassBDisplayFlag

public void setClassBDisplayFlag(int classBDisplayFlag)

Sets class b display flag.

Parameters:

classBDisplayFlag - the classBDisplayFlag to set

getClassBDscFlag

public int getClassBDscFlag()

Gets class b dsc flag.

Returns:

the classBDscFlag

setClassBDscFlag

public void setClassBDscFlag(int classBDscFlag)

Sets class b dsc flag.

Parameters:

classBDscFlag - the classBDscFlag to set

getClassBBandFlag

public int getClassBBandFlag()

Gets class b band flag.

Returns:

the classBBandFlag

setClassBBandFlag

public void setClassBBandFlag(int classBBandFlag)

Sets class b band flag.

Parameters:

classBBandFlag - the classBBandFlag to set

getClassBMsg22Flag

public int getClassBMsg22Flag()

Gets class b msg 22 flag.

Returns:

the classBMsg22Flag

setClassBMsg22Flag

public void setClassBMsg22Flag(int classBMsg22Flag)

Sets class b msg 22 flag.

Parameters:

classBMsg22Flag - the classBMsg22Flag to set

getModeFlag

public int getModeFlag()

Gets mode flag.

Returns:

the modeFlag

setModeFlag

public void setModeFlag(int modeFlag)

Sets mode flag.

Parameters:

modeFlag - the modeFlag to set

getRaim

public int getRaim()

Description copied from interface: IVesselPositionMessage

Get raim

Specified by:

getRaim in interface IVesselPositionMessage

Returns:

the raimFlag

setRaim

public void setRaim(int raim)

Sets raim.

Parameters:

raim - the raim

getCommStateSelectorFlag

public int getCommStateSelectorFlag()

Gets comm state selector flag.

Returns:

the commStateSelectorFlag

setCommStateSelectorFlag

public void setCommStateSelectorFlag(int commStateSelectorFlag)

Sets comm state selector flag.

Parameters:

commStateSelectorFlag - the commStateSelectorFlag to set

getCommState

public int getCommState()

Gets comm state.

Returns:

the commState

setCommState

public void setCommState(int commState)

Sets comm state.

Parameters:

commState - the commState to set

toString

public String toString()

Overrides:

toString in class AisMessage

isPositionValid

public boolean isPositionValid()

Description copied from interface: IVesselPositionMessage

Determine if position is valid

Specified by:

isPositionValid in interface IVesselPositionMessage

Returns:

boolean

isCogValid

public boolean isCogValid()

Description copied from interface: IVesselPositionMessage

Course over ground valid

Specified by:

isCogValid in interface IVesselPositionMessage

Returns:

boolean

isSogValid

public boolean isSogValid()

Description copied from interface: IVesselPositionMessage

Speed over ground valid

Specified by:

isSogValid in interface IVesselPositionMessage

Returns:

boolean

isHeadingValid

public boolean isHeadingValid()

Description copied from interface: IVesselPositionMessage

Heading valid

Specified by:

isHeadingValid in interface IVesselPositionMessage

Returns:

boolean