AWSLocationCalculateRouteResponse

Objective-C

@interface AWSLocationCalculateRouteResponse

Swift

class AWSLocationCalculateRouteResponse

Returns the result of the route calculation. Metadata includes legs and route summary.

Required parameters: [Legs, Summary]

  • Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.

    For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

    • The StartPosition is the departure position.

    • The EndPosition is the destination position.

    A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

    • Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.

    • Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSLocationLeg *> *_Nullable legs;

    Swift

    var legs: [AWSLocationLeg]? { get set }

  • Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSLocationCalculateRouteSummary *_Nullable summary;

    Swift

    var summary: AWSLocationCalculateRouteSummary? { get set }