APBSentence (Java Marine API v0.10.0 (b20170621210314))

All Superinterfaces:

Sentence
```
public interface APBSentence
extends Sentence
```
Autopilot sentence "type B", cross-track error, bearings and heading towards destination waypoint. This is a fixed form of the APA sentence with some ambiguities removed.

Note: Some autopilots, Robertson in particular, misinterpret "bearing from origin to destination" as "bearing from present position to destination".

Example:
$GPAPB,A,A,0.10,R,N,V,V,011,M,DEST,011,M,011,M*82

Author:

Kimmo Tuukkanen

Field Summary

Fields
Modifier and Type Field and Description

static char KM
Kilometers

static char NM
Nautical miles
- Fields inherited from interface net.sf.marineapi.nmea.sentence.Sentence
  ALTERNATIVE_BEGIN_CHAR, BEGIN_CHAR, CHECKSUM_DELIMITER, FIELD_DELIMITER, MAX_LENGTH, TERMINATOR

Fields
Modifier and Type	Field and Description
`static char`	`KM` Kilometers
`static char`	`NM` Nautical miles

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`double`	`getBearingOriginToDestination()` Returns bearing from origin to destination.
`double`	`getBearingPositionToDestination()` Returns the bearing from current position to destination waypoint.
`double`	`getCrossTrackError()` Returns the cross-track error magnitude/distance.
`char`	`getCrossTrackUnits()` Returns the unit of cross-track error.
`DataStatus`	`getCycleLockStatus()` Returns the Loran-C cycle lock status, not used for GPS.
`String`	`getDestionationWaypointId()` Returns the destination waypoint id/name.
`double`	`getHeadingToDestionation()` Returns the heading to steer to destination waypoint.
`DataStatus`	`getStatus()` Returns the signal/fix status, LORAN-C Blink or SNR warning.
`Direction`	`getSteerTo()` Returns the direction in which to steer in order to get back on route.
`boolean`	`isArrivalCircleEntered()` Tells if vessel has entered the arrival circle.
`boolean`	`isBearingOriginToDestionationTrue()` Tells if the bearing from origin to destination is true or magnetic.
`boolean`	`isBearingPositionToDestinationTrue()` Tells if the bearing from current position to destionation is true or magnetic.
`boolean`	`isHeadingToDestinationTrue()` Tells if the heading to destionation is true or magnetic.
`boolean`	`isPerpendicularPassed()` Tells if vessel has passed perpendicular at waypoint.
`void`	`setArrivalCircleEntered(boolean isEntered)` Sets the arrival circle enter status.
`void`	`setBearingOriginToDestination(double bearing)` Sets the bearing from origin to destination.
`void`	`setBearingOriginToDestionationTrue(boolean isTrue)` Sets the bearing from origin to destination true or magnetic.
`void`	`setBearingPositionToDestination(double bearing)` Sets the bearing from current position to destination waypoint.
`void`	`setBearingPositionToDestinationTrue(boolean isTrue)` Sets the bearing from current position to destination true or magnetic.
`void`	`setCrossTrackError(double distance)` Sets the cross-track error magnitude/distance.
`void`	`setCrossTrackUnits(char unit)` Sets the unit of cross-track error.
`void`	`setCycleLockStatus(DataStatus status)` Sets the Loran-C cycle lock status.
`void`	`setDestinationWaypointId(String id)` Returns the destination waypoint id/name.
`void`	`setHeadingToDestination(double heading)` Sets the heading to destination waypoint.
`void`	`setHeadingToDestinationTrue(boolean isTrue)` Sets the heading to destionation true or magnetic.
`void`	`setPerpendicularPassed(boolean isPassed)` Sets the perpendicular to waypoint pass status.
`void`	`setStatus(DataStatus status)` Sets the signal/fix status, LORAN-C Blink or SNR warning.
`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, isAISSentence, isProprietary, isValid, reset, setBeginChar, setTalkerId, toSentence, toSentence, toString

- Field Detail
  - KM
```
static final char KM
```
    Kilometers
    
    See Also:
    
    Constant Field Values
  - NM
```
static final char NM
```
    Nautical miles
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getBearingPositionToDestination
```
double getBearingPositionToDestination()
```
    Returns the bearing from current position to destination waypoint.
    
    Returns:
    
    bearing in degrees
  - getBearingOriginToDestination
```
double getBearingOriginToDestination()
```
    Returns bearing from origin to destination.
    
    Returns:
    
    bearing in degrees
  - getCrossTrackError
```
double getCrossTrackError()
```
    Returns the cross-track error magnitude/distance.
    
    Returns:
    
    Cross-track error distance in nautical miles
  - getCrossTrackUnits
```
char getCrossTrackUnits()
```
    Returns the unit of cross-track error.
    
    Returns:
    
    Unit char indicator
  - getCycleLockStatus
```
DataStatus getCycleLockStatus()
```
    Returns the Loran-C cycle lock status, not used for GPS.
  - getDestionationWaypointId
```
String getDestionationWaypointId()
```
    Returns the destination waypoint id/name.
    
    Returns:
    
    Waypoint id
  - getHeadingToDestionation
```
double getHeadingToDestionation()
```
    Returns the heading to steer to destination waypoint.
    
    Returns:
    
    Heading in degrees
  - getStatus
```
DataStatus getStatus()
```
    Returns the signal/fix status, LORAN-C Blink or SNR warning.
    
    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
  - isArrivalCircleEntered
```
boolean isArrivalCircleEntered()
```
    Tells if vessel has entered the arrival circle.
    
    Returns:
    
    True if entered, otherwise false.
  - isBearingOriginToDestionationTrue
```
boolean isBearingOriginToDestionationTrue()
```
    Tells if the bearing from origin to destination is true or magnetic.
    
    Returns:
    
    True if true heading, false for magnetic.
  - isBearingPositionToDestinationTrue
```
boolean isBearingPositionToDestinationTrue()
```
    Tells if the bearing from current position to destionation is true or magnetic.
    
    Returns:
    
    True if true heading, false for magnetic.
  - isHeadingToDestinationTrue
```
boolean isHeadingToDestinationTrue()
```
    Tells if the heading to destionation is true or magnetic.
    
    Returns:
    
    True if true heading, false for magnetic.
  - isPerpendicularPassed
```
boolean isPerpendicularPassed()
```
    Tells if vessel has passed perpendicular at waypoint.
    
    Returns:
    
    True if passed, otherwise false.
  - setArrivalCircleEntered
```
void setArrivalCircleEntered(boolean isEntered)
```
    Sets the arrival circle enter status.
    
    Parameters:
    
    isEntered - True if entered, otherwise false.
  - setBearingOriginToDestination
```
void setBearingOriginToDestination(double bearing)
```
    Sets the bearing from origin to destination.
    
    Parameters:
    
    bearing - bearing in degrees
  - setBearingOriginToDestionationTrue
```
void setBearingOriginToDestionationTrue(boolean isTrue)
```
    Sets the bearing from origin to destination true or magnetic.
    
    Parameters:
    
    isTrue - True if true bearing, false for magnetic.
  - setBearingPositionToDestination
```
void setBearingPositionToDestination(double bearing)
```
    Sets the bearing from current position to destination waypoint.
    
    Parameters:
    
    bearing - bearing in degrees
  - setBearingPositionToDestinationTrue
```
void setBearingPositionToDestinationTrue(boolean isTrue)
```
    Sets the bearing from current position to destination true or magnetic.
    
    Parameters:
    
    isTrue - True if true bearing, false for magnetic.
  - setCrossTrackError
```
void setCrossTrackError(double distance)
```
    Sets the cross-track error magnitude/distance.
    
    Parameters:
    
    distance - Cross-track error distance in nautical miles
  - setCrossTrackUnits
```
void setCrossTrackUnits(char unit)
```
    Sets the unit of cross-track error.
    
    Parameters:
    
    unit - Unit char to set
  - 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
  - setDestinationWaypointId
```
void setDestinationWaypointId(String id)
```
    Returns the destination waypoint id/name.
    
    Parameters:
    
    id - Waypoint ID to set.
  - setHeadingToDestination
```
void setHeadingToDestination(double heading)
```
    Sets the heading to destination waypoint.
    
    Parameters:
    
    heading - heading in degrees
  - setHeadingToDestinationTrue
```
void setHeadingToDestinationTrue(boolean isTrue)
```
    Sets the heading to destionation true or magnetic.
    
    Parameters:
    
    isTrue - True if true heading, false for magnetic.
  - setPerpendicularPassed
```
void setPerpendicularPassed(boolean isPassed)
```
    Sets the perpendicular to waypoint pass status.
    
    Parameters:
    
    isPassed - True if passed, otherwise false.
  - setStatus
```
void setStatus(DataStatus status)
```
    Sets the signal/fix status, LORAN-C Blink or SNR warning.
    
    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

Interface APBSentence

Field Summary

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

Method Summary

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

Field Detail

KM

NM

Method Detail

getBearingPositionToDestination

getBearingOriginToDestination

getCrossTrackError

getCrossTrackUnits

getCycleLockStatus

getDestionationWaypointId

getHeadingToDestionation

getStatus

getSteerTo

isArrivalCircleEntered

isBearingOriginToDestionationTrue

isBearingPositionToDestinationTrue

isHeadingToDestinationTrue

isPerpendicularPassed

setArrivalCircleEntered

setBearingOriginToDestination

setBearingOriginToDestionationTrue

setBearingPositionToDestination

setBearingPositionToDestinationTrue

setCrossTrackError

setCrossTrackUnits

setCycleLockStatus

setDestinationWaypointId

setHeadingToDestination

setHeadingToDestinationTrue

setPerpendicularPassed

setStatus

setSteerTo