Class: NMEAPlus::Message::NMEA::APA

Inherits:
NMEAMessage show all
Defined in:
lib/nmea_plus/message/nmea/apa.rb

Overview

APA - Autopilot Sentence “A”

Commonly used by autopilots this sentence contains navigation receiver warning flag status, cross-track-error, waypoint arrival status and initial bearing from origin waypoint to the destination waypoint for the active navigation leg of the journey. Use of $–APB with additional data fields of heading-to-steer and bearing from present position to destination is recommended.

See Also:

Direct Known Subclasses

APB

Instance Attribute Summary collapse

Attributes inherited from NMEAMessage

#message_type, #talker

Attributes inherited from Base

#checksum, #data_type, #fields, #interpreted_data_type, #message_number, #next_part, #original, #payload, #prefix, #total_messages

Method Summary

Methods inherited from NMEAMessage

_10_boolean, _av_boolean

Methods inherited from Base

_float, _hex_to_integer, #_highest_contiguous_index, _integer, _interval_hms, _string, _utc_date_time, _utctime_hms, #add_message_part, #all_checksums_ok?, #all_messages_received?, #calculated_checksum, #checksum_ok?, degrees_minutes_to_decimal, field_reader, #highest_contiguous_index, nsew_signed_float

Instance Attribute Details

#arrival_circle_entered? ⇒ Object (readonly)

Status: arrival circle entered

Returns:

  • field 6 of the payload, formatted with the function #_av_boolean



31
 
# File 'lib/nmea_plus/message/nmea/apa.rb', line 31

field_reader :arrival_circle_entered?, 6, :_av_boolean

#bearing_origin_to_destination ⇒ Object (readonly)

Bearing origin to destination, Mag.

Returns:

  • field 8 of the payload, formatted with the function #_float



37
 
# File 'lib/nmea_plus/message/nmea/apa.rb', line 37

field_reader :bearing_origin_to_destination, 8, :_float

#compass_type ⇒ Object (readonly)

Returns field 9 of the payload, formatted with the function #_string.

Returns:

  • field 9 of the payload, formatted with the function #_string



38
 
# File 'lib/nmea_plus/message/nmea/apa.rb', line 38

field_reader :compass_type, 9, :_string

#cross_track_error ⇒ Object (readonly)

Magnitude of XTE (cross-track-error)

Returns:

  • field 3 of the payload, formatted with the function #_float



22
 
# File 'lib/nmea_plus/message/nmea/apa.rb', line 22

field_reader :cross_track_error, 3, :_float

#cross_track_units ⇒ Object (readonly)

XTE units, nautical miles

Returns:

  • field 5 of the payload, formatted with the function #_string



28
 
# File 'lib/nmea_plus/message/nmea/apa.rb', line 28

field_reader :cross_track_units, 5, :_string

#destination_waypoint_id ⇒ Object (readonly)

Destination waypoint ID

Returns:

  • field 10 of the payload, formatted with the function #_string



41
 
# File 'lib/nmea_plus/message/nmea/apa.rb', line 41

field_reader :destination_waypoint_id, 10, :_string

#direction_to_steer ⇒ Object (readonly)

Direction to steer, L/R

Returns:

  • field 4 of the payload, formatted with the function #_string



25
 
# File 'lib/nmea_plus/message/nmea/apa.rb', line 25

field_reader :direction_to_steer, 4, :_string

#no_cyclelock_warning? ⇒ Object (readonly)

Data status: Loran-C Cycle Lock warning flag

Returns:

  • field 2 of the payload, formatted with the function #_av_boolean



19
 
# File 'lib/nmea_plus/message/nmea/apa.rb', line 19

field_reader :no_cyclelock_warning?, 2, :_av_boolean

#no_general_warning? ⇒ Object (readonly)

Data Status: “OR” of Loran-C Blink and SNR warning flags

Returns:

  • field 1 of the payload, formatted with the function #_av_boolean



16
 
# File 'lib/nmea_plus/message/nmea/apa.rb', line 16

field_reader :no_general_warning?, 1, :_av_boolean

#perpendicular_passed? ⇒ Object (readonly)

Status: perpendicular passed at waypoint

Returns:

  • field 7 of the payload, formatted with the function #_av_boolean



34
 
# File 'lib/nmea_plus/message/nmea/apa.rb', line 34

field_reader :perpendicular_passed?, 7, :_av_boolean