org.vesalainen.parsers.nmea

Class AbstractNMEAObserver

java.lang.Object

org.vesalainen.parsers.nmea.AbstractNMEAObserver

All Implemented Interfaces:

NMEAObserver, Transactional

public class AbstractNMEAObserver
extends Object
implements NMEAObserver

Author:

Timo Vesalainen

Field Summary

Fields

Modifier and Type	Field and Description
protected Clock	clock

Constructor Summary

Constructors

Constructor and Description
AbstractNMEAObserver()

Method Summary

Methods

Modifier and Type	Method and Description
static double	bearing(double lat1, double lon1, double lat2, double lon2) Returns bearing in degrees from (lat1, lon1) to (lat2, lon2)
void	commit(String reason)
static double	departure(double lat1, double lat2)
static double	distance(double lat1, double lon1, double lat2, double lon2) Returns distance in NM from (lat1, lon1) to (lat2, lon2)
void	rollback(String reason)
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 class java.lang.Object

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

Field Detail

clock

protected Clock clock

Constructor Detail

AbstractNMEAObserver

public AbstractNMEAObserver()

Method Detail

setClock

public void setClock(Clock clock)

Description copied from interface: NMEAObserver

Set the clock

Specified by:

setClock in interface NMEAObserver

distance

public static double distance(double lat1,
              double lon1,
              double lat2,
              double lon2)

Returns distance in NM from (lat1, lon1) to (lat2, lon2)

Parameters:

lat1 - in degrees

lon1 - in degrees

lat2 - in degrees

lon2 - in degrees

Returns:

bearing

public static double bearing(double lat1,
             double lon1,
             double lat2,
             double lon2)

Returns bearing in degrees from (lat1, lon1) to (lat2, lon2)

Parameters:

lat1 - in degrees

lon1 - in degrees

lat2 - in degrees

lon2 - in degrees

Returns:

departure

public static double departure(double lat1,
               double lat2)

Parameters:

lat1 - Latitude in degrees

lat2 - Latitude in degrees

Returns:

talkerId

public void talkerId(char c1,
            char c2)

Description copied from interface: NMEAObserver

Talker Id of sending device.

Specified by:

talkerId in interface NMEAObserver

setLocation

public void setLocation(double latitude,
               double longitude)

Description copied from interface: NMEAObserver

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

Specified by:

setLocation in interface NMEAObserver

Parameters:

latitude - Latitude. South is negative.

longitude - Longitude West is negative.

setSpeedOverGround

public void setSpeedOverGround(float speedOverGround)

Description copied from interface: NMEAObserver

RMA, RMC

Specified by:

setSpeedOverGround in interface NMEAObserver

setTrackMadeGood

public void setTrackMadeGood(float trackMadeGood)

Description copied from interface: NMEAObserver

RMA, RMC

Specified by:

setTrackMadeGood in interface NMEAObserver

setMagneticVariation

public void setMagneticVariation(float magneticVariation)

Description copied from interface: NMEAObserver

HDG, RMA, RMC

Specified by:

setMagneticVariation in interface NMEAObserver

setCrossTrackError

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

Description copied from interface: NMEAObserver

RMB, APA, APB, XTR

Specified by:

setCrossTrackError in interface NMEAObserver

setWaypointToWaypoint

public void setWaypointToWaypoint(String toWaypoint,
                         String fromWaypoint)

Description copied from interface: NMEAObserver

BOD, BWW, RMB, WNC

Specified by:

setWaypointToWaypoint in interface NMEAObserver

setDestinationWaypointLocation

public void setDestinationWaypointLocation(double latitude,
                                  double longitude)

Description copied from interface: NMEAObserver

RMB, WPL

Specified by:

setDestinationWaypointLocation in interface NMEAObserver

setRangeToDestination

public void setRangeToDestination(float rangeToDestination)

Description copied from interface: NMEAObserver

RMB

Specified by:

setRangeToDestination in interface NMEAObserver

setBearingToDestination

public void setBearingToDestination(float bearingToDestination)

Description copied from interface: NMEAObserver

RMB

Specified by:

setBearingToDestination in interface NMEAObserver

setDestinationClosingVelocity

public void setDestinationClosingVelocity(float destinationClosingVelocity)

Description copied from interface: NMEAObserver

RMB

Specified by:

setDestinationClosingVelocity in interface NMEAObserver

setGpsQualityIndicator

public void setGpsQualityIndicator(int gpsQualityIndicator)

Description copied from interface: NMEAObserver

GGA

Specified by:

setGpsQualityIndicator in interface NMEAObserver

setNumberOfSatellitesInView

public void setNumberOfSatellitesInView(int numberOfSatellitesInView)

Description copied from interface: NMEAObserver

GGA

Specified by:

setNumberOfSatellitesInView in interface NMEAObserver

setHorizontalDilutionOfPrecision

public void setHorizontalDilutionOfPrecision(float horizontalDilutionOfPrecision)

Description copied from interface: NMEAObserver

GGA

Specified by:

setHorizontalDilutionOfPrecision in interface NMEAObserver

setAntennaAltitude

public void setAntennaAltitude(float antennaAltitude,
                      char unitsOfAntennaAltitude)

Description copied from interface: NMEAObserver

GGA

Specified by:

setAntennaAltitude in interface NMEAObserver

setGeoidalSeparation

public void setGeoidalSeparation(float geoidalSeparation,
                        char unitsOfGeoidalSeparation)

Description copied from interface: NMEAObserver

GGA

Specified by:

setGeoidalSeparation in interface NMEAObserver

setAgeOfDifferentialGPSData

public void setAgeOfDifferentialGPSData(int ageOfDifferentialGPSData)

Description copied from interface: NMEAObserver

GGA

Specified by:

setAgeOfDifferentialGPSData in interface NMEAObserver

setDifferentialReferenceStationID

public void setDifferentialReferenceStationID(int differentialReferenceStationID)

Description copied from interface: NMEAObserver

GGA

Specified by:

setDifferentialReferenceStationID in interface NMEAObserver

setStatus

public void setStatus(char status)

Description copied from interface: NMEAObserver

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

Specified by:

setStatus in interface NMEAObserver

setArrivalStatus

public void setArrivalStatus(char arrivalStatus)

Description copied from interface: NMEAObserver

AAM, APA, APB

Specified by:

setArrivalStatus in interface NMEAObserver

setTimeDifference

public void setTimeDifference(float timeDifferenceA,
                     float timeDifferenceB)

Description copied from interface: NMEAObserver

RMA

Specified by:

setTimeDifference in interface NMEAObserver

setWaypointStatus

public void setWaypointStatus(char waypointStatus)

Description copied from interface: NMEAObserver

AAM, APA, APB

Specified by:

setWaypointStatus in interface NMEAObserver

setArrivalCircleRadius

public void setArrivalCircleRadius(float arrivalCircleRadius,
                          char units)

Description copied from interface: NMEAObserver

AAM

Specified by:

setArrivalCircleRadius in interface NMEAObserver

setWaypoint

public void setWaypoint(String waypoint)

Description copied from interface: NMEAObserver

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

Specified by:

setWaypoint in interface NMEAObserver

setTotalNumberOfMessages

public void setTotalNumberOfMessages(int totalNumberOfMessages)

Description copied from interface: NMEAObserver

ALM, RTE

Specified by:

setTotalNumberOfMessages in interface NMEAObserver

setMessageNumber

public void setMessageNumber(int messageNumber)

Description copied from interface: NMEAObserver

ALM, RTE

Specified by:

setMessageNumber in interface NMEAObserver

setSatellitePRNNumber

public void setSatellitePRNNumber(int satellitePRNNumber)

Description copied from interface: NMEAObserver

ALM

Specified by:

setSatellitePRNNumber in interface NMEAObserver

setGpsWeekNumber

public void setGpsWeekNumber(int gpsWeekNumber)

Description copied from interface: NMEAObserver

ALM

Specified by:

setGpsWeekNumber in interface NMEAObserver

setSvHealth

public void setSvHealth(int svHealth)

Description copied from interface: NMEAObserver

ALM

Specified by:

setSvHealth in interface NMEAObserver

setEccentricity

public void setEccentricity(float eccentricity)

Description copied from interface: NMEAObserver

ALM

Specified by:

setEccentricity in interface NMEAObserver

setAlmanacReferenceTime

public void setAlmanacReferenceTime(float almanacReferenceTime)

Description copied from interface: NMEAObserver

ALM

Specified by:

setAlmanacReferenceTime in interface NMEAObserver

setInclinationAngle

public void setInclinationAngle(float inclinationAngle)

Description copied from interface: NMEAObserver

ALM

Specified by:

setInclinationAngle in interface NMEAObserver

setRateOfRightAscension

public void setRateOfRightAscension(float rateOfRightAscension)

Description copied from interface: NMEAObserver

ALM

Specified by:

setRateOfRightAscension in interface NMEAObserver

setRootOfSemiMajorAxis

public void setRootOfSemiMajorAxis(float rootOfSemiMajorAxis)

Description copied from interface: NMEAObserver

ALM

Specified by:

setRootOfSemiMajorAxis in interface NMEAObserver

setArgumentOfPerigee

public void setArgumentOfPerigee(float argumentOfPerigee)

Description copied from interface: NMEAObserver

ALM

Specified by:

setArgumentOfPerigee in interface NMEAObserver

setLongitudeOfAscensionNode

public void setLongitudeOfAscensionNode(float longitudeOfAscensionNode)

Description copied from interface: NMEAObserver

ALM

Specified by:

setLongitudeOfAscensionNode in interface NMEAObserver

setMeanAnomaly

public void setMeanAnomaly(float meanAnomaly)

Description copied from interface: NMEAObserver

ALM

Specified by:

setMeanAnomaly in interface NMEAObserver

setF0ClockParameter

public void setF0ClockParameter(float f0ClockParameter)

Description copied from interface: NMEAObserver

ALM

Specified by:

setF0ClockParameter in interface NMEAObserver

setF1ClockParameter

public void setF1ClockParameter(float f1ClockParameter)

Description copied from interface: NMEAObserver

ALM

Specified by:

setF1ClockParameter in interface NMEAObserver

setStatus2

public void setStatus2(char status)

Description copied from interface: NMEAObserver

APA, APB, RSA, XTE

Specified by:

setStatus2 in interface NMEAObserver

setBearingOriginToDestination

public void setBearingOriginToDestination(float bearingOriginToDestination,
                                 char mOrT)

Description copied from interface: NMEAObserver

APA, APB

Specified by:

setBearingOriginToDestination in interface NMEAObserver

setBearingPresentPositionToDestination

public void setBearingPresentPositionToDestination(float bearingPresentPositionToDestination,
                                          char mOrT)

Description copied from interface: NMEAObserver

APB

Specified by:

setBearingPresentPositionToDestination in interface NMEAObserver

setHeadingToSteerToDestination

public void setHeadingToSteerToDestination(float headingToSteerToDestination,
                                  char mOrT)

Description copied from interface: NMEAObserver

APB

Specified by:

setHeadingToSteerToDestination in interface NMEAObserver

setFAAModeIndicator

public void setFAAModeIndicator(char faaModeIndicator)

Description copied from interface: NMEAObserver

BWC, GLL, XTE

Specified by:

setFAAModeIndicator in interface NMEAObserver

setHorizontalDatum

public void setHorizontalDatum(String horizontalDatum)

Description copied from interface: NMEAObserver

RMM

Specified by:

setHorizontalDatum in interface NMEAObserver

setMessageMode

public void setMessageMode(char messageMode)

Description copied from interface: NMEAObserver

RTE

Specified by:

setMessageMode in interface NMEAObserver

setWaypoints

public void setWaypoints(List<String> list)

Description copied from interface: NMEAObserver

R00, RTE

Specified by:

setWaypoints in interface NMEAObserver

setDistanceToWaypoint

public void setDistanceToWaypoint(float distanceToWaypoint,
                         char units)

Description copied from interface: NMEAObserver

BWC, BWR WNC

Specified by:

setDistanceToWaypoint in interface NMEAObserver

setDepthBelowKeel

public void setDepthBelowKeel(float depth,
                     char unit)

Description copied from interface: NMEAObserver

DBK

Specified by:

setDepthBelowKeel in interface NMEAObserver

setDepthBelowSurface

public void setDepthBelowSurface(float depth,
                        char unit)

Description copied from interface: NMEAObserver

DBS

Specified by:

setDepthBelowSurface in interface NMEAObserver

setDepthBelowTransducer

public void setDepthBelowTransducer(float depth,
                           char unit)

Description copied from interface: NMEAObserver

DBT

Specified by:

setDepthBelowTransducer in interface NMEAObserver

setBearing

public void setBearing(float bearing,
              char unit)

Description copied from interface: NMEAObserver

BOD, BWC, BWR, BWW

Specified by:

setBearing in interface NMEAObserver

setDepthOfWater

public void setDepthOfWater(float depth,
                   float offset)

Description copied from interface: NMEAObserver

DBT

Specified by:

setDepthOfWater in interface NMEAObserver

setMagneticDeviation

public void setMagneticDeviation(float magneticDeviation)

Description copied from interface: NMEAObserver

HDG

Specified by:

setMagneticDeviation in interface NMEAObserver

setMagneticSensorHeading

public void setMagneticSensorHeading(float magneticSensorHeading)

Description copied from interface: NMEAObserver

HDG

Specified by:

setMagneticSensorHeading in interface NMEAObserver

setHeading

public void setHeading(float heading,
              char unit)

Description copied from interface: NMEAObserver

HDM, HDT

Specified by:

setHeading in interface NMEAObserver

setWaterTemperature

public void setWaterTemperature(float waterTemperature,
                       char unit)

Description copied from interface: NMEAObserver

MTW

Specified by:

setWaterTemperature in interface NMEAObserver

setWindAngle

public void setWindAngle(float windAngle,
                char unit)

Description copied from interface: NMEAObserver

MWV

Specified by:

setWindAngle in interface NMEAObserver

Parameters:

windAngle - Wind Angle, 0 to 360 degrees

unit - Reference, R = Relative, T = True

setWindSpeed

public void setWindSpeed(float windSpeed,
                char unit)

Description copied from interface: NMEAObserver

MWV, VWR

Specified by:

setWindSpeed in interface NMEAObserver

unit - Wind Speed Units, K/M/N

setRateOfTurn

public void setRateOfTurn(float rateOfTurn)

Description copied from interface: NMEAObserver

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

Specified by:

setRateOfTurn in interface NMEAObserver

setRpmSource

public void setRpmSource(char rpmSource)

Description copied from interface: NMEAObserver

RPM Sourse, S = Shaft, E = Engine

Specified by:

setRpmSource in interface NMEAObserver

setRpmSourceNumber

public void setRpmSourceNumber(int rpmSourceNumber)

Description copied from interface: NMEAObserver

RPM Engine or shaft number

Specified by:

setRpmSourceNumber in interface NMEAObserver

setRpm

public void setRpm(int rpm)

Description copied from interface: NMEAObserver

RPM Speed, Revolutions per minute

Specified by:

setRpm in interface NMEAObserver

setPropellerPitch

public void setPropellerPitch(float propellerPitch)

Description copied from interface: NMEAObserver

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

Specified by:

setPropellerPitch in interface NMEAObserver

setStarboardRudderSensor

public void setStarboardRudderSensor(float starboardRudderSensor)

Description copied from interface: NMEAObserver

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

Specified by:

setStarboardRudderSensor in interface NMEAObserver

setPortRudderSensor

public void setPortRudderSensor(float portRudderSensor)

Description copied from interface: NMEAObserver

RSA Port rudder sensor

Specified by:

setPortRudderSensor in interface NMEAObserver

setWaterHeading

public void setWaterHeading(float waterHeading,
                   char unit)

Description copied from interface: NMEAObserver

VHW

Specified by:

setWaterHeading in interface NMEAObserver

setWaterSpeed

public void setWaterSpeed(float waterSpeed,
                 char unit)

Description copied from interface: NMEAObserver

VHW

Specified by:

setWaterSpeed in interface NMEAObserver

setWindDirection

public void setWindDirection(float windDirection,
                    char unit)

Description copied from interface: NMEAObserver

VWR Relative wind angle

Specified by:

setWindDirection in interface NMEAObserver

Parameters:

windDirection - Wind direction magnitude in degrees

unit - Wind direction Left/Right of bow

setVelocityToWaypoint

public void setVelocityToWaypoint(float velocityToWaypoint,
                         char unit)

Description copied from interface: NMEAObserver

WCV

Specified by:

setVelocityToWaypoint in interface NMEAObserver

rollback

public void rollback(String reason)

Specified by:

rollback in interface Transactional

commit

public void commit(String reason)

Specified by:

commit in interface Transactional