Class: GoogleMapsPlatform::GeocodingGeometry

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

Overview

An object describing the location.

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(location:, location_type:, viewport:, bounds: SKIP, additional_properties: nil) ⇒ GeocodingGeometry

Returns a new instance of GeocodingGeometry.



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/google_maps_platform/models/geocoding_geometry.rb', line 65

def initialize(location:, location_type:, viewport:, bounds: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @location = location
  @location_type = location_type
  @bounds = bounds unless bounds == SKIP
  @viewport = viewport
  @additional_properties = additional_properties
end

Instance Attribute Details

#bounds ⇒ Bounds

A rectangle in geographical coordinates from points at the southwest and northeast corners.

Returns:



36
37
38
 
# File 'lib/google_maps_platform/models/geocoding_geometry.rb', line 36

def bounds
  @bounds
end

#location ⇒ LatLngLiteral

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

Returns:



15
16
17
 
# File 'lib/google_maps_platform/models/geocoding_geometry.rb', line 15

def location
  @location
end

#location_type ⇒ LocationType

Stores additional data about the specified location. The following values are currently supported:

  • “ROOFTOP” indicates that the returned result is a precise geocode for

which we have location information accurate down to street address precision.

  • “RANGE_INTERPOLATED” indicates that the returned result reflects an

approximation (usually on a road) interpolated between two precise points (such as intersections). Interpolated results are generally returned when rooftop geocodes are unavailable for a street address.

  • “GEOMETRIC_CENTER” indicates that the returned result is the geometric

center of a result such as a polyline (for example, a street) or polygon (region).

  • “APPROXIMATE” indicates that the returned result is approximate.

Returns:



31
32
33
 
# File 'lib/google_maps_platform/models/geocoding_geometry.rb', line 31

def location_type
  @location_type
end

#viewport ⇒ Bounds

A rectangle in geographical coordinates from points at the southwest and northeast corners.

Returns:



41
42
43
 
# File 'lib/google_maps_platform/models/geocoding_geometry.rb', line 41

def viewport
  @viewport
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google_maps_platform/models/geocoding_geometry.rb', line 78

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  location = LatLngLiteral.from_hash(hash['location']) if hash['location']
  location_type = hash.key?('location_type') ? hash['location_type'] : nil
  viewport = Bounds.from_hash(hash['viewport']) if hash['viewport']
  bounds = Bounds.from_hash(hash['bounds']) if hash['bounds']

  # 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.
  GeocodingGeometry.new(location: location,
                        location_type: location_type,
                        viewport: viewport,
                        bounds: bounds,
                        additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



44
45
46
47
48
49
50
51
 
# File 'lib/google_maps_platform/models/geocoding_geometry.rb', line 44

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['location'] = 'location'
  @_hash['location_type'] = 'location_type'
  @_hash['bounds'] = 'bounds'
  @_hash['viewport'] = 'viewport'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



61
62
63
 
# File 'lib/google_maps_platform/models/geocoding_geometry.rb', line 61

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



54
55
56
57
58
 
# File 'lib/google_maps_platform/models/geocoding_geometry.rb', line 54

def self.optionals
  %w[
    bounds
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



110
111
112
113
114
115
 
# File 'lib/google_maps_platform/models/geocoding_geometry.rb', line 110

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



103
104
105
106
107
 
# File 'lib/google_maps_platform/models/geocoding_geometry.rb', line 103

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