Class: NMEAPlus::Message::NMEA::STR

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

Overview

STR - Tracking Reference

Transmitted prior to a sentence containing velocity-based data to indicate when velocity is measured over-the-ground or relative to the water.

The use of appropriate ground or water-referenced approved sentences such as $–VBW, $–VHW or $–VTG is recommended.

See Also:

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

#tracking_reference ⇒ Symbol (readonly)

Tracking reference

Returns:

  • (Symbol) 


21
22
23
24
 
# File 'lib/nmea_plus/message/nmea/str.rb', line 21

def tracking_reference
  NMEA::NMEAMessage._av_boolean(@fields[1]) ? :ground : :water

end

#tracking_reference_description ⇒ String (readonly)

Description of tracking reference

Returns:

  • (String) 


29
30
31
32
33
34
 
# File 'lib/nmea_plus/message/nmea/str.rb', line 29

def tracking_reference_description
  case tracking_reference
  when :ground then "Ground reference"
  when :water then "Water reference"
  end
end