org.ka2ddo.yaac.gps

Class NmeaLogger

java.lang.Object

org.ka2ddo.yaac.gps.NmeaLogger

All Implemented Interfaces:

ShutdownHandler, GpsLogger

public class NmeaLogger
extends java.lang.Object
implements GpsLogger

This class logs GPS fixes using NMEA-0183 sentences, regardless of whether they are coming into YAAC in NMEA format or not.

Author:

Andrew Pavlin, KA2DDO

Method Summary

Modifier and Type	Method and Description
void	close() Stop using this format of logger.
void	logJSON(java.util.Map<java.lang.String,java.lang.Object> jsonMsg, GpsFix fix, SatelliteCatalog satelliteCatalog, java.lang.String source) Log this GPS JSON event that was received from GPSD.
void	logNMEA(java.lang.String nmeaSentence, GpsFix fix, SatelliteCatalog satelliteCatalog, java.lang.String source) Log this GPS event that was reported as an ASCII NMEA sentence.
void	open() Set up for logging using a new format.
void	shutdown() Do whatever cleanup this object needs for program shutdown.

Methods inherited from class java.lang.Object

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

Method Detail

open

public void open()

Set up for logging using a new format. Note this will not be called for day rollover or similar log segmenting events. That is up to the logger class itself to implement.

Specified by:

open in interface GpsLogger

logNMEA

public void logNMEA(java.lang.String nmeaSentence,
                    GpsFix fix,
                    SatelliteCatalog satelliteCatalog,
                    java.lang.String source)

Log this GPS event that was reported as an ASCII NMEA sentence. Note that there is a YAAC-proprietary NMEA message used to mark an event point in the file, sentence $PYAACMRK, that must also be handled.

Specified by:

logNMEA in interface GpsLogger

Parameters:

nmeaSentence - String of the NMEA sentence to log

fix - the GpsFix object that has been updated (if necessary) by the NMEA sentence, or null if not changed

satelliteCatalog - the SatelliteCatalog that has been updated (if necessary) by the sentence, or null if not changed

source - String name of remote GPS, or null if it is GPS data for the local station

logJSON

public void logJSON(java.util.Map<java.lang.String,java.lang.Object> jsonMsg,
                    GpsFix fix,
                    SatelliteCatalog satelliteCatalog,
                    java.lang.String source)

Log this GPS JSON event that was received from GPSD.

Specified by:

logJSON in interface GpsLogger

Parameters:

jsonMsg - Map<String, Object> of the JSON structure, as returned by Json

fix - the GpsFix object that has been updated (if necessary) by the JSON structure, or null if not changed

satelliteCatalog - the SatelliteCatalog that has been updated (if necessary) by the JSON structure, or null if not changed

source - String name of remote GPS, or null if it is GPS data for the local station

close

public void close()

Stop using this format of logger. Any buffered output will be flushed and the current log file will be closed.

Specified by:

close in interface GpsLogger

shutdown

public void shutdown()

Do whatever cleanup this object needs for program shutdown.

Specified by:

shutdown in interface ShutdownHandler