net.sf.marineapi.nmea.event

Interface SentenceListener

All Superinterfaces:

EventListener

All Known Implementing Classes:

AbstractProvider, AbstractSentenceListener, HeadingProvider, PositionProvider, SatelliteInfoProvider

public interface SentenceListener
extends EventListener

Base interface for listening to SentenceEvents.

Author:

Kimmo Tuukkanen

See Also:

SentenceReader, SentenceEvent, AbstractSentenceListener

Method Summary

Methods

Modifier and Type	Method and Description
void	readingPaused() Called after SentenceReader has timed out for receiving new data.
void	readingStarted() Called before SentenceReader starts dispatching events.
void	readingStopped() Called after SentenceReader has permanently stopped reading, either due to an error or by calling the SentenceReader.stop() method.
void	sentenceRead(SentenceEvent event) Called by SentenceReader when a single NMEA 0183 sentence has been read and parsed from the data stream.

Method Detail

readingPaused

void readingPaused()

Called after SentenceReader has timed out for receiving new data. Indicates that the reader is still active and waiting for new data which isn't currently available for some reason. For example, the device may have stopped broadcasting or the end of a file has been reached.

Default time for timeout is defined by SentenceReader.DEFAULT_TIMEOUT. This value can be overridden with SentenceReader.setPauseTimeout(int).

readingStarted

void readingStarted()

Called before SentenceReader starts dispatching events. Indicates that the reader is active and receiving data. Also, this notification occurs when the dispatching continues again after readingPaused() has occurred.

readingStopped

void readingStopped()

Called after SentenceReader has permanently stopped reading, either due to an error or by calling the SentenceReader.stop() method.

sentenceRead

void sentenceRead(SentenceEvent event)

Called by SentenceReader when a single NMEA 0183 sentence has been read and parsed from the data stream. By default, only supported sentences defined in SentenceId are dispatched.

Parameters:

event - SentenceEvent containing the data.