Class: NMEAPlus::Message::NMEA::DCN

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

Overview

DCN - DECCA Position

Status and lines-of-position for a specified DECCA chain.

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

#decca_chain_idObject (readonly)

DECCA chain identifier

Returns:

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



11
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 11

field_reader :decca_chain_id, 1, :_integer

#fix_data_basisObject (readonly)

Fix data basis:

1 = Normal pattern 2 = Lane identification pattern 3 = Lane identification transmissions

Returns:

  • field 16 of the payload, formatted with the function #_integer



58
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 58

field_reader :fix_data_basis, 16, :_integer

#fix_data_basis_descriptionString (readonly)

Textual description of fix data basis

Returns:

  • (String)


63
64
65
66
67
68
69
70
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 63

def fix_data_basis_description
  case fix_data_basis
  when 1 then return "Normal pattern"
  when 2 then return "Lane identification pattern"
  when 3 then return "Lane identification transmissions"
  end
  nil
end

#green_master_line_ok?Object (readonly)

Status: Green-master line, true = Valid, false = Data not valid

Returns:

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



29
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 29

field_reader :green_master_line_ok?, 7, :_av_boolean

#green_position_lineObject (readonly)

Green line of position (LOP)

Returns:

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



26
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 26

field_reader :green_position_line, 6, :_float

#green_zone_idObject (readonly)

Green zone identifier, number-letter

Returns:

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



23
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 23

field_reader :green_zone_id, 5, :_string

#position_uncertaintyObject (readonly)

Position uncertainty, n. miles

Returns:

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



50
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 50

field_reader :position_uncertainty, 14, :_float

#position_uncertainty_unitsObject (readonly)

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

Returns:

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



51
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 51

field_reader :position_uncertainty_units, 15, :_string

#purple_master_line_ok?Object (readonly)

Status: Purple-master line, true = Valid, false = Data not valid

Returns:

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



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

field_reader :purple_master_line_ok?, 10, :_av_boolean

#purple_position_lineObject (readonly)

Purple line of position (LOP)

Returns:

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



35
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 35

field_reader :purple_position_line, 9, :_float

#purple_zone_idObject (readonly)

Purple zone identifier, number-letter

Returns:

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



32
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 32

field_reader :purple_zone_id, 8, :_string

#red_master_line_ok?Object (readonly)

Status: Red-master line, true = Valid, false = Data not valid

Returns:

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



20
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 20

field_reader :red_master_line_ok?, 4, :_av_boolean

#red_position_lineObject (readonly)

Red line of position (LOP)

Returns:

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



17
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 17

field_reader :red_position_line, 3, :_float

#red_zone_idObject (readonly)

Red zone identifier, number-letter

Returns:

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



14
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 14

field_reader :red_zone_id, 2, :_string

#use_green_line_navigation?Object (readonly)

Green-line navigation use

Returns:

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



44
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 44

field_reader :use_green_line_navigation?, 12, :_av_boolean

#use_purple_line_navigation?Object (readonly)

Purple-line navigation use

Returns:

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



47
# File 'lib/nmea_plus/message/nmea/dcn.rb', line 47

field_reader :use_purple_line_navigation?, 13, :_av_boolean

#use_red_line_navigation?Object (readonly)

Red-line navigation use

Returns:

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



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

field_reader :use_red_line_navigation?, 11, :_av_boolean