net.sf.marineapi.nmea.event
Interface SentenceListener

All Superinterfaces:
EventListener
All Known Implementing Classes:
TPVProvider

public interface SentenceListener
extends EventListener

Base interface for listening to SentenceEvents.

Version:
$Revision: 100 $
Author:
Kimmo Tuukkanen
See Also:
SentenceReader, SentenceEvent

Method Summary
 void readingPaused()
          Called when NMEA data flow has paused for some reason, e.g. when reached the end of file or device has stopped providing data, but the reader is still running and waiting for more data.
 void readingStarted()
          Called when NMEA data is found in stream and reader starts dispatching SentenceEvents.
 void readingStopped()
          Invoked after SentenceReader has stopped reading the input stream, either due to error or explicit request by calling SentenceReader.stop().
 void sentenceRead(SentenceEvent event)
          Invoked when valid NMEA 0183 data has been read by SentenceReader.
 

Method Detail

readingPaused

void readingPaused()
Called when NMEA data flow has paused for some reason, e.g. when reached the end of file or device has stopped providing data, but the reader is still running and waiting for more data. Timeout for pause event to occur is 5 seconds.


readingStarted

void readingStarted()
Called when NMEA data is found in stream and reader starts dispatching SentenceEvents. Also, this notification occurs when events dispatching continues after readingPaused() has occurred.


readingStopped

void readingStopped()
Invoked after SentenceReader has stopped reading the input stream, either due to error or explicit request by calling SentenceReader.stop().


sentenceRead

void sentenceRead(SentenceEvent event)
Invoked when valid NMEA 0183 data has been read by SentenceReader.

Parameters:
event - SentenceEvent containing the data.


Copyright (C) 2010-2011 Java Marine API author(s). All Rights Reserved.