net.sf.marineapi.nmea.sentence
Interface XTESentence

All Superinterfaces:

Sentence

public interface XTESentence
extends Sentence

Measured cross-track error when navigating towards waypoint.

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

DataStatus	getCycleLockStatus() Returns the Loran-C cycle lock status, not used for GPS.
double	getMagnitude() Returns the cross-track error magnitude/distance.
FaaMode	getMode() Returns the FAA mode.
DataStatus	getStatus() Returns the signal/fix status.
Direction	getSteerTo() Returns the direction in which to steer in order to get back on route.
void	setCycleLockStatus(DataStatus status) Sets the Loran-C cycle lock status.
void	setMagnitude(double distance) Sets the cross-track error magnitude/distance.
void	setMode(FaaMode mode) Sets the FAA mode.
void	setStatus(DataStatus status) Sets the signal/fix status.
void	setSteerTo(Direction direction) Set direction in which to steer in order to get back on route.

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

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

Method Detail

getCycleLockStatus

DataStatus getCycleLockStatus()

Returns the Loran-C cycle lock status, not used for GPS.

getMagnitude

double getMagnitude()

Returns the cross-track error magnitude/distance.

Returns:

Cross-track error distance in nautical miles

getMode

FaaMode getMode()

Returns the FAA mode. Optional, NMEA 2.3 and later.

Returns:

FaaMode

getStatus

DataStatus getStatus()

Returns the signal/fix status.

Returns:

DataStatus

getSteerTo

Direction getSteerTo()

Returns the direction in which to steer in order to get back on route.

Returns:

Direction.LEFT or Direction.RIGHT

setCycleLockStatus

void setCycleLockStatus(DataStatus status)

Sets the Loran-C cycle lock status. Not used for GPS, may be omitted or DataStatus.VOID.

Parameters:

status - DataStatus to set

setMagnitude

void setMagnitude(double distance)

Sets the cross-track error magnitude/distance.

Parameters:

distance - Cross-track error distance in nautical miles

setMode

void setMode(FaaMode mode)

Sets the FAA mode. Optional, NMEA 2.3 and later.

Parameters:

mode - FaaMode to set

setStatus

void setStatus(DataStatus status)

Sets the signal/fix status.

Parameters:

status - DataStatus to set

setSteerTo

void setSteerTo(Direction direction)

Set direction in which to steer in order to get back on route.

Parameters:

direction - Direction.RIGHT or Direction.LEFT