org.openstreetmap.josm.io.nmea

Class NmeaReader

java.lang.Object

org.openstreetmap.josm.io.nmea.NmeaReader

All Implemented Interfaces:

IGpxReader

public class NmeaReader
extends java.lang.Object
implements IGpxReader

Reads a NMEA 0183 file. Based on information from http://www.catb.org/gpsd. NMEA files are in printable ASCII form and may include information such as position, speed, depth, frequency allocation, etc. Typical messages might be 11 to a maximum of 79 characters in length. NMEA standard aims to support one-way serial data transmission from a single "talker" to one or more "listeners". The type of talker is identified by a 2-character mnemonic. NMEA information is encoded through a list of "sentences".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	NmeaReader.GGA Global Positioning System Fix Data.
(package private) static class	NmeaReader.GLL Geographic Position - Latitude/Longitude.
(package private) static class	NmeaReader.GSA GNSS DOP and Active Satellites.
private static class	NmeaReader.NMEAParserState
(package private) static class	NmeaReader.RMC Recommended Minimum Specific GNSS Data.
(package private) static class	NmeaReader.VTG Course Over Ground and Ground Speed.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) GpxData	data
private static java.util.regex.Pattern	DATE_TIME_PATTERN
NmeaReader.NMEAParserState	ps
private java.text.SimpleDateFormat	rmcTimeFmt
private java.io.InputStream	source

Constructor Summary

Constructors

Constructor and Description
NmeaReader(java.io.InputStream source) Constructs a new NmeaReader

Method Summary

Modifier and Type	Method and Description
GpxData	getGpxData() Replies the GPX data.
int	getNumberOfCoordinates() Returns the number of coordinates that have been successfuly read.
int	getParserChecksumErrors()
int	getParserMalformed()
int	getParserUnknown()
int	getParserZeroCoordinates()
(package private) static boolean	isSentence(java.lang.String address, Sentence formatter) Determines if the given address denotes the given NMEA sentence formatter of a known talker.
boolean	parse(boolean tryToFinish) Parse the GPX data.
private static LatLon	parseLatLon(java.lang.String ns, java.lang.String ew, java.lang.String dlat, java.lang.String dlon)
private boolean	parseNMEASentence(java.lang.String s, NmeaReader.NMEAParserState ps)
private java.util.Date	readTime(java.lang.String p)

Methods inherited from class java.lang.Object

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

Field Detail

source

private final java.io.InputStream source

data

GpxData data

DATE_TIME_PATTERN

private static final java.util.regex.Pattern DATE_TIME_PATTERN

rmcTimeFmt

private final java.text.SimpleDateFormat rmcTimeFmt

ps

public NmeaReader.NMEAParserState ps

Constructor Detail

NmeaReader

public NmeaReader(java.io.InputStream source)
           throws java.io.IOException

Constructs a new NmeaReader

Parameters:

source - NMEA file input stream

Throws:

java.io.IOException - if an I/O error occurs

Method Detail

readTime

private java.util.Date readTime(java.lang.String p)
                         throws IllegalDataException

Throws:

IllegalDataException

getParserUnknown

public int getParserUnknown()

getParserZeroCoordinates

public int getParserZeroCoordinates()

getParserChecksumErrors

public int getParserChecksumErrors()

getParserMalformed

public int getParserMalformed()

getNumberOfCoordinates

public int getNumberOfCoordinates()

Returns the number of coordinates that have been successfuly read.

Returns:

the number of coordinates that have been successfuly read

parse

public boolean parse(boolean tryToFinish)
              throws org.xml.sax.SAXException,
                     java.io.IOException

Description copied from interface: IGpxReader

Parse the GPX data.

Specified by:

parse in interface IGpxReader

Parameters:

tryToFinish - true, if the reader should return at least part of the GPX data in case of an error.

Returns:

true if file was properly parsed, false if there was error during parsing but some data were parsed anyway

Throws:

org.xml.sax.SAXException - if any SAX parsing error occurs

java.io.IOException - if any I/O error occurs

isSentence

static boolean isSentence(java.lang.String address,
                          Sentence formatter)

Determines if the given address denotes the given NMEA sentence formatter of a known talker.

Parameters:

address - first tag of an NMEA sentence

formatter - sentence formatter mnemonic code

Returns:

true if the address denotes the given NMEA sentence formatter of a known talker

parseNMEASentence

private boolean parseNMEASentence(java.lang.String s,
                                  NmeaReader.NMEAParserState ps)
                           throws IllegalDataException

Throws:

IllegalDataException

parseLatLon

private static LatLon parseLatLon(java.lang.String ns,
                                  java.lang.String ew,
                                  java.lang.String dlat,
                                  java.lang.String dlon)

getGpxData

public GpxData getGpxData()

Description copied from interface: IGpxReader

Replies the GPX data.

Specified by:

getGpxData in interface IGpxReader

Returns:

The GPX data