dk.dma.ais.message

Class AisPositionMessage

java.lang.Object

dk.dma.ais.message.AisMessage

dk.dma.ais.message.AisPositionMessage

All Implemented Interfaces:

IPositionMessage, IVesselPositionMessage, Serializable

Direct Known Subclasses:

AisMessage1, AisMessage3

public abstract class AisPositionMessage
extends AisMessage
implements IVesselPositionMessage

AIS position message

An AIS position message is defined by ITU-R M.1371-4 in annex 8 - AIS messages section 3.1

This is a generalization for message types 1-3 and possibly more in the future.

Type 1: Scheduled position report (Class A shipborne mobile equipment) Type 2: Assigned scheduled position report (Class A shipborne mobile equipment) Type 3: Special position report, response to interrogation;(Class A shipborne mobile equipment)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cog Course over Ground Course over ground in 1/10 = (0-3599). 3600 (E10h) = not available = default. 3601-4095 should not be used
protected int	navStatus Navigational status: 0 = under way using engine 1 = at anchor 2 = not under command 3 = restricted manoeuvrability 4 = constrained by her draught 5 = moored 6 = aground 7 = engaged in fishing 8 = under way sailing 9 = reserved for future amendment of navigational status for ships carrying DG, HS, or MP, or IMO hazard or pollutant category C, high speed craft (HSC), 10 = reserved for future amendment of navigational status for ships carrying dangerous goods (DG), harmful substances (HS) or marine pollutants (MP), or IMO hazard or pollutant category A, wing in grand (WIG); 11-13 = reserved for future use 14 = AIS-SART (active) 15 = not defined = default (also used by AIS-SART under test)
protected AisPosition	pos Stores the positions in a general manner
protected int	posAcc AisPosition Accuracy: The position accuracy (PA) flag should be determined in accordance with Table 47 1 = high ( =< 10 m) 0 = low (>10 m) 0 = default
protected int	raim RAIM-flag: Receiver autonomous integrity monitoring (RAIM) flag of electronic position fixing device; 0 = RAIM not in use = default; 1 = RAIM in use.
protected int	rot Rate of Turn (ROT): 0 to +126 = turning right at up to 708 degrees per min or higher 0 to -126 = turning left at up to 708 degrees per min or higher Values between 0 and 708 degrees per min coded by ROTais = 4.733 SQRT(ROTsensor) degrees per min where ROTsensor is the Rate of Turn as input by an external Rate of Turn Indicator (TI).
protected int	sog Speed Over Ground Speed over ground in 1/10 knot steps (0-102.2 knots) 1023 = not available, 1022 = 102.2 knots or higher
protected int	spare Not used.
protected int	specialManIndicator Special manoeuvre indicator: 0 = not available = default 1 = not engaged in special manoeuvre 2 = engaged in special manoeuvre (i.e.: regional passing arrangement on Inland Waterway) NOTE: This field is added in ITU-R M1371-4
protected int	syncState SOTDMA/ITDMA sync state: sync state is part of the defined communication state (19) bits.
protected int	trueHeading True heading Degrees (0-359) (511 indicates not available = default)
protected int	utcSec Time stamp: UTC second when the report was generated by the EPFS (0-59 or 60 if time stamp is not available, which should also be the default value or 61 if positioning system is in manual input mode or 62 if electronic position fixing system operates in estimated (dead reckoning) mode or 63 if the positioning system is inoperative) 61, 62, 63 are not used by CS AIS

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

msgId, repeat, userId, VALID_MESSAGE_TYPES, vdm

Constructor Summary

Constructors

Constructor and Description
AisPositionMessage(int msgId) Instantiates a new Ais position message.
AisPositionMessage(Vdm vdm) Instantiates a new Ais position message.

Method Summary

Modifier and Type	Method and Description
protected SixbitEncoder	encode() Base encode method to be called by all extending classes
int	getCog() Course over ground
int	getNavStatus() Gets nav status.
AisPosition	getPos() Get position
int	getPosAcc() Position accuracy
int	getRaim() Get raim
int	getRot() Gets rot.
Float	getSensorRot() Gets sensor rot.
int	getSog() Speed over ground
int	getSpare() Gets spare.
int	getSpecialManIndicator() Gets special man indicator.
int	getSyncState() Gets sync state.
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	isRotValid() Is rot valid boolean.
boolean	isSogValid() Speed over ground valid
void	parse(BinArray binArray) Base parse method to be called by all extending classes
void	setCog(int cog) Sets cog.
void	setNavStatus(int navStatus) Sets nav status.
void	setPos(AisPosition pos) Sets pos.
void	setPosAcc(int posAcc) Sets pos acc.
void	setRaim(int raim) Sets raim.
void	setRot(int rot) Sets rot.
void	setSog(int sog) Sets sog.
void	setSpare(int spare) Sets spare.
void	setSpecialManIndicator(int specialManIndicator) Sets special man indicator.
void	setSyncState(int syncState) Sets sync state.
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

getEncoded, 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

Field Detail

navStatus

protected int navStatus

Navigational status: 0 = under way using engine 1 = at anchor 2 = not under command 3 = restricted manoeuvrability 4 = constrained by her draught 5 = moored 6 = aground 7 = engaged in fishing 8 = under way sailing 9 = reserved for future amendment of navigational status for ships carrying DG, HS, or MP, or IMO hazard or pollutant category C, high speed craft (HSC), 10 = reserved for future amendment of navigational status for ships carrying dangerous goods (DG), harmful substances (HS) or marine pollutants (MP), or IMO hazard or pollutant category A, wing in grand (WIG); 11-13 = reserved for future use 14 = AIS-SART (active) 15 = not defined = default (also used by AIS-SART under test)

rot

protected int rot

Rate of Turn (ROT): 0 to +126 = turning right at up to 708 degrees per min or higher 0 to -126 = turning left at up to 708 degrees per min or higher Values between 0 and 708 degrees per min coded by ROTais = 4.733 SQRT(ROTsensor) degrees per min where ROTsensor is the Rate of Turn as input by an external Rate of Turn Indicator (TI). ROTais is rounded to the nearest integer value.

+127 = turning right at more than 5 degrees per 30 s (No TI available) -127 = turning left at more than 5 degrees per 30 s (No TI available) -128 (80 hex) indicates no turn information available (default).

ROT data should not be derived from COG information.

sog

protected int sog

Speed Over Ground Speed over ground in 1/10 knot steps (0-102.2 knots) 1023 = not available, 1022 = 102.2 knots or higher

posAcc

protected int posAcc

AisPosition Accuracy: The position accuracy (PA) flag should be determined in accordance with Table 47 1 = high ( =< 10 m) 0 = low (>10 m) 0 = default

pos

protected AisPosition pos

Stores the positions in a general manner

cog

protected int cog

Course over Ground Course over ground in 1/10 = (0-3599). 3600 (E10h) = not available = default. 3601-4095 should not be used

trueHeading

protected int trueHeading

True heading Degrees (0-359) (511 indicates not available = default)

utcSec

protected int utcSec

Time stamp: UTC second when the report was generated by the EPFS (0-59 or 60 if time stamp is not available, which should also be the default value or 61 if positioning system is in manual input mode or 62 if electronic position fixing system operates in estimated (dead reckoning) mode or 63 if the positioning system is inoperative) 61, 62, 63 are not used by CS AIS

specialManIndicator

protected int specialManIndicator

Special manoeuvre indicator: 0 = not available = default 1 = not engaged in special manoeuvre 2 = engaged in special manoeuvre (i.e.: regional passing arrangement on Inland Waterway)

NOTE: This field is added in ITU-R M1371-4

spare

protected int spare

Not used. Should be set to zero. Reserved for future use.

NOTE: In ITU-R M1371-4 this field is 3 bits compared to 1 previously

raim

protected int raim

RAIM-flag: Receiver autonomous integrity monitoring (RAIM) flag of electronic position fixing device; 0 = RAIM not in use = default; 1 = RAIM in use. See Table 47

syncState

protected int syncState

SOTDMA/ITDMA sync state: sync state is part of the defined communication state (19) bits. The sync state is the first 2 bits of the 19 bits in the communication state of the message.

0 UTC direct (see 3.1.1.1) 1 UTC indirect (see 3.1.1.2) 2 Station is synchronized to a base station (base direct) 3 Station is synchronized to another station based on the highest number of received stations or to another mobile station, which is directly synchronized to a base station

Constructor Detail

AisPositionMessage

public AisPositionMessage(int msgId)

Instantiates a new Ais position message.

Parameters:

msgId - the msg id

AisPositionMessage

public AisPositionMessage(Vdm vdm)

Instantiates a new Ais position message.

Parameters:

vdm - the vdm

Method Detail

parse

public 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

encode

protected SixbitEncoder encode()

Description copied from class: AisMessage

Base encode method to be called by all extending classes

Overrides:

encode in class AisMessage

Returns:

SixbitEncoder sixbit encoder

toString

public String toString()

Overrides:

toString in class AisMessage

getNavStatus

public int getNavStatus()

Gets nav status.

Returns:

the nav status

setNavStatus

public void setNavStatus(int navStatus)

Sets nav status.

Parameters:

navStatus - the nav status

getRot

public int getRot()

Gets rot.

Returns:

the rot

getSensorRot

public Float getSensorRot()

Gets sensor rot.

Returns:

the sensor rot

setRot

public void setRot(int rot)

Sets rot.

Parameters:

rot - the rot

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 final 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

getSpecialManIndicator

public int getSpecialManIndicator()

Gets special man indicator.

Returns:

the specialManIndicator

setSpecialManIndicator

public void setSpecialManIndicator(int specialManIndicator)

Sets special man indicator.

Parameters:

specialManIndicator - the specialManIndicator to set

getSpare

public int getSpare()

Gets spare.

Returns:

the spare

setSpare

public void setSpare(int spare)

Sets spare.

Parameters:

spare - the spare

getRaim

public int getRaim()

Description copied from interface: IVesselPositionMessage

Get raim

Specified by:

getRaim in interface IVesselPositionMessage

Returns:

raim

setRaim

public void setRaim(int raim)

Sets raim.

Parameters:

raim - the raim

getSyncState

public int getSyncState()

Gets sync state.

Returns:

the sync state

setSyncState

public void setSyncState(int syncState)

Sets sync state.

Parameters:

syncState - the sync state

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

isRotValid

public boolean isRotValid()

Is rot valid boolean.

Returns:

the boolean