Class: GoogleMapsPlatform::Result

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/google_maps_platform/models/result.rb

Overview

Result Model.

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(elevation: SKIP, resolution: SKIP, location: SKIP, additional_properties: nil) ⇒ Result

Returns a new instance of Result.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/google_maps_platform/models/result.rb', line 48

def initialize(elevation: SKIP, resolution: SKIP, location: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance

  additional_properties = {} if additional_properties.nil?

  @elevation = elevation unless elevation == SKIP
  @resolution = resolution unless resolution == SKIP
  @location = location unless location == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#elevation ⇒ Float

TODO: Write general description for this method

Returns:

  • (Float) 


14
15
16
 
# File 'lib/google_maps_platform/models/result.rb', line 14

def elevation
  @elevation
end

#location ⇒ LatLngLiteral

An object describing a specific location with Latitude and Longitude in decimal degrees.

Returns:



23
24
25
 
# File 'lib/google_maps_platform/models/result.rb', line 23

def location
  @location
end

#resolution ⇒ Float

TODO: Write general description for this method

Returns:

  • (Float) 


18
19
20
 
# File 'lib/google_maps_platform/models/result.rb', line 18

def resolution
  @resolution
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  elevation = hash.key?('elevation') ? hash['elevation'] : SKIP
  resolution = hash.key?('resolution') ? hash['resolution'] : SKIP
  location = LatLngLiteral.from_hash(hash['location']) if hash['location']

  # 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.

  Result.new(elevation: elevation,
             resolution: resolution,
             location: location,
             additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



26
27
28
29
30
31
32
 
# File 'lib/google_maps_platform/models/result.rb', line 26

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

.nullables ⇒ Object

An array for nullable fields



44
45
46
 
# File 'lib/google_maps_platform/models/result.rb', line 44

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



35
36
37
38
39
40
41
 
# File 'lib/google_maps_platform/models/result.rb', line 35

def self.optionals
  %w[
    elevation
    resolution
    location
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



90
91
92
93
94
 
# File 'lib/google_maps_platform/models/result.rb', line 90

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} elevation: #{@elevation.inspect}, resolution: #{@resolution.inspect},"\
  " location: #{@location.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



83
84
85
86
87
 
# File 'lib/google_maps_platform/models/result.rb', line 83

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} elevation: #{@elevation}, resolution: #{@resolution}, location:"\
  " #{@location}, additional_properties: #{@additional_properties}>"
end