net.sf.marineapi.nmea.sentence
Interface WPLSentence

All Superinterfaces:

Sentence

public interface WPLSentence
extends Sentence

Destination waypoint location and ID. This sentence is transmitted by some GPS models in GOTO mode.

Example:
$GPWPL,5536.200,N,01436.500,E,RUSKI*1F

Author:

Kimmo Tuukkanen

Field Summary

Fields inherited from interface net.sf.marineapi.nmea.sentence.Sentence

ALTERNATIVE_BEGIN_CHAR, BEGIN_CHAR, CHECKSUM_DELIMITER, FIELD_DELIMITER, MAX_LENGTH, TERMINATOR

Method Summary

Waypoint	getWaypoint() Get the destination waypoint.
void	setWaypoint(Waypoint wp) Set the destination waypoint.

Methods inherited from interface net.sf.marineapi.nmea.sentence.Sentence

getBeginChar, getFieldCount, getSentenceId, getTalkerId, isProprietary, isValid, reset, setBeginChar, setTalkerId, toSentence, toSentence, toString

Method Detail

getWaypoint

Waypoint getWaypoint()

Get the destination waypoint.

Returns:

Waypoint

Throws:

DataNotAvailableException - If any of the waypoint related data is not available.

ParseException - If any of the waypoint related fields contain unexpected or illegal value.

setWaypoint

void setWaypoint(Waypoint wp)

Set the destination waypoint.

Parameters:

wp - Waypoint to set