Class: NMEAPlus::Message::NMEA::APA
- Inherits:
-
NMEAMessage
- Object
- Base
- NMEAMessage
- NMEAPlus::Message::NMEA::APA
- 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.
Direct Known Subclasses
Instance Attribute Summary collapse
-
#arrival_circle_entered? ⇒ Object
readonly
Status: arrival circle entered.
-
#bearing_origin_to_destination ⇒ Object
readonly
Bearing origin to destination, Mag.
-
#compass_type ⇒ Object
readonly
Field 9 of the payload, formatted with the function #_string.
-
#cross_track_error ⇒ Object
readonly
Magnitude of XTE (cross-track-error).
-
#cross_track_units ⇒ Object
readonly
XTE units, nautical miles.
-
#destination_waypoint_id ⇒ Object
readonly
Destination waypoint ID.
-
#direction_to_steer ⇒ Object
readonly
Direction to steer, L/R.
-
#no_cyclelock_warning? ⇒ Object
readonly
Data status: Loran-C Cycle Lock warning flag.
-
#no_general_warning? ⇒ Object
readonly
Data Status: “OR” of Loran-C Blink and SNR warning flags.
-
#perpendicular_passed? ⇒ Object
readonly
Status: perpendicular passed at waypoint.
Attributes inherited from NMEAMessage
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
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
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.
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.
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)
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
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
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
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
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
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
34 |
# File 'lib/nmea_plus/message/nmea/apa.rb', line 34 field_reader :perpendicular_passed?, 7, :_av_boolean |