Class: Pinnacle::LatLng

Inherits:
Object
  • Object
show all
Defined in:
lib/rcs/types/lat_lng.rb

Overview

The latitude and longitude of the location to share with the user

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(lat:, lng:, additional_properties: nil) ⇒ Pinnacle::LatLng

Parameters:

  • lat (Float) —

    The latitude of the location

  • lng (Float) —

    The longitude of the location

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



25
26
27
28
29
30
 
# File 'lib/rcs/types/lat_lng.rb', line 25

def initialize(lat:, lng:, additional_properties: nil)
  @lat = lat
  @lng = lng
  @additional_properties = additional_properties
  @_field_set = { "lat": lat, "lng": lng }
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



14
15
16
 
# File 'lib/rcs/types/lat_lng.rb', line 14

def additional_properties
  @additional_properties
end

#lat ⇒ Float (readonly)

Returns The latitude of the location.

Returns:

  • (Float) —

    The latitude of the location



10
11
12
 
# File 'lib/rcs/types/lat_lng.rb', line 10

def lat
  @lat
end

#lng ⇒ Float (readonly)

Returns The longitude of the location.

Returns:

  • (Float) —

    The longitude of the location



12
13
14
 
# File 'lib/rcs/types/lat_lng.rb', line 12

def lng
  @lng
end

Class Method Details

.from_json(json_object:) ⇒ Pinnacle::LatLng

Deserialize a JSON object to an instance of LatLng

Parameters:

  • json_object (String)

Returns:



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/rcs/types/lat_lng.rb', line 36

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  lat = parsed_json["lat"]
  lng = parsed_json["lng"]
  new(
    lat: lat,
    lng: lng,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


61
62
63
64
 
# File 'lib/rcs/types/lat_lng.rb', line 61

def self.validate_raw(obj:)
  obj.lat.is_a?(Float) != false || raise("Passed value for field obj.lat is not the expected type, validation failed.")
  obj.lng.is_a?(Float) != false || raise("Passed value for field obj.lng is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of LatLng to a JSON object

Returns:

  • (String) 


51
52
53
 
# File 'lib/rcs/types/lat_lng.rb', line 51

def to_json(*_args)
  @_field_set&.to_json
end