dk.dma.ais.message

Class AisMessage19

java.lang.Object

dk.dma.ais.message.AisMessage

dk.dma.ais.message.AisStaticCommon

dk.dma.ais.message.AisMessage19

All Implemented Interfaces:

IDimensionMessage, INameMessage, IPositionMessage, IVesselPositionMessage, Serializable

public class AisMessage19
extends AisStaticCommon
implements IVesselPositionMessage

AIS message 19

Extended Class B equipment position report as defined by ITU-R M.1371-4

See Also:

Serialized Form

Field Summary

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

callsign, dimBow, dimPort, dimStarboard, dimStern, name, shipType

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

msgId, repeat, userId, VALID_MESSAGE_TYPES, vdm

Constructor Summary

Constructors

Constructor and Description
AisMessage19() Instantiates a new Ais message 19.
AisMessage19(Vdm vdm) Instantiates a new Ais message 19.

Method Summary

Modifier and Type	Method and Description
int	getCog() Course over ground
int	getDte() Gets dte.
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	getPosType() Gets pos type.
int	getRaim() Get raim
int	getRaimFlag() Gets raim flag.
int	getSog() Speed over ground
int	getSpare1() Gets spare 1.
int	getSpare2() Gets spare 2.
int	getSpare3() Gets spare 3.
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
protected void	parse(BinArray binArray) Base parse method to be called by all extending classes
void	setCog(int cog) Sets cog.
void	setDte(int dte) Sets dte.
void	setModeFlag(int modeFlag) Sets mode flag.
void	setPos(AisPosition pos) Sets pos.
void	setPosAcc(int posAcc) Sets pos acc.
void	setPosType(int posType) Sets pos type.
void	setRaimFlag(int raimFlag) Sets raim flag.
void	setSog(int sog) Sets sog.
void	setSpare1(int spare1) Sets spare 1.
void	setSpare2(int spare2) Sets spare 2.
void	setSpare3(int spare3) Sets spare 3.
void	setTrueHeading(int trueHeading) Sets true heading.
void	setUtcSec(int utcSec) Sets utc sec.
String	toString()

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

getCallsign, getDimBow, getDimPort, getDimStarboard, getDimStern, getName, getShipType, setCallsign, setDimBow, setDimPort, setDimStarboard, setDimStern, setName, setShipType

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

encode, getInstance, getMsgId, getRepeat, getSourceTag, getTags, getTargetType, getUserId, getVdm, 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

AisMessage19

public AisMessage19()

Instantiates a new Ais message 19.

AisMessage19

public AisMessage19(Vdm vdm)
             throws AisMessageException,
                    SixbitException

Instantiates a new Ais message 19.

Parameters:

vdm - the vdm

Throws:

AisMessageException - the ais message exception

SixbitException - the sixbit exception

Method Detail

parse

protected void parse(BinArray binArray)
              throws AisMessageException,
                     SixbitException

Description copied from class: AisMessage

Base parse method to be called by all extending classes

Overrides:

parse in class AisMessage

Parameters:

binArray - the bin array

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

toString

public String toString()

Overrides:

toString in class AisMessage

getSpare1

public int getSpare1()

Gets spare 1.

Returns:

the spare 1

setSpare1

public void setSpare1(int spare1)

Sets spare 1.

Parameters:

spare1 - the spare 1

getSog

public int getSog()

Description copied from interface: IVesselPositionMessage

Speed over ground

Specified by:

getSog in interface IVesselPositionMessage

Returns:

sog

setSog

public void setSog(int sog)

Sets sog.

Parameters:

sog - the sog

getPosAcc

public int getPosAcc()

Description copied from interface: IPositionMessage

Position accuracy

Specified by:

getPosAcc in interface IPositionMessage

Returns:

pos acc

setPosAcc

public void setPosAcc(int posAcc)

Sets pos acc.

Parameters:

posAcc - the pos acc

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

getPos

public AisPosition getPos()

Description copied from interface: IPositionMessage

Get position

Specified by:

getPos in interface IPositionMessage

Returns:

pos

setPos

public void setPos(AisPosition pos)

Sets pos.

Parameters:

pos - the pos

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

getTrueHeading

public int getTrueHeading()

Description copied from interface: IVesselPositionMessage

True heading

Specified by:

getTrueHeading in interface IVesselPositionMessage

Returns:

true heading

setTrueHeading

public void setTrueHeading(int trueHeading)

Sets true heading.

Parameters:

trueHeading - the true heading

getUtcSec

public int getUtcSec()

Description copied from interface: IVesselPositionMessage

UTC sec

Specified by:

getUtcSec in interface IVesselPositionMessage

Returns:

utc sec

setUtcSec

public void setUtcSec(int utcSec)

Sets utc sec.

Parameters:

utcSec - the utc sec

getSpare2

public int getSpare2()

Gets spare 2.

Returns:

the spare 2

setSpare2

public void setSpare2(int spare2)

Sets spare 2.

Parameters:

spare2 - the spare 2

getPosType

public int getPosType()

Gets pos type.

Returns:

the pos type

setPosType

public void setPosType(int posType)

Sets pos type.

Parameters:

posType - the pos type

getRaimFlag

public int getRaimFlag()

Gets raim flag.

Returns:

the raim flag

setRaimFlag

public void setRaimFlag(int raimFlag)

Sets raim flag.

Parameters:

raimFlag - the raim flag

getDte

public int getDte()

Gets dte.

Returns:

the dte

setDte

public void setDte(int dte)

Sets dte.

Parameters:

dte - the dte

getModeFlag

public int getModeFlag()

Gets mode flag.

Returns:

the mode flag

setModeFlag

public void setModeFlag(int modeFlag)

Sets mode flag.

Parameters:

modeFlag - the mode flag

getSpare3

public int getSpare3()

Gets spare 3.

Returns:

the spare 3

setSpare3

public void setSpare3(int spare3)

Sets spare 3.

Parameters:

spare3 - the spare 3

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

getRaim

public int getRaim()

Description copied from interface: IVesselPositionMessage

Get raim

Specified by:

getRaim in interface IVesselPositionMessage

Returns:

raim