org.vesalainen.parsers.nmea

Interface NMEAObserver

All Superinterfaces:

Transactional

All Known Implementing Classes:

AbstractNMEAObserver, Tracer

public interface NMEAObserver
extends Transactional

Author:

Timo Vesalainen

Method Summary

Methods

Modifier and Type	Method and Description
void	setAgeOfDifferentialGPSData(int ageOfDifferentialGPSData) GGA
void	setAlmanacReferenceTime(float almanacReferenceTime) ALM
void	setAntennaAltitude(float antennaAltitude, char unitsOfAntennaAltitude) GGA
void	setArgumentOfPerigee(float argumentOfPerigee) ALM
void	setArrivalCircleRadius(float arrivalCircleRadius, char units) AAM
void	setArrivalStatus(char arrivalStatus) AAM, APA, APB
void	setBearing(float bearing, char unit) BOD, BWC, BWR, BWW
void	setBearingOriginToDestination(float bearingOriginToDestination, char mOrT) APA, APB
void	setBearingPresentPositionToDestination(float bearingPresentPositionToDestination, char mOrT) APB
void	setBearingToDestination(float bearingToDestination) RMB
void	setClock(Clock clock) Set the clock
void	setCrossTrackError(float crossTrackError, char directionToSteer, char units) RMB, APA, APB, XTR
void	setDepthBelowKeel(float depth, char unit) DBK
void	setDepthBelowSurface(float depth, char unit) DBS
void	setDepthBelowTransducer(float depth, char unit) DBT
void	setDepthOfWater(float depth, float offset) DBT
void	setDestinationClosingVelocity(float destinationClosingVelocity) RMB
void	setDestinationWaypointLocation(double latitude, double longitude) RMB, WPL
void	setDifferentialReferenceStationID(int differentialReferenceStationID) GGA
void	setDistanceToWaypoint(float distanceToWaypoint, char units) BWC, BWR WNC
void	setEccentricity(float eccentricity) ALM
void	setF0ClockParameter(float f0ClockParameter) ALM
void	setF1ClockParameter(float f1ClockParameter) ALM
void	setFAAModeIndicator(char faaModeIndicator) BWC, GLL, XTE
void	setGeoidalSeparation(float geoidalSeparation, char unitsOfGeoidalSeparation) GGA
void	setGpsQualityIndicator(int gpsQualityIndicator) GGA
void	setGpsWeekNumber(int gpsWeekNumber) ALM
void	setHeading(float heading, char unit) HDM, HDT
void	setHeadingToSteerToDestination(float headingToSteerToDestination, char mOrT) APB
void	setHorizontalDatum(String horizontalDatum) RMM
void	setHorizontalDilutionOfPrecision(float horizontalDilutionOfPrecision) GGA
void	setInclinationAngle(float inclinationAngle) ALM
void	setLocation(double latitude, double longitude) Location in degrees.
void	setLongitudeOfAscensionNode(float longitudeOfAscensionNode) ALM
void	setMagneticDeviation(float magneticDeviation) HDG
void	setMagneticSensorHeading(float magneticSensorHeading) HDG
void	setMagneticVariation(float magneticVariation) HDG, RMA, RMC
void	setMeanAnomaly(float meanAnomaly) ALM
void	setMessageMode(char messageMode) RTE
void	setMessageNumber(int messageNumber) ALM, RTE
void	setNumberOfSatellitesInView(int numberOfSatellitesInView) GGA
void	setPortRudderSensor(float portRudderSensor) RSA Port rudder sensor
void	setPropellerPitch(float propellerPitch) RPM Propeller pitch, % of maximum, "-" means astern
void	setRangeToDestination(float rangeToDestination) RMB
void	setRateOfRightAscension(float rateOfRightAscension) ALM
void	setRateOfTurn(float rateOfTurn) ROT Rate Of Turn, degrees per minute, "-" means bow turns to port
void	setRootOfSemiMajorAxis(float rootOfSemiMajorAxis) ALM
void	setRpm(int 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	setSatellitePRNNumber(int satellitePRNNumber) ALM
void	setSpeedOverGround(float speedOverGround) 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	setTimeDifference(float timeDifferenceA, float timeDifferenceB) RMA
void	setTotalNumberOfMessages(int totalNumberOfMessages) ALM, RTE
void	setTrackMadeGood(float trackMadeGood) RMA, RMC
void	setVelocityToWaypoint(float velocityToWaypoint, char unit) WCV
void	setWaterHeading(float waterHeading, char unit) VHW
void	setWaterSpeed(float waterSpeed, char unit) VHW
void	setWaterTemperature(float waterTemperature, char unit) 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	setWaypointToWaypoint(String toWaypoint, String fromWaypoint) BOD, BWW, RMB, WNC
void	setWindAngle(float windAngle, char unit) MWV
void	setWindDirection(float windDirection, char unit) VWR Relative wind angle
void	setWindSpeed(float windSpeed, char unit) MWV, VWR
void	talkerId(char c1, char c2) Talker Id of sending device.

Methods inherited from interface org.vesalainen.parsers.nmea.Transactional

commit, rollback

Method Detail

setClock

void setClock(Clock clock)

Set the clock

Parameters:

clock -

talkerId

void talkerId(char c1,
            char c2)

Talker Id of sending device.

Parameters:

c1 -

c2 -

setLocation

void setLocation(double latitude,
               double longitude)

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

Parameters:

latitude - Latitude. South is negative.

longitude - Longitude West is negative.

setSpeedOverGround

void setSpeedOverGround(float speedOverGround)

RMA, RMC

Parameters:

speedOverGround -

setTrackMadeGood

void setTrackMadeGood(float trackMadeGood)

RMA, RMC

Parameters:

trackMadeGood -

setMagneticVariation

void setMagneticVariation(float magneticVariation)

HDG, RMA, RMC

Parameters:

magneticVariation -

setCrossTrackError

void setCrossTrackError(float crossTrackError,
                      char directionToSteer,
                      char units)

RMB, APA, APB, XTR

Parameters:

crossTrackError -

directionToSteer -

units -

setWaypointToWaypoint

void setWaypointToWaypoint(String toWaypoint,
                         String fromWaypoint)

BOD, BWW, RMB, WNC

Parameters:

toWaypoint -

fromWaypoint -

setDestinationWaypointLocation

void setDestinationWaypointLocation(double latitude,
                                  double longitude)

RMB, WPL

Parameters:

latitude -

longitude -

setRangeToDestination

void setRangeToDestination(float rangeToDestination)

RMB

Parameters:

rangeToDestination -

setBearingToDestination

void setBearingToDestination(float bearingToDestination)

RMB

Parameters:

bearingToDestination -

setDestinationClosingVelocity

void setDestinationClosingVelocity(float destinationClosingVelocity)

RMB

Parameters:

destinationClosingVelocity -

setGpsQualityIndicator

void setGpsQualityIndicator(int gpsQualityIndicator)

GGA

Parameters:

gpsQualityIndicator -

setNumberOfSatellitesInView

void setNumberOfSatellitesInView(int numberOfSatellitesInView)

GGA

Parameters:

numberOfSatellitesInView -

setHorizontalDilutionOfPrecision

void setHorizontalDilutionOfPrecision(float horizontalDilutionOfPrecision)

GGA

Parameters:

horizontalDilutionOfPrecision -

setAntennaAltitude

void setAntennaAltitude(float antennaAltitude,
                      char unitsOfAntennaAltitude)

GGA

Parameters:

antennaAltitude -

unitsOfAntennaAltitude -

setGeoidalSeparation

void setGeoidalSeparation(float geoidalSeparation,
                        char unitsOfGeoidalSeparation)

GGA

Parameters:

geoidalSeparation -

unitsOfGeoidalSeparation -

setAgeOfDifferentialGPSData

void setAgeOfDifferentialGPSData(int 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 -

setTimeDifference

void setTimeDifference(float timeDifferenceA,
                     float timeDifferenceB)

RMA

Parameters:

timeDifferenceA -

timeDifferenceB -

setWaypointStatus

void setWaypointStatus(char waypointStatus)

AAM, APA, APB

Parameters:

waypointStatus -

setArrivalCircleRadius

void setArrivalCircleRadius(float arrivalCircleRadius,
                          char units)

AAM

Parameters:

arrivalCircleRadius -

units -

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(float eccentricity)

ALM

Parameters:

eccentricity -

setAlmanacReferenceTime

void setAlmanacReferenceTime(float almanacReferenceTime)

ALM

Parameters:

almanacReferenceTime -

setInclinationAngle

void setInclinationAngle(float inclinationAngle)

ALM

Parameters:

inclinationAngle -

setRateOfRightAscension

void setRateOfRightAscension(float rateOfRightAscension)

ALM

Parameters:

rateOfRightAscension -

setRootOfSemiMajorAxis

void setRootOfSemiMajorAxis(float rootOfSemiMajorAxis)

ALM

Parameters:

rootOfSemiMajorAxis -

setArgumentOfPerigee

void setArgumentOfPerigee(float argumentOfPerigee)

ALM

Parameters:

argumentOfPerigee -

setLongitudeOfAscensionNode

void setLongitudeOfAscensionNode(float longitudeOfAscensionNode)

ALM

Parameters:

longitudeOfAscensionNode -

setMeanAnomaly

void setMeanAnomaly(float meanAnomaly)

ALM

Parameters:

meanAnomaly -

setF0ClockParameter

void setF0ClockParameter(float f0ClockParameter)

ALM

Parameters:

f0ClockParameter -

setF1ClockParameter

void setF1ClockParameter(float f1ClockParameter)

ALM

Parameters:

f1ClockParameter -

setStatus2

void setStatus2(char status)

APA, APB, RSA, XTE

Parameters:

status -

setBearingOriginToDestination

void setBearingOriginToDestination(float bearingOriginToDestination,
                                 char mOrT)

APA, APB

Parameters:

bearingOriginToDestination -

mOrT -

setBearingPresentPositionToDestination

void setBearingPresentPositionToDestination(float bearingPresentPositionToDestination,
                                          char mOrT)

APB

Parameters:

bearingPresentPositionToDestination -

mOrT -

setHeadingToSteerToDestination

void setHeadingToSteerToDestination(float headingToSteerToDestination,
                                  char mOrT)

APB

Parameters:

headingToSteerToDestination -

mOrT -

setFAAModeIndicator

void setFAAModeIndicator(char faaModeIndicator)

BWC, GLL, XTE

Parameters:

faaModeIndicator -

setHorizontalDatum

void setHorizontalDatum(String horizontalDatum)

RMM

Parameters:

horizontalDatum -

setMessageMode

void setMessageMode(char messageMode)

RTE

Parameters:

messageMode -

setWaypoints

void setWaypoints(List<String> list)

R00, RTE

Parameters:

list -

setDistanceToWaypoint

void setDistanceToWaypoint(float distanceToWaypoint,
                         char units)

BWC, BWR WNC

Parameters:

distanceToWaypoint -

units -

setDepthBelowKeel

void setDepthBelowKeel(float depth,
                     char unit)

DBK

Parameters:

depth -

unit -

setDepthBelowSurface

void setDepthBelowSurface(float depth,
                        char unit)

DBS

Parameters:

depth -

unit -

setDepthBelowTransducer

void setDepthBelowTransducer(float depth,
                           char unit)

DBT

Parameters:

depth -

unit -

setBearing

void setBearing(float bearing,
              char unit)

BOD, BWC, BWR, BWW

Parameters:

bearing -

unit -

setDepthOfWater

void setDepthOfWater(float depth,
                   float offset)

DBT

Parameters:

depth -

offset -

setMagneticDeviation

void setMagneticDeviation(float magneticDeviation)

HDG

Parameters:

magneticDeviation -

setMagneticSensorHeading

void setMagneticSensorHeading(float magneticSensorHeading)

HDG

Parameters:

magneticSensorHeading -

setHeading

void setHeading(float heading,
              char unit)

HDM, HDT

Parameters:

heading -

unit -

setWaterTemperature

void setWaterTemperature(float waterTemperature,
                       char unit)

MTW

Parameters:

waterTemperature -

unit -

setWindAngle

void setWindAngle(float windAngle,
                char unit)

MWV

Parameters:

windAngle - Wind Angle, 0 to 360 degrees

unit - Reference, R = Relative, T = True

setWindSpeed

void setWindSpeed(float windSpeed,
                char unit)

MWV, VWR

Parameters:

windSpeed -

unit - Wind Speed Units, K/M/N

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(int 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 -

setWaterHeading

void setWaterHeading(float waterHeading,
                   char unit)

VHW

Parameters:

waterHeading -

unit -

setWaterSpeed

void setWaterSpeed(float waterSpeed,
                 char unit)

VHW

Parameters:

waterSpeed -

unit -

setWindDirection

void setWindDirection(float windDirection,
                    char unit)

VWR Relative wind angle

Parameters:

windDirection - Wind direction magnitude in degrees

unit - Wind direction Left/Right of bow

setVelocityToWaypoint

void setVelocityToWaypoint(float velocityToWaypoint,
                         char unit)

WCV

Parameters:

velocityToWaypoint -

unit -