Class: PolarAccesslinkApiGem::Exercise

Inherits:
Object
  • Object
show all
Defined in:
lib/polar-accesslink-api-gem/models/exercise.rb

Overview

Training session summary data

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Exercise

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 138

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PolarAccesslinkApiGem::Exercise` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PolarAccesslinkApiGem::Exercise`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'upload_time')
    self.upload_time = attributes[:'upload_time']
  end

  if attributes.key?(:'polar_user')
    self.polar_user = attributes[:'polar_user']
  end

  if attributes.key?(:'transaction_id')
    self.transaction_id = attributes[:'transaction_id']
  end

  if attributes.key?(:'device')
    self.device = attributes[:'device']
  end

  if attributes.key?(:'start_time')
    self.start_time = attributes[:'start_time']
  end

  if attributes.key?(:'duration')
    self.duration = attributes[:'duration']
  end

  if attributes.key?(:'calories')
    self.calories = attributes[:'calories']
  end

  if attributes.key?(:'distance')
    self.distance = attributes[:'distance']
  end

  if attributes.key?(:'heart_rate')
    self.heart_rate = attributes[:'heart_rate']
  end

  if attributes.key?(:'training_load')
    self.training_load = attributes[:'training_load']
  end

  if attributes.key?(:'sport')
    self.sport = attributes[:'sport']
  end

  if attributes.key?(:'has_route')
    self.has_route = attributes[:'has_route']
  end

  if attributes.key?(:'club_id')
    self.club_id = attributes[:'club_id']
  end

  if attributes.key?(:'club_name')
    self.club_name = attributes[:'club_name']
  end

  if attributes.key?(:'detailed_sport_info')
    self.detailed_sport_info = attributes[:'detailed_sport_info']
  end

  if attributes.key?(:'fat_percentage')
    self.fat_percentage = attributes[:'fat_percentage']
  end

  if attributes.key?(:'carbohydrate_percentage')
    self.carbohydrate_percentage = attributes[:'carbohydrate_percentage']
  end

  if attributes.key?(:'protein_percentage')
    self.protein_percentage = attributes[:'protein_percentage']
  end
end

Instance Attribute Details

#calories ⇒ Object

Expended calories during training in kilocalories



41
42
43
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 41

def calories
  @calories
end

#carbohydrate_percentage ⇒ Object

Carbohydrate percentage of exercise calories. Has value if the exercise is from training device supporting Energy sources, otherwise not printed.



70
71
72
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 70

def carbohydrate_percentage
  @carbohydrate_percentage
end

#club_id ⇒ Object

Has value if the exercise is from "Flow For Club", otherwise not printed. Value -1 indicates that there were errors finding the club



58
59
60
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 58

def club_id
  @club_id
end

#club_name ⇒ Object

Has value if the exercise is from "Flow For Club", otherwise not printed. Value "Ambiguous club location. Please contact support." is printed in case of error (and the club-id is -1).



61
62
63
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 61

def club_name
  @club_name
end

#detailed_sport_info ⇒ Object

String containing the name of a Polar Flow-compatible sport, if one is set for the exercise.



64
65
66
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 64

def detailed_sport_info
  @detailed_sport_info
end

#device ⇒ Object

Polar product used in training



32
33
34
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 32

def device
  @device
end

#distance ⇒ Object

Distance in meters travelled during training



44
45
46
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 44

def distance
  @distance
end

#duration ⇒ Object

The duration of the training session as specified in ISO8601



38
39
40
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 38

def duration
  @duration
end

#fat_percentage ⇒ Object

Fat percentage of exercise calories. Has value if the exercise is from training device supporting Energy sources, otherwise not printed.



67
68
69
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 67

def fat_percentage
  @fat_percentage
end

#has_route ⇒ Object

Boolean indicating if the exercise has route data



55
56
57
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 55

def has_route
  @has_route
end

#heart_rate ⇒ Object

Returns the value of attribute heart_rate.



46
47
48
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 46

def heart_rate
  @heart_rate
end

#id ⇒ Object

Id of the trainining session



20
21
22
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 20

def id
  @id
end

#polar_user ⇒ Object

Absolute link to Polar user owning the training



26
27
28
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 26

def polar_user
  @polar_user
end

#protein_percentage ⇒ Object

Protein percentage of exercise calories. Has value if the exercise is from training device supporting Energy sources, otherwise not printed.



73
74
75
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 73

def protein_percentage
  @protein_percentage
end

#sport ⇒ Object

Sport name



52
53
54
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 52

def sport
  @sport
end

#start_time ⇒ Object

Start time of the training session in local time



35
36
37
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 35

def start_time
  @start_time
end

#training_load ⇒ Object

Training load effect to user



49
50
51
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 49

def training_load
  @training_load
end

#transaction_id ⇒ Object

Id of the exercise-transaction this training was transferred in



29
30
31
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 29

def transaction_id
  @transaction_id
end

#upload_time ⇒ Object

Time of the transfer from wrist unit to Polar database



23
24
25
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 23

def upload_time
  @upload_time
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



101
102
103
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 101

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 76

def self.attribute_map
  {
    :'id' => :'id',
    :'upload_time' => :'upload-time',
    :'polar_user' => :'polar-user',
    :'transaction_id' => :'transaction-id',
    :'device' => :'device',
    :'start_time' => :'start-time',
    :'duration' => :'duration',
    :'calories' => :'calories',
    :'distance' => :'distance',
    :'heart_rate' => :'heart-rate',
    :'training_load' => :'training-load',
    :'sport' => :'sport',
    :'has_route' => :'has-route',
    :'club_id' => :'club-id',
    :'club_name' => :'club-name',
    :'detailed_sport_info' => :'detailed-sport-info',
    :'fat_percentage' => :'fat-percentage',
    :'carbohydrate_percentage' => :'carbohydrate-percentage',
    :'protein_percentage' => :'protein-percentage'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



282
283
284
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 282

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



131
132
133
134
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 131

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 106

def self.openapi_types
  {
    :'id' => :'Integer',
    :'upload_time' => :'String',
    :'polar_user' => :'String',
    :'transaction_id' => :'Integer',
    :'device' => :'String',
    :'start_time' => :'String',
    :'duration' => :'String',
    :'calories' => :'Integer',
    :'distance' => :'Float',
    :'heart_rate' => :'HeartRate',
    :'training_load' => :'Float',
    :'sport' => :'String',
    :'has_route' => :'Boolean',
    :'club_id' => :'Integer',
    :'club_name' => :'String',
    :'detailed_sport_info' => :'String',
    :'fat_percentage' => :'Integer',
    :'carbohydrate_percentage' => :'Integer',
    :'protein_percentage' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 243

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      upload_time == o.upload_time &&
      polar_user == o.polar_user &&
      transaction_id == o.transaction_id &&
      device == o.device &&
      start_time == o.start_time &&
      duration == o.duration &&
      calories == o.calories &&
      distance == o.distance &&
      heart_rate == o.heart_rate &&
      training_load == o.training_load &&
      sport == o.sport &&
      has_route == o.has_route &&
      club_id == o.club_id &&
      club_name == o.club_name &&
      detailed_sport_info == o.detailed_sport_info &&
      fat_percentage == o.fat_percentage &&
      carbohydrate_percentage == o.carbohydrate_percentage &&
      protein_percentage == o.protein_percentage
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 312

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = PolarAccesslinkApiGem.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 383

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 289

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


269
270
271
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



275
276
277
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 275

def hash
  [id, upload_time, polar_user, transaction_id, device, start_time, duration, calories, distance, heart_rate, training_load, sport, has_route, club_id, club_name, detailed_sport_info, fat_percentage, carbohydrate_percentage, protein_percentage].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



230
231
232
233
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 230

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



359
360
361
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 359

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 365

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



353
354
355
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 353

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



237
238
239
 
# File 'lib/polar-accesslink-api-gem/models/exercise.rb', line 237

def valid?
  true
end