接口 APBSentence
- 所有超级接口:
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
- 作者:
- Kimmo Tuukkanen
-
字段概要
字段从接口继承的字段 net.sf.marineapi.nmea.sentence.Sentence
ALTERNATIVE_BEGIN_CHAR, BEGIN_CHAR, CHECKSUM_DELIMITER, FIELD_DELIMITER, MAX_LENGTH, TERMINATOR -
方法概要
修饰符和类型方法说明doubleReturns bearing from origin to destination.doubleReturns the bearing from current position to destination waypoint.doubleReturns the cross-track error magnitude/distance.charReturns the unit of cross-track error.Returns the Loran-C cycle lock status, not used for GPS.Returns the destination waypoint id/name.doubleReturns the heading to steer to destination waypoint.Returns the signal/fix status, LORAN-C Blink or SNR warning.Returns the direction in which to steer in order to get back on route.booleanTells if vessel has entered the arrival circle.booleanTells if the bearing from origin to destination is true or magnetic.booleanTells if the bearing from current position to destionation is true or magnetic.booleanTells if the heading to destionation is true or magnetic.booleanTells if vessel has passed perpendicular at waypoint.voidsetArrivalCircleEntered(boolean isEntered) Sets the arrival circle enter status.voidsetBearingOriginToDestination(double bearing) Sets the bearing from origin to destination.voidsetBearingOriginToDestionationTrue(boolean isTrue) Sets the bearing from origin to destination true or magnetic.voidsetBearingPositionToDestination(double bearing) Sets the bearing from current position to destination waypoint.voidsetBearingPositionToDestinationTrue(boolean isTrue) Sets the bearing from current position to destination true or magnetic.voidsetCrossTrackError(double distance) Sets the cross-track error magnitude/distance.voidsetCrossTrackUnits(char unit) Sets the unit of cross-track error.voidsetCycleLockStatus(DataStatus status) Sets the Loran-C cycle lock status.voidReturns the destination waypoint id/name.voidsetHeadingToDestination(double heading) Sets the heading to destination waypoint.voidsetHeadingToDestinationTrue(boolean isTrue) Sets the heading to destionation true or magnetic.voidsetPerpendicularPassed(boolean isPassed) Sets the perpendicular to waypoint pass status.voidsetStatus(DataStatus status) Sets the signal/fix status, LORAN-C Blink or SNR warning.voidsetSteerTo(Direction direction) Set direction in which to steer in order to get back on route.从接口继承的方法 net.sf.marineapi.nmea.sentence.Sentence
getBeginChar, getFieldCount, getSentenceId, getTalkerId, isAISSentence, isProprietary, isValid, reset, setBeginChar, setTalkerId, toSentence, toSentence, toString
-
字段详细资料
-
方法详细资料
-
getBearingPositionToDestination
double getBearingPositionToDestination()Returns the bearing from current position to destination waypoint.- 返回:
- bearing in degrees
-
getBearingOriginToDestination
double getBearingOriginToDestination()Returns bearing from origin to destination.- 返回:
- bearing in degrees
-
getCrossTrackError
double getCrossTrackError()Returns the cross-track error magnitude/distance.- 返回:
- Cross-track error distance in nautical miles
-
getCrossTrackUnits
char getCrossTrackUnits()Returns the unit of cross-track error.- 返回:
- Unit char indicator
-
getCycleLockStatus
DataStatus getCycleLockStatus()Returns the Loran-C cycle lock status, not used for GPS.- 返回:
- Loran-C cycle lock status.
-
getDestionationWaypointId
String getDestionationWaypointId()Returns the destination waypoint id/name.- 返回:
- Waypoint id
-
getHeadingToDestionation
double getHeadingToDestionation()Returns the heading to steer to destination waypoint.- 返回:
- Heading in degrees
-
getStatus
DataStatus getStatus()Returns the signal/fix status, LORAN-C Blink or SNR warning.- 返回:
- DataStatus
-
getSteerTo
Direction getSteerTo()Returns the direction in which to steer in order to get back on route.- 返回:
Direction.LEFTorDirection.RIGHT
-
isArrivalCircleEntered
boolean isArrivalCircleEntered()Tells if vessel has entered the arrival circle.- 返回:
- True if entered, otherwise false.
-
isBearingOriginToDestionationTrue
boolean isBearingOriginToDestionationTrue()Tells if the bearing from origin to destination is true or magnetic.- 返回:
- True if true heading, false for magnetic.
-
isBearingPositionToDestinationTrue
boolean isBearingPositionToDestinationTrue()Tells if the bearing from current position to destionation is true or magnetic.- 返回:
- True if true heading, false for magnetic.
-
isHeadingToDestinationTrue
boolean isHeadingToDestinationTrue()Tells if the heading to destionation is true or magnetic.- 返回:
- True if true heading, false for magnetic.
-
isPerpendicularPassed
boolean isPerpendicularPassed()Tells if vessel has passed perpendicular at waypoint.- 返回:
- True if passed, otherwise false.
-
setArrivalCircleEntered
void setArrivalCircleEntered(boolean isEntered) Sets the arrival circle enter status.- 参数:
isEntered- True if entered, otherwise false.
-
setBearingOriginToDestination
void setBearingOriginToDestination(double bearing) Sets the bearing from origin to destination.- 参数:
bearing- bearing in degrees
-
setBearingOriginToDestionationTrue
void setBearingOriginToDestionationTrue(boolean isTrue) Sets the bearing from origin to destination true or magnetic.- 参数:
isTrue- True if true bearing, false for magnetic.
-
setBearingPositionToDestination
void setBearingPositionToDestination(double bearing) Sets the bearing from current position to destination waypoint.- 参数:
bearing- bearing in degrees
-
setBearingPositionToDestinationTrue
void setBearingPositionToDestinationTrue(boolean isTrue) Sets the bearing from current position to destination true or magnetic.- 参数:
isTrue- True if true bearing, false for magnetic.
-
setCrossTrackError
void setCrossTrackError(double distance) Sets the cross-track error magnitude/distance.- 参数:
distance- Cross-track error distance in nautical miles
-
setCrossTrackUnits
void setCrossTrackUnits(char unit) Sets the unit of cross-track error.- 参数:
unit- Unit char to set
-
setCycleLockStatus
Sets the Loran-C cycle lock status. Not used for GPS, may be omitted orDataStatus.VOID.- 参数:
status- DataStatus to set
-
setDestinationWaypointId
Returns the destination waypoint id/name.- 参数:
id- Waypoint ID to set.
-
setHeadingToDestination
void setHeadingToDestination(double heading) Sets the heading to destination waypoint.- 参数:
heading- heading in degrees
-
setHeadingToDestinationTrue
void setHeadingToDestinationTrue(boolean isTrue) Sets the heading to destionation true or magnetic.- 参数:
isTrue- True if true heading, false for magnetic.
-
setPerpendicularPassed
void setPerpendicularPassed(boolean isPassed) Sets the perpendicular to waypoint pass status.- 参数:
isPassed- True if passed, otherwise false.
-
setStatus
Sets the signal/fix status, LORAN-C Blink or SNR warning.- 参数:
status- DataStatus to set.
-
setSteerTo
Set direction in which to steer in order to get back on route.- 参数:
direction-Direction.RIGHTorDirection.LEFT
-