Class: Fit4Ruby::Activity

Inherits:
FitDataRecord show all
Defined in:
lib/fit4ruby/Activity.rb

Overview

This is the most important class of this library. It holds references to all other data structures. Each of the objects it references are direct equivalents of the message record structures used in the FIT file.

Constant Summary

Constants inherited from FitDataRecord

FitDataRecord::RecordOrder

Instance Attribute Summary collapse

Attributes inherited from FitDataRecord

#message

Instance Method Summary collapse

Methods inherited from FitDataRecord

#<=>, #get, #get_as, #inspect, #set, #set_field_values

Methods included from Converters

#conversion_factor, #fit_time_to_time, #secsToDHMS, #secsToHMS, #speedToPace, #time_to_fit_time

Constructor Details

#initialize(field_values = {}) ⇒ Activity

Create a new Activity object.

Parameters:

  • field_values (Hash) (defaults to: {}) —

    A Hash that provides initial values for certain fields of the FitDataRecord.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/fit4ruby/Activity.rb', line 40

def initialize(field_values = {})
  super('activity')
  @meta_field_units['total_gps_distance'] = 'm'
  @num_sessions = 0

  @file_id = FileId.new
  @file_creator = FileCreator.new
  @device_infos = []
  @data_sources = []
  @user_profiles = []
  @events = []
  @sessions = []
  @laps = []
  @records = []
  @hrv = []
  @personal_records = []

  @cur_session_laps = []
  @cur_lap_records = []

  @lap_counter = 1

  set_field_values(field_values)
end

Instance Attribute Details

#data_sources ⇒ Object

Returns the value of attribute data_sources.



33
34
35
 
# File 'lib/fit4ruby/Activity.rb', line 33

def data_sources
  @data_sources
end

#device_infos ⇒ Object

Returns the value of attribute device_infos.



33
34
35
 
# File 'lib/fit4ruby/Activity.rb', line 33

def device_infos
  @device_infos
end

#events ⇒ Object

Returns the value of attribute events.



33
34
35
 
# File 'lib/fit4ruby/Activity.rb', line 33

def events
  @events
end

#file_creator ⇒ Object

Returns the value of attribute file_creator.



33
34
35
 
# File 'lib/fit4ruby/Activity.rb', line 33

def file_creator
  @file_creator
end

#file_id ⇒ Object

Returns the value of attribute file_id.



33
34
35
 
# File 'lib/fit4ruby/Activity.rb', line 33

def file_id
  @file_id
end

#hrv ⇒ Object

Returns the value of attribute hrv.



33
34
35
 
# File 'lib/fit4ruby/Activity.rb', line 33

def hrv
  @hrv
end

#laps ⇒ Object

Returns the value of attribute laps.



33
34
35
 
# File 'lib/fit4ruby/Activity.rb', line 33

def laps
  @laps
end

#personal_records ⇒ Object

Returns the value of attribute personal_records.



33
34
35
 
# File 'lib/fit4ruby/Activity.rb', line 33

def personal_records
  @personal_records
end

#records ⇒ Object

Returns the value of attribute records.



33
34
35
 
# File 'lib/fit4ruby/Activity.rb', line 33

def records
  @records
end

#sessions ⇒ Object

Returns the value of attribute sessions.



33
34
35
 
# File 'lib/fit4ruby/Activity.rb', line 33

def sessions
  @sessions
end

#user_profiles ⇒ Object

Returns the value of attribute user_profiles.



33
34
35
 
# File 'lib/fit4ruby/Activity.rb', line 33

def user_profiles
  @user_profiles
end

Instance Method Details

#==(a) ⇒ TrueClass/FalseClass

Check if the current Activity is equal to the passed Activity. otherwise false.

Parameters:

  • a (Activity) —

    Activity to compare this Activity with.

Returns:

  • (TrueClass/FalseClass) —

    true if both Activities are equal,



348
349
350
351
352
353
354
355
356
 
# File 'lib/fit4ruby/Activity.rb', line 348

def ==(a)
  super(a) && @file_id == a.file_id &&
    @file_creator == a.file_creator &&
    @device_infos == a.device_infos &&
    @data_sources == a.data_sources &&
    @user_profiles == a.user_profiles &&
    @events == a.events &&
    @sessions == a.sessions && personal_records == a.personal_records
end

#aggregate ⇒ Object

Call this method to update the aggregated data fields stored in Lap and Session objects.



168
169
170
171
 
# File 'lib/fit4ruby/Activity.rb', line 168

def aggregate
  @laps.each { |l| l.aggregate }
  @sessions.each { |s| s.aggregate }
end

#avg_speed ⇒ Object

Convenience method that averages the speed over all sessions.



174
175
176
177
178
 
# File 'lib/fit4ruby/Activity.rb', line 174

def avg_speed
  speed = 0.0
  @sessions.each { |s| speed += s.avg_speed }
  speed / @sessions.length
end

#check ⇒ Object

Perform some basic logical checks on the object and all references sub objects. Any errors will be reported via the Log object.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/fit4ruby/Activity.rb', line 67

def check
  unless @timestamp && @timestamp >= Time.parse('1990-01-01T00:00:00+00:00')
    Log.fatal "Activity has no valid timestamp"
  end
  unless @total_timer_time
    Log.fatal "Activity has no valid total_timer_time"
  end
  unless @device_infos.length > 0
    Log.fatal "Activity must have at least one device_info section"
  end
  @device_infos.each.with_index { |d, index| d.check(index) }
  unless @num_sessions == @sessions.count
    Log.fatal "Activity record requires #{@num_sessions}, but "
              "#{@sessions.length} session records were found in the "
              "FIT file."
  end

  # Records must have consecutively growing timestamps and distances.
  ts = Time.parse('1989-12-31')
  distance = nil
  @records.each do |r|
    Log.fatal "Record has no timestamp" unless r.timestamp
    if r.timestamp < ts
      Log.fatal "Record has earlier timestamp than previous record"
    end
    if r.distance
      if distance && r.distance < distance
        Log.fatal "Record #{r.timestamp} has smaller distance " +
                  "(#{r.distance}) than an earlier record (#{distance})"
      end
      distance = r.distance
    end
    ts = r.timestamp
  end

  # Laps must have a consecutively growing message index.
  @laps.each.with_index do |lap, index|
    lap.check(index)
  end
  @sessions.each { |s| s.check(self) }
end

#ending_hr ⇒ Object

Return the heart rate when the activity recording was last stopped.



181
182
183
 
# File 'lib/fit4ruby/Activity.rb', line 181

def ending_hr
  @records.empty? ? nil : @records[-1].heart_rate
end

#new_data_sources(field_values = {}) ⇒ SourceData

Add a new SourceData to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {}) —

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:

  • (SourceData) 


285
286
287
 
# File 'lib/fit4ruby/Activity.rb', line 285

def new_data_sources(field_values = {})
  new_fit_data_record('data_sources', field_values)
end

#new_device_info(field_values = {}) ⇒ DeviceInfo

Add a new DeviceInfo to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {}) —

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



277
278
279
 
# File 'lib/fit4ruby/Activity.rb', line 277

def new_device_info(field_values = {})
  new_fit_data_record('device_info', field_values)
end

#new_event(field_values = {}) ⇒ Event

Add a new Event to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {}) —

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



301
302
303
 
# File 'lib/fit4ruby/Activity.rb', line 301

def new_event(field_values = {})
  new_fit_data_record('event', field_values)
end

#new_file_creator(field_values = {}) ⇒ FileCreator

Add a new FileCreator to the Activity. It will replace any previously added FileCreator object.

Parameters:

  • field_values (Hash) (defaults to: {}) —

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



269
270
271
 
# File 'lib/fit4ruby/Activity.rb', line 269

def new_file_creator(field_values = {})
  new_fit_data_record('file_creator', field_values)
end

#new_file_id(field_values = {}) ⇒ FileId

Add a new FileId to the Activity. It will replace any previously added FileId object.

Parameters:

  • field_values (Hash) (defaults to: {}) —

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



260
261
262
 
# File 'lib/fit4ruby/Activity.rb', line 260

def new_file_id(field_values = {})
  new_fit_data_record('file_id', field_values)
end

#new_fit_data_record(record_type, field_values = {}) ⇒ Object

Create a new FitDataRecord.

Parameters:

  • record_type (String) —

    Type that identifies the FitDataRecord derived class to create.

  • field_values (Hash) (defaults to: {}) —

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:

  • FitDataRecord



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/fit4ruby/Activity.rb', line 364

def new_fit_data_record(record_type, field_values = {})
  case record_type
  when 'file_id'
    @file_id = (record = FileId.new(field_values))
  when 'file_creator'
    @file_creator = (record = FileCreator.new(field_values))
  when 'device_info'
    @device_infos << (record = DeviceInfo.new(field_values))
  when 'data_sources'
    @data_sources << (record = DataSources.new(field_values))
  when 'user_profile'
    @user_profiles << (record = UserProfile.new(field_values))
  when 'event'
    @events << (record = Event.new(field_values))
  when 'session'
    unless @cur_lap_records.empty?
      # Copy selected fields from section to lap.
      lap_field_values = {}
      [ :timestamp, :sport ].each do |f|
        lap_field_values[f] = field_values[f] if field_values.include?(f)
      end
      # Ensure that all previous records have been assigned to a lap.
      record = create_new_lap(lap_field_values)
    end
    @num_sessions += 1
    @sessions << (record = Session.new(@cur_session_laps, @lap_counter,
                                       field_values))
    @cur_session_laps = []
  when 'lap'
    record = create_new_lap(field_values)
  when 'record'
    @cur_lap_records << (record = Record.new(field_values))
    @records << record
  when 'hrv'
    @hrv << (record = HRV.new(field_values))
  when 'personal_records'
    @personal_records << (record = PersonalRecords.new(field_values))
  else
    record = nil
  end

  record
end

#new_lap(field_values = {}) ⇒ Lap

Add a new Lap to the Activity. All previoulsy added Record objects are associated with this Lap unless they have been associated with another Lap before.

Parameters:

  • field_values (Hash) (defaults to: {}) —

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



324
325
326
 
# File 'lib/fit4ruby/Activity.rb', line 324

def new_lap(field_values = {})
  new_fit_data_record('lap', field_values)
end

#new_personal_record(field_values = {}) ⇒ PersonalRecord

Add a new PersonalRecord to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {}) —

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:

  • (PersonalRecord) 


332
333
334
 
# File 'lib/fit4ruby/Activity.rb', line 332

def new_personal_record(field_values = {})
  new_fit_data_record('personal_record', field_values)
end

#new_record(field_values = {}) ⇒ Record

Add a new Record to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {}) —

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



340
341
342
 
# File 'lib/fit4ruby/Activity.rb', line 340

def new_record(field_values = {})
  new_fit_data_record('record', field_values)
end

#new_session(field_values = {}) ⇒ Session

Add a new Session to the Activity. All previously added Lap objects are associated with this Session unless they have been associated with another Session before. If there are any Record objects that have not yet been associated with a Lap, a new lap will be created and the Record objects will be associated with this Lap. The Lap will be associated with the newly created Session.

Parameters:

  • field_values (Hash) (defaults to: {}) —

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



314
315
316
 
# File 'lib/fit4ruby/Activity.rb', line 314

def new_session(field_values = {})
  new_fit_data_record('session', field_values)
end

#new_user_profile(field_values = {}) ⇒ UserProfile

Add a new UserProfile to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {}) —

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



293
294
295
 
# File 'lib/fit4ruby/Activity.rb', line 293

def (field_values = {})
  new_fit_data_record('user_profile', field_values)
end

#recovery_hr ⇒ Object

Return the measured recovery heart rate.



186
187
188
189
190
191
192
 
# File 'lib/fit4ruby/Activity.rb', line 186

def recovery_hr
  @events.each do |e|
    return e.recovery_hr if e.event == 'recovery_hr'
  end

  nil
end

#recovery_info ⇒ Object

Returns the remaining recovery time at the start of the activity.

Returns:

  • remaining recovery time in seconds.



196
197
198
199
200
201
202
 
# File 'lib/fit4ruby/Activity.rb', line 196

def recovery_info
  @events.each do |e|
    return e.recovery_info if e.event == 'recovery_info'
  end

  nil
end

#recovery_time ⇒ Object

Returns the predicted recovery time needed after this activity.

Returns:

  • recovery time in seconds.



206
207
208
209
210
211
212
 
# File 'lib/fit4ruby/Activity.rb', line 206

def recovery_time
  @events.each do |e|
    return e.recovery_time if e.event == 'recovery_time'
  end

  nil
end

#sport ⇒ Object

Returns the sport type of this activity.



231
232
233
 
# File 'lib/fit4ruby/Activity.rb', line 231

def sport
  @sessions[0].sport
end

#sub_sport ⇒ Object

Returns the sport subtype of this activity.



236
237
238
 
# File 'lib/fit4ruby/Activity.rb', line 236

def sub_sport
  @sessions[0].sub_sport
end

#total_distance ⇒ Object

Convenience method that aggregates all the distances from the included sessions.



111
112
113
114
115
 
# File 'lib/fit4ruby/Activity.rb', line 111

def total_distance
  d = 0.0
  @sessions.each { |s| d += s.total_distance }
  d
end

#total_gps_distance ⇒ Object

Total distance convered by this activity purely computed by the GPS coordinates. This may differ from the distance computed by the device as it can be based on a purely calibrated footpod.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/fit4ruby/Activity.rb', line 120

def total_gps_distance
  timer_stops = []
  # Generate a list of all timestamps where the timer was stopped.
  @events.each do |e|
    if e.event == 'timer' && e.event_type == 'stop_all'
      timer_stops << e.timestamp
    end
  end

  # The first record of a FIT file can already have a distance associated
  # with it. The GPS location of the first record is not where the start
  # button was pressed. This introduces a slight inaccurcy when computing
  # the total distance purely on the GPS coordinates found in the records.
  d = 0.0
  last_lat = last_long = nil
  last_timestamp = nil

  # Iterate over all the records and accumlate the distances between the
  # neiboring coordinates.
  @records.each do |r|
    if (lat = r.position_lat) && (long = r.position_long)
      if last_lat && last_long
        distance = Fit4Ruby::GeoMath.distance(last_lat, last_long,
                                              lat, long)
        d += distance
      end
      if last_timestamp
        speed = distance / (r.timestamp - last_timestamp)
      end
      if timer_stops[0] == r.timestamp
        # If a stop event was found for this record timestamp we clear the
        # last_* values so that the distance covered while being stopped
        # is not added to the total.
        last_lat = last_long = nil
        last_timestamp = nil
        timer_stops.shift
      else
        last_lat = lat
        last_long = long
        last_timestamp = r.timestamp
      end
    end
  end
  d
end

#vo2max ⇒ Object

Returns the computed VO2max value. This value is computed by the device based on multiple previous activities.



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/fit4ruby/Activity.rb', line 216

def vo2max
  # First check the event log for a vo2max reporting event.
  @events.each do |e|
    return e.vo2max if e.event == 'vo2max'
  end
  # Then check the user_profile entries for a metmax entry. METmax * 3.5
  # is same value as VO2max.
  @user_profiles.each do |u|
    return u.metmax * 3.5 if u.metmax
  end

  nil
end

#write(io, id_mapper) ⇒ Object

Write the Activity data to a file.

Parameters:

  • io (IO) —

    File reference

  • id_mapper (FitMessageIdMapper) —

    Maps global FIT record types to local ones.



244
245
246
247
248
249
250
251
252
253
 
# File 'lib/fit4ruby/Activity.rb', line 244

def write(io, id_mapper)
  @file_id.write(io, id_mapper)
  @file_creator.write(io, id_mapper)

  (@device_infos + @data_sources + @user_profiles + @events +
   @sessions + @laps + @records + @personal_records).sort.each do |s|
    s.write(io, id_mapper)
  end
  super
end