Class: Aws::LocationService::Types::CalculateRouteMatrixResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-locationservice/types.rb

Overview

Returns the result of the route matrix calculation.

See Also:

Constant Summary collapse

SENSITIVE = 
[:snapped_departure_positions, :snapped_destination_positions]

Instance Attribute Summary collapse

Instance Attribute Details

#route_matrix ⇒ Array<Array<Types::RouteMatrixEntry>>

The calculated route matrix containing the results for all pairs of ‘DeparturePositions` to `DestinationPositions`. Each row corresponds to one entry in `DeparturePositions`. Each entry in the row corresponds to the route from that entry in `DeparturePositions` to an entry in `DestinationPositions`.

Returns:



838
839
840
841
842
843
844
845
 
# File 'lib/aws-sdk-locationservice/types.rb', line 838

class CalculateRouteMatrixResponse < Struct.new(
  :route_matrix,
  :snapped_departure_positions,
  :snapped_destination_positions,
  :summary)
  SENSITIVE = [:snapped_departure_positions, :snapped_destination_positions]
  include Aws::Structure
end

#snapped_departure_positions ⇒ Array<Array<Float>>

For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the ‘RouteMatrix`.

Returns:

  • (Array<Array<Float>>) 


838
839
840
841
842
843
844
845
 
# File 'lib/aws-sdk-locationservice/types.rb', line 838

class CalculateRouteMatrixResponse < Struct.new(
  :route_matrix,
  :snapped_departure_positions,
  :snapped_destination_positions,
  :summary)
  SENSITIVE = [:snapped_departure_positions, :snapped_destination_positions]
  include Aws::Structure
end

#snapped_destination_positions ⇒ Array<Array<Float>>

The list of destination positions for the route matrix used for calculation of the ‘RouteMatrix`.

Returns:

  • (Array<Array<Float>>) 


838
839
840
841
842
843
844
845
 
# File 'lib/aws-sdk-locationservice/types.rb', line 838

class CalculateRouteMatrixResponse < Struct.new(
  :route_matrix,
  :snapped_departure_positions,
  :snapped_destination_positions,
  :summary)
  SENSITIVE = [:snapped_departure_positions, :snapped_destination_positions]
  include Aws::Structure
end

#summary ⇒ Types::CalculateRouteMatrixSummary

Contains information about the route matrix, ‘DataSource`, `DistanceUnit`, `RouteCount` and `ErrorCount`.

Returns:



838
839
840
841
842
843
844
845
 
# File 'lib/aws-sdk-locationservice/types.rb', line 838

class CalculateRouteMatrixResponse < Struct.new(
  :route_matrix,
  :snapped_departure_positions,
  :snapped_destination_positions,
  :summary)
  SENSITIVE = [:snapped_departure_positions, :snapped_destination_positions]
  include Aws::Structure
end