Class: Verizon::PositionData

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

Overview

Position data.

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(time: SKIP, utcoffset: SKIP, x: SKIP, y: SKIP, radius: SKIP, qos: SKIP, additional_properties: nil) ⇒ PositionData

Returns a new instance of PositionData.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/verizon/models/position_data.rb', line 65

def initialize(time: SKIP, utcoffset: SKIP, x: SKIP, y: SKIP, radius: SKIP,
               qos: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @time = time unless time == SKIP
  @utcoffset = utcoffset unless utcoffset == SKIP
  @x = x unless x == SKIP
  @y = y unless y == SKIP
  @radius = radius unless radius == SKIP
  @qos = qos unless qos == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#qos ⇒ TrueClass | FalseClass

Whether requested accurary is met or not.

Returns:

  • (TrueClass | FalseClass) 


34
35
36
 
# File 'lib/verizon/models/position_data.rb', line 34

def qos
  @qos
end

#radius ⇒ String

Radius of the location in meters.

Returns:

  • (String) 


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

def radius
  @radius
end

#time ⇒ String

Time location obtained.

Returns:

  • (String) 


14
15
16
 
# File 'lib/verizon/models/position_data.rb', line 14

def time
  @time
end

#utcoffset ⇒ String

UTC offset of time.

Returns:

  • (String) 


18
19
20
 
# File 'lib/verizon/models/position_data.rb', line 18

def utcoffset
  @utcoffset
end

#x ⇒ String

X coordinate of location.

Returns:

  • (String) 


22
23
24
 
# File 'lib/verizon/models/position_data.rb', line 22

def x
  @x
end

#y ⇒ String

Y coordinate of location.

Returns:

  • (String) 


26
27
28
 
# File 'lib/verizon/models/position_data.rb', line 26

def y
  @y
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
 
# File 'lib/verizon/models/position_data.rb', line 80

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  time = hash.key?('time') ? hash['time'] : SKIP
  utcoffset = hash.key?('utcoffset') ? hash['utcoffset'] : SKIP
  x = hash.key?('x') ? hash['x'] : SKIP
  y = hash.key?('y') ? hash['y'] : SKIP
  radius = hash.key?('radius') ? hash['radius'] : SKIP
  qos = hash.key?('qos') ? hash['qos'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  PositionData.new(time: time,
                   utcoffset: utcoffset,
                   x: x,
                   y: y,
                   radius: radius,
                   qos: qos,
                   additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/verizon/models/position_data.rb', line 37

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['time'] = 'time'
  @_hash['utcoffset'] = 'utcoffset'
  @_hash['x'] = 'x'
  @_hash['y'] = 'y'
  @_hash['radius'] = 'radius'
  @_hash['qos'] = 'qos'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



61
62
63
 
# File 'lib/verizon/models/position_data.rb', line 61

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/verizon/models/position_data.rb', line 49

def self.optionals
  %w[
    time
    utcoffset
    x
    y
    radius
    qos
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



116
117
118
119
120
121
 
# File 'lib/verizon/models/position_data.rb', line 116

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} time: #{@time.inspect}, utcoffset: #{@utcoffset.inspect}, x: #{@x.inspect},"\
  " y: #{@y.inspect}, radius: #{@radius.inspect}, qos: #{@qos.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



109
110
111
112
113
 
# File 'lib/verizon/models/position_data.rb', line 109

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} time: #{@time}, utcoffset: #{@utcoffset}, x: #{@x}, y: #{@y}, radius:"\
  " #{@radius}, qos: #{@qos}, additional_properties: #{@additional_properties}>"
end