Class: Fit4Ruby::FitDefinitionField

Inherits:
BinData::Record
  • Object
show all
Defined in:
lib/fit4ruby/FitDefinitionField.rb

Constant Summary collapse

@@TypeDefs = 
[
  # FIT Type, BinData type, undefined value, bytes
  [ 'enum', 'uint8', 0xFF, 1 ],
  [ 'sint8', 'int8', 0x7F, 1 ],
  [ 'uint8', 'uint8', 0xFF, 1 ],
  [ 'sint16', 'int16', 0x7FFF, 2 ],
  [ 'uint16', 'uint16', 0xFFFF, 2 ],
  [ 'sint32', 'int32', 0x7FFFFFFF, 4 ],
  [ 'uint32', 'uint32', 0xFFFFFFFF, 4 ],
  [ 'string', 'stringz', '', 0 ],
  [ 'float32', 'float', 0xFFFFFFFF, 4 ],
  [ 'float63', 'double', 0xFFFFFFFF, 4 ],
  [ 'uint8z', 'uint8', 0, 1 ],
  [ 'uint16z', 'uint16', 0, 2 ],
  [ 'uint32z', 'uint32', 0, 4 ],
  [ 'byte', 'uint8', 0xFF, 1 ]
]

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.fit_type_to_bin_data(fit_type) ⇒ Object 



48
49
50
51
52
 
# File 'lib/fit4ruby/FitDefinitionField.rb', line 48

def self.fit_type_to_bin_data(fit_type)
  entry = @@TypeDefs.find { |e| e[0] == fit_type }
  raise "Unknown fit type #{fit_type}" unless entry
  entry[1]
end

.undefined_value(fit_type) ⇒ Object 



54
55
56
57
58
 
# File 'lib/fit4ruby/FitDefinitionField.rb', line 54

def self.undefined_value(fit_type)
  entry = @@TypeDefs.find { |e| e[0] == fit_type }
  raise "Unknown fit type #{fit_type}" unless entry
  entry[2]
end

Instance Method Details

#init ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/fit4ruby/FitDefinitionField.rb', line 60

def init
  @global_message_number = parent.parent.global_message_number.snapshot
  @global_message_definition = GlobalFitMessages[@global_message_number]
  field_number = field_definition_number.snapshot
  if @global_message_definition &&
     (field = @global_message_definition.fields[field_number])
     @name = field.name
     @type = field.type

     if @type && (td = @@TypeDefs[base_type_number]) && td[0] != @type
       Log.warn "#{@global_message_number}:#{@name} must be of type " +
       "#{@type}, not #{td[0]}"
     end
  else
    @name = "field#{field_definition_number.snapshot}"
    @type = nil
    Log.warn { "Unknown field number #{field_definition_number} " +
               "in global message #{@global_message_number}" }
  end
end

#name ⇒ Object 



81
82
83
84
 
# File 'lib/fit4ruby/FitDefinitionField.rb', line 81

def name
  init unless @global_message_number
  @name
end

#set_type(fit_type) ⇒ Object 



112
113
114
115
116
117
 
# File 'lib/fit4ruby/FitDefinitionField.rb', line 112

def set_type(fit_type)
  idx = @@TypeDefs.index { |x| x[0] == fit_type }
  raise "Unknown type #{fit_type}" unless idx
  self.base_type_number = idx
  self.byte_count = @@TypeDefs[idx][3]
end

#to_machine(value) ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/fit4ruby/FitDefinitionField.rb', line 86

def to_machine(value)
  init unless @global_message_number
  value = nil if value == undefined_value

  field_number = field_definition_number.snapshot
  if @global_message_definition &&
     (field = @global_message_definition.fields[field_number])
    field.to_machine(value)
  else
    value
  end
end

#to_s(value) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/fit4ruby/FitDefinitionField.rb', line 99

def to_s(value)
  init unless @global_message_number
  value = nil if value == undefined_value

  field_number = field_definition_number.snapshot
  if @global_message_definition &&
     (field = @global_message_definition.fields[field_number])
    field.to_s(value)
  else
    "[#{value.to_s}]"
  end
end

#type(fit_type = false) ⇒ Object 



119
120
121
122
123
124
125
 
# File 'lib/fit4ruby/FitDefinitionField.rb', line 119

def type(fit_type = false)
  if @@TypeDefs.length <= base_type_number.snapshot
    Log.fatal "Unknown FIT Base type #{base_type_number.snapshot}"
  end

  @@TypeDefs[base_type_number.snapshot][fit_type ? 0 : 1]
end

#undefined_value ⇒ Object 



127
128
129
130
131
132
133
 
# File 'lib/fit4ruby/FitDefinitionField.rb', line 127

def undefined_value
  if @@TypeDefs.length <= base_type_number.snapshot
    Log.fatal "Unknown FIT Base type #{base_type_number.snapshot}"
  end

  @@TypeDefs[base_type_number.snapshot][2]
end