org.vesalainen.parsers.nmea

Interface NMEAObserver

All Superinterfaces:

org.vesalainen.util.Transactional

All Known Implementing Classes:

AbstractNMEAObserver

public interface NMEAObserver
extends org.vesalainen.util.Transactional

NMEAObserver is observer class for NMEA data. NMEAParser calls methods of this interface.

User of NMEAParser is probably only interested in a small subset of the data. For this reason creation of Strings is avoided because of performance and GC overhead. Use InputReader getString(fieldRef) to create strings. Use fieldRefs before commit.

It is mostly easier to derive your class from AbstractNMEAObserver class. AbstractNMEAObserver has empty methods for all NMEAObserver methods.

Observer methods are called as soon they are found in input. Parsing might cause syntax error or NMEA sentence checksum might fail. In that case rollback is called. Critical application should store the values and use them only after commit.

Author:

Timo Vesalainen

Method Summary

Modifier and Type	Method and Description
void	setAgeOfDifferentialGPSData(float ageOfDifferentialGPSData) GGA
void	setAlmanacReferenceTime(int almanacReferenceTime) ALM
void	setAntennaAltitude(float meters) GGA
void	setArgumentOfPerigee(int argumentOfPerigee) ALM
void	setArrivalCircleRadius(float nm) AAM
void	setArrivalStatus(char arrivalStatus) AAM, APA, APB
void	setAzimuth(int azimuth) Azimuth in degrees to true north
void	setBearingToDestination(float degrees) RMB
void	setClock(Clock clock) Set the clock
void	setCrossTrackError(float nm) DirectionToSteer - = left + = right APA, APB, XTR
void	setDepthBelowKeel(float meters) DBK
void	setDepthBelowSurface(float meters) DBS
void	setDepthBelowTransducer(float meters) DBT
void	setDepthOffsetOfWater(float meters) DBT
void	setDepthOfWater(float meters) DBT
void	setDestinationClosingVelocity(float knots) RMB
void	setDestinationWaypointLatitude(float latitude) RMB, WPL
void	setDestinationWaypointLongitude(float longitude) RMB, WPL
void	setDifferentialReferenceStationID(int differentialReferenceStationID) GGA
void	setDistanceToWaypoint(float nm) BWC, BWR WNC
void	setEccentricity(int eccentricity) ALM
void	setElevation(int elevation) Elevation in degrees
void	setF0ClockParameter(int f0ClockParameter) ALM
void	setF1ClockParameter(int f1ClockParameter) ALM
void	setFaaModeIndicator(char faaModeIndicator) BWC, GLL, XTE
void	setFromWaypoint(String fromWaypoint) BOD, BWW, RMB, WNC
void	setGeoidalSeparation(float meters) GGA
void	setGpsQualityIndicator(GPSQualityIndicator gpsQualityIndicator) GGA
void	setGpsWeekNumber(int gpsWeekNumber) ALM
void	setHdop(float value)
void	setHorizontalDilutionOfPrecision(float meters) GGA
void	setInclinationAngle(int inclinationAngle) ALM
void	setLatitude(float latitude) Latitude in degrees.
void	setLongitude(float longitude) Longitude in degrees.
void	setLongitudeOfAscensionNode(int longitudeOfAscensionNode) ALM
void	setMagneticBearing(float degrees) BOD, BWC, BWR, BWW
void	setMagneticBearingOriginToDestination(float bearingOriginToDestination) APA, APB
void	setMagneticBearingPresentPositionToDestination(float bearingPresentPositionToDestination) APB
void	setMagneticDeviation(float magneticDeviation) HDG
void	setMagneticHeading(float degrees) HDM, HDT
void	setMagneticHeadingToSteerToDestination(float headingToSteerToDestination) APB
void	setMagneticSensorHeading(float magneticSensorHeading) HDG
void	setMagneticTrackMadeGood(float track)
void	setMagneticVariation(float degrees) HDG, RMA, RMC
void	setMagneticWaterHeading(float degrees) VHW
void	setMeanAnomaly(int meanAnomaly) ALM
void	setMessage(String message) TXT
void	setMessageMode(char messageMode) RTE
void	setMessageNumber(int messageNumber) ALM, RTE
void	setMessageType(MessageType messageType)
void	setMode(char mode) GSA Mode (1 = no fix, 2 = 2D fix, 3 = 3D fix)
void	setNumberOfSatellitesInView(int numberOfSatellitesInView) GGA
void	setPdop(float value)
void	setPitch(float value) Pitch: oscillation of vessel about its latitudinal axis.
void	setPortRudderSensor(float portRudderSensor) RSA Port rudder sensor
void	setPRat(float value)
void	setPrn(int prn) Satellite PRN number
void	setPropellerPitch(float propellerPitch) RPM Propeller pitch, % of maximum, "-" means astern
void	setProprietaryData(List<String> data) Proprietary data.
void	setProprietaryType(String type) Proprietary sentences start with $P.
void	setPRtr(float value)
void	setRangeToDestination(float nm) RMB
void	setRateOfRightAscension(int rateOfRightAscension) ALM
void	setRateOfTurn(float rateOfTurn) ROT Rate Of Turn, degrees per minute, "-" means bow turns to port
void	setReferenceTarget(String referenceTarget)
void	setRelativeWindAngle(float windAngle) MWV
void	setRoll(float value) Roll: oscillation of vessel about its longitudinal axis.
void	setRootOfSemiMajorAxis(int rootOfSemiMajorAxis) ALM
void	setRoute(String route) Route id
void	setRpm(float rpm) RPM Speed, Revolutions per minute
void	setRpmSource(char rpmSource) RPM Sourse, S = Shaft, E = Engine
void	setRpmSourceNumber(int rpmSourceNumber) RPM Engine or shaft number
void	setRRat(float value)
void	setRRtr(float value)
void	setSatelliteId1(int id) GSA ID of 1st satellite used for fix
void	setSatelliteId10(int id)
void	setSatelliteId11(int id)
void	setSatelliteId12(int id)
void	setSatelliteId2(int id)
void	setSatelliteId3(int id)
void	setSatelliteId4(int id)
void	setSatelliteId5(int id)
void	setSatelliteId6(int id)
void	setSatelliteId7(int id)
void	setSatelliteId8(int id)
void	setSatelliteId9(int id)
void	setSatellitePRNNumber(int satellitePRNNumber) ALM
void	setSelectionMode(char mode) GSA Selection mode: M=Manual, forced to operate in 2D or 3D, A=Automatic, 3D/2D
void	setSnr(int snr) SNR in dB
void	setSpeedOverGround(float knots) RMA, RMC
void	setStarboardRudderSensor(float starboardRudderSensor) RSA Starboard (or single) rudder sensor, "-" means Turn To Port
void	setStatus(char status) APA, APB, GLL, MWV, RMA, RMB, RMC, ROT, RSA, XTE
void	setStatus2(char status) APA, APB, RSA, XTE
void	setSvHealth(int svHealth) ALM
void	setTalkerId(TalkerId talkerId) Set taker id of sentence
void	setTargetHour(int hour)
void	setTargetMinute(int minute)
void	setTargetName(String name) TXT
void	setTargetNumber(int target)
void	setTargetSecond(float second)
void	setTargetStatus(char status) S = SOS
void	setTimeDifferenceA(float timeDifferenceA) RMA
void	setTimeDifferenceB(float timeDifferenceB) RMA
void	setTotalNumberOfMessages(int totalNumberOfMessages) ALM, RTE
void	setTotalNumberOfSatellitesInView(int count) Total number of satellites in view
void	setToWaypoint(String toWaypoint) BOD, BWW, RMB, WNC
void	setTrackMadeGood(float knots) RMA, RMC
void	setTrueBearing(float degrees) BOD, BWC, BWR, BWW
void	setTrueBearingOriginToDestination(float bearingOriginToDestination) APA, APB
void	setTrueBearingPresentPositionToDestination(float bearingPresentPositionToDestination) APB
void	setTrueHeading(float degrees) HDM, HDT
void	setTrueHeadingToSteerToDestination(float headingToSteerToDestination) APB
void	setTrueTrackMadeGood(float track)
void	setTrueWaterHeading(float degrees) VHW
void	setTrueWindAngle(float windAngle) MWV
void	setVdop(float value)
void	setVelocityToWaypoint(float knots) WCV
void	setWaterSpeed(float knots) VHW
void	setWaterTemperature(float celcius) MTW
void	setWaypoint(String waypoint) AAM, APA, APB, BWC, BWR, R00, WCV, WPL
void	setWaypoints(List<String> list) R00, RTE
void	setWaypointStatus(char waypointStatus) AAM, APA, APB
void	setWindDirection(float windDirection) VWR Relative wind angle - = left + = right
void	setWindSpeed(float metersInSecond) MWV, VWR
void	setXAcceleration(float value) X-Acceleration.
void	setYAcceleration(float value) Y-Acceleration.
void	setYRat(float value)
void	setYRtr(float value)
void	setZAcceleration(float value) Z-Acceleration.

Methods inherited from interface org.vesalainen.util.Transactional

commit, rollback

Method Detail

setClock

void setClock(Clock clock)

Set the clock

Parameters:

clock -

setTalkerId

void setTalkerId(TalkerId talkerId)

Set taker id of sentence

Parameters:

talkerId -

setLatitude

void setLatitude(float latitude)

Latitude in degrees. BWC, BWR, GGA, GLL, RMA, RMC

Parameters:

latitude - Latitude. South is negative.

setLongitude

void setLongitude(float longitude)

Longitude in degrees. BWC, BWR, GGA, GLL, RMA, RMC

Parameters:

longitude - Longitude West is negative.

setSpeedOverGround

void setSpeedOverGround(float knots)

RMA, RMC

Parameters:

knots -

setTrackMadeGood

void setTrackMadeGood(float knots)

RMA, RMC

Parameters:

knots -

setMagneticVariation

void setMagneticVariation(float degrees)

HDG, RMA, RMC

Parameters:

degrees - West is minus

setCrossTrackError

void setCrossTrackError(float nm)

DirectionToSteer - = left + = right APA, APB, XTR

Parameters:

nm -

setToWaypoint

void setToWaypoint(String toWaypoint)

BOD, BWW, RMB, WNC

Parameters:

toWaypoint -

setFromWaypoint

void setFromWaypoint(String fromWaypoint)

BOD, BWW, RMB, WNC

Parameters:

fromWaypoint -

setDestinationWaypointLatitude

void setDestinationWaypointLatitude(float latitude)

RMB, WPL

Parameters:

latitude -

setDestinationWaypointLongitude

void setDestinationWaypointLongitude(float longitude)

RMB, WPL

Parameters:

longitude -

setRangeToDestination

void setRangeToDestination(float nm)

RMB

Parameters:

nm -

setBearingToDestination

void setBearingToDestination(float degrees)

RMB

Parameters:

degrees - True

setDestinationClosingVelocity

void setDestinationClosingVelocity(float knots)

RMB

Parameters:

knots -

setGpsQualityIndicator

void setGpsQualityIndicator(GPSQualityIndicator gpsQualityIndicator)

GGA

Parameters:

gpsQualityIndicator -

setNumberOfSatellitesInView

void setNumberOfSatellitesInView(int numberOfSatellitesInView)

GGA

Parameters:

numberOfSatellitesInView -

setHorizontalDilutionOfPrecision

void setHorizontalDilutionOfPrecision(float meters)

GGA

Parameters:

meters -

setAntennaAltitude

void setAntennaAltitude(float meters)

GGA

Parameters:

meters -

setGeoidalSeparation

void setGeoidalSeparation(float meters)

GGA

Parameters:

meters -

setAgeOfDifferentialGPSData

void setAgeOfDifferentialGPSData(float ageOfDifferentialGPSData)

GGA

Parameters:

ageOfDifferentialGPSData -

setDifferentialReferenceStationID

void setDifferentialReferenceStationID(int differentialReferenceStationID)

GGA

Parameters:

differentialReferenceStationID -

setStatus

void setStatus(char status)

APA, APB, GLL, MWV, RMA, RMB, RMC, ROT, RSA, XTE

Parameters:

status -

setArrivalStatus

void setArrivalStatus(char arrivalStatus)

AAM, APA, APB

Parameters:

arrivalStatus -

setTimeDifferenceA

void setTimeDifferenceA(float timeDifferenceA)

RMA

Parameters:

timeDifferenceA -

setTimeDifferenceB

void setTimeDifferenceB(float timeDifferenceB)

RMA

Parameters:

timeDifferenceB -

setWaypointStatus

void setWaypointStatus(char waypointStatus)

AAM, APA, APB

Parameters:

waypointStatus -

setArrivalCircleRadius

void setArrivalCircleRadius(float nm)

AAM

Parameters:

nm -

setWaypoint

void setWaypoint(String waypoint)

AAM, APA, APB, BWC, BWR, R00, WCV, WPL

Parameters:

waypoint -

setTotalNumberOfMessages

void setTotalNumberOfMessages(int totalNumberOfMessages)

ALM, RTE

Parameters:

totalNumberOfMessages -

setMessageNumber

void setMessageNumber(int messageNumber)

ALM, RTE

Parameters:

messageNumber -

setSatellitePRNNumber

void setSatellitePRNNumber(int satellitePRNNumber)

ALM

Parameters:

satellitePRNNumber -

setGpsWeekNumber

void setGpsWeekNumber(int gpsWeekNumber)

ALM

Parameters:

gpsWeekNumber -

setSvHealth

void setSvHealth(int svHealth)

ALM

Parameters:

svHealth -

setEccentricity

void setEccentricity(int eccentricity)

ALM

Parameters:

eccentricity -

setAlmanacReferenceTime

void setAlmanacReferenceTime(int almanacReferenceTime)

ALM

Parameters:

almanacReferenceTime -

setInclinationAngle

void setInclinationAngle(int inclinationAngle)

ALM

Parameters:

inclinationAngle -

setRateOfRightAscension

void setRateOfRightAscension(int rateOfRightAscension)

ALM

Parameters:

rateOfRightAscension -

setRootOfSemiMajorAxis

void setRootOfSemiMajorAxis(int rootOfSemiMajorAxis)

ALM

Parameters:

rootOfSemiMajorAxis -

setArgumentOfPerigee

void setArgumentOfPerigee(int argumentOfPerigee)

ALM

Parameters:

argumentOfPerigee -

setLongitudeOfAscensionNode

void setLongitudeOfAscensionNode(int longitudeOfAscensionNode)

ALM

Parameters:

longitudeOfAscensionNode -

setMeanAnomaly

void setMeanAnomaly(int meanAnomaly)

ALM

Parameters:

meanAnomaly -

setF0ClockParameter

void setF0ClockParameter(int f0ClockParameter)

ALM

Parameters:

f0ClockParameter -

setF1ClockParameter

void setF1ClockParameter(int f1ClockParameter)

ALM

Parameters:

f1ClockParameter -

setStatus2

void setStatus2(char status)

APA, APB, RSA, XTE

Parameters:

status -

setMagneticBearingOriginToDestination

void setMagneticBearingOriginToDestination(float bearingOriginToDestination)

APA, APB

Parameters:

bearingOriginToDestination -

setTrueBearingOriginToDestination

void setTrueBearingOriginToDestination(float bearingOriginToDestination)

APA, APB

Parameters:

bearingOriginToDestination -

setMagneticBearingPresentPositionToDestination

void setMagneticBearingPresentPositionToDestination(float bearingPresentPositionToDestination)

APB

Parameters:

bearingPresentPositionToDestination -

setTrueBearingPresentPositionToDestination

void setTrueBearingPresentPositionToDestination(float bearingPresentPositionToDestination)

APB

Parameters:

bearingPresentPositionToDestination -

setMagneticHeadingToSteerToDestination

void setMagneticHeadingToSteerToDestination(float headingToSteerToDestination)

APB

Parameters:

headingToSteerToDestination -

setTrueHeadingToSteerToDestination

void setTrueHeadingToSteerToDestination(float headingToSteerToDestination)

APB

Parameters:

headingToSteerToDestination -

setFaaModeIndicator

void setFaaModeIndicator(char faaModeIndicator)

BWC, GLL, XTE

Parameters:

faaModeIndicator -

setMessageMode

void setMessageMode(char messageMode)

RTE

Parameters:

messageMode -

setWaypoints

void setWaypoints(List<String> list)

R00, RTE

Parameters:

list -

setDistanceToWaypoint

void setDistanceToWaypoint(float nm)

BWC, BWR WNC

Parameters:

nm -

setDepthBelowKeel

void setDepthBelowKeel(float meters)

DBK

Parameters:

meters -

setDepthBelowSurface

void setDepthBelowSurface(float meters)

DBS

Parameters:

meters -

setDepthBelowTransducer

void setDepthBelowTransducer(float meters)

DBT

Parameters:

meters -

setTrueBearing

void setTrueBearing(float degrees)

BOD, BWC, BWR, BWW

Parameters:

degrees -

setMagneticBearing

void setMagneticBearing(float degrees)

BOD, BWC, BWR, BWW

Parameters:

degrees -

setDepthOfWater

void setDepthOfWater(float meters)

DBT

Parameters:

meters -

setDepthOffsetOfWater

void setDepthOffsetOfWater(float meters)

DBT

Parameters:

meters -

setMagneticDeviation

void setMagneticDeviation(float magneticDeviation)

HDG

Parameters:

magneticDeviation -

setMagneticSensorHeading

void setMagneticSensorHeading(float magneticSensorHeading)

HDG

Parameters:

magneticSensorHeading -

setTrueHeading

void setTrueHeading(float degrees)

HDM, HDT

Parameters:

degrees -

setMagneticHeading

void setMagneticHeading(float degrees)

HDM, HDT

Parameters:

degrees -

setWaterTemperature

void setWaterTemperature(float celcius)

MTW

Parameters:

celcius -

setRelativeWindAngle

void setRelativeWindAngle(float windAngle)

MWV

Parameters:

windAngle - Wind Angle, 0 to 360 degrees

setTrueWindAngle

void setTrueWindAngle(float windAngle)

MWV

Parameters:

windAngle - Wind Angle, 0 to 360 degrees

setWindSpeed

void setWindSpeed(float metersInSecond)

MWV, VWR

Parameters:

metersInSecond -

setRateOfTurn

void setRateOfTurn(float rateOfTurn)

ROT Rate Of Turn, degrees per minute, "-" means bow turns to port

Parameters:

rateOfTurn -

setRpmSource

void setRpmSource(char rpmSource)

RPM Sourse, S = Shaft, E = Engine

Parameters:

rpmSource -

setRpmSourceNumber

void setRpmSourceNumber(int rpmSourceNumber)

RPM Engine or shaft number

Parameters:

rpmSourceNumber -

setRpm

void setRpm(float rpm)

RPM Speed, Revolutions per minute

Parameters:

rpm -

setPropellerPitch

void setPropellerPitch(float propellerPitch)

RPM Propeller pitch, % of maximum, "-" means astern

Parameters:

propellerPitch -

setStarboardRudderSensor

void setStarboardRudderSensor(float starboardRudderSensor)

RSA Starboard (or single) rudder sensor, "-" means Turn To Port

Parameters:

starboardRudderSensor -

setPortRudderSensor

void setPortRudderSensor(float portRudderSensor)

RSA Port rudder sensor

Parameters:

portRudderSensor -

setTrueWaterHeading

void setTrueWaterHeading(float degrees)

VHW

Parameters:

degrees -

setMagneticWaterHeading

void setMagneticWaterHeading(float degrees)

VHW

Parameters:

degrees -

setWaterSpeed

void setWaterSpeed(float knots)

VHW

Parameters:

knots -

setWindDirection

void setWindDirection(float windDirection)

VWR Relative wind angle - = left + = right

Parameters:

windDirection - Wind direction magnitude in degrees

setVelocityToWaypoint

void setVelocityToWaypoint(float knots)

WCV

Parameters:

knots -

setTargetName

void setTargetName(String name)

TXT

Parameters:

name - Target name

setMessage

void setMessage(String message)

TXT

Parameters:

message -

setProprietaryType

void setProprietaryType(String type)

Proprietary sentences start with $P. Proprietary type is the string following that prefix. E.g. $PGRMI,... GRMI is the type.

Parameters:

type -

setProprietaryData

void setProprietaryData(List<String> data)

Proprietary data. Comma separated proprietary data fields.

Parameters:

data -

setSelectionMode

void setSelectionMode(char mode)

GSA Selection mode: M=Manual, forced to operate in 2D or 3D, A=Automatic, 3D/2D

Parameters:

mode -

setMode

void setMode(char mode)

GSA Mode (1 = no fix, 2 = 2D fix, 3 = 3D fix)

Parameters:

mode -

setSatelliteId1

void setSatelliteId1(int id)

GSA ID of 1st satellite used for fix

Parameters:

id -

setSatelliteId2

void setSatelliteId2(int id)

setSatelliteId3

void setSatelliteId3(int id)

setSatelliteId4

void setSatelliteId4(int id)

setSatelliteId5

void setSatelliteId5(int id)

setSatelliteId6

void setSatelliteId6(int id)

setSatelliteId7

void setSatelliteId7(int id)

setSatelliteId8

void setSatelliteId8(int id)

setSatelliteId9

void setSatelliteId9(int id)

setSatelliteId10

void setSatelliteId10(int id)

setSatelliteId11

void setSatelliteId11(int id)

setSatelliteId12

void setSatelliteId12(int id)

setPdop

void setPdop(float value)

setHdop

void setHdop(float value)

setVdop

void setVdop(float value)

setTotalNumberOfSatellitesInView

void setTotalNumberOfSatellitesInView(int count)

Total number of satellites in view

Parameters:

count -

setPrn

void setPrn(int prn)

Satellite PRN number

Parameters:

prn -

setElevation

void setElevation(int elevation)

Elevation in degrees

Parameters:

elevation -

setAzimuth

void setAzimuth(int azimuth)

Azimuth in degrees to true north

Parameters:

azimuth -

setSnr

void setSnr(int snr)

SNR in dB

Parameters:

snr -

setTrueTrackMadeGood

void setTrueTrackMadeGood(float track)

setMagneticTrackMadeGood

void setMagneticTrackMadeGood(float track)

setRoute

void setRoute(String route)

Route id

Parameters:

route -

setTargetNumber

void setTargetNumber(int target)

setTargetHour

void setTargetHour(int hour)

setTargetMinute

void setTargetMinute(int minute)

setTargetSecond

void setTargetSecond(float second)

setTargetStatus

void setTargetStatus(char status)

S = SOS

Parameters:

status -

setReferenceTarget

void setReferenceTarget(String referenceTarget)

setMessageType

void setMessageType(MessageType messageType)

setPitch

void setPitch(float value)

Pitch: oscillation of vessel about its latitudinal axis. Bow moving up is positive. Value reported to the nearest 0.1 degree.

Parameters:

value -

setRoll

void setRoll(float value)

Roll: oscillation of vessel about its longitudinal axis. Roll to the starboard is positive. Value reported to the nearest 0.1 degree.

Parameters:

value -

setXAcceleration

void setXAcceleration(float value)

X-Acceleration. Unit is gravity.

Parameters:

value -

setYAcceleration

void setYAcceleration(float value)

Y-Acceleration. Unit is gravity.

Parameters:

value -

setZAcceleration

void setZAcceleration(float value)

Z-Acceleration. Unit is gravity.

Parameters:

value -

setRRat

void setRRat(float value)

setPRat

void setPRat(float value)

setYRat

void setYRat(float value)

setRRtr

void setRRtr(float value)

setPRtr

void setPRtr(float value)

setYRtr

void setYRtr(float value)