Class: Verizon::SpeedItem

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/verizon/models/speed_item.rb

Overview

Defines the acceptable speed range for road users in m/s. Messages are triggered when: 1. The road user’s speed is below the required minimum OR 2. The road user’s speed is above the acceptable maximum AND 3. The associated TriggerConditions are met. Example: For the speed range of 10-20 m/s and a TriggerCondition of ‘user inside geofence’, the message is sent if the user’s speed is below 10 m/s or above 20 m/s while in the geofence area.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(speed = nil) ⇒ SpeedItem

Returns a new instance of SpeedItem.



41
42
43
 
# File 'lib/verizon/models/speed_item.rb', line 41

def initialize(speed = nil)
  @speed = speed
end

Instance Attribute Details

#speed ⇒ Speed

TODO: Write general description for this method

Returns:



20
21
22
 
# File 'lib/verizon/models/speed_item.rb', line 20

def speed
  @speed
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



46
47
48
49
50
51
52
53
54
 
# File 'lib/verizon/models/speed_item.rb', line 46

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  speed = Speed.from_hash(hash['speed']) if hash['speed']

  # Create object from extracted values.
  SpeedItem.new(speed)
end

.names ⇒ Object

A mapping from model property names to API property names.



23
24
25
26
27
 
# File 'lib/verizon/models/speed_item.rb', line 23

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['speed'] = 'speed'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



35
36
37
38
39
 
# File 'lib/verizon/models/speed_item.rb', line 35

def self.nullables
  %w[
    speed
  ]
end

.optionals ⇒ Object

An array for optional fields



30
31
32
 
# File 'lib/verizon/models/speed_item.rb', line 30

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (SpeedItem | Hash) —

    value against the validation is performed.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/verizon/models/speed_item.rb', line 58

def self.validate(value)
  if value.instance_of? self
    return APIHelper.valid_type?(value.speed,
                                 ->(val) { Speed.validate(val) },
                                 is_model_hash: true)
  end

  return false unless value.instance_of? Hash

  APIHelper.valid_type?(value['speed'],
                        ->(val) { Speed.validate(val) },
                        is_model_hash: true)
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



79
80
81
82
 
# File 'lib/verizon/models/speed_item.rb', line 79

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} speed: #{@speed.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



73
74
75
76
 
# File 'lib/verizon/models/speed_item.rb', line 73

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} speed: #{@speed}>"
end