AWSLocationCalculateRouteSummary

Objective-C

@interface AWSLocationCalculateRouteSummary

Swift

class AWSLocationCalculateRouteSummary

A summary of the calculated route.

Required parameters: [RouteBBox, DataSource, Distance, DurationSeconds, DistanceUnit]

  • The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

    • Esri

    • Grab

    • Here

    For more information about data providers, see Amazon Location Service data providers.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable dataSource;

    Swift

    var dataSource: String? { get set }

  • The total distance covered by the route. The sum of the distance travelled between every stop on the route.

    If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a 400 RoutesValidationException error.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable distance;

    Swift

    var distance: NSNumber? { get set }

  • The unit of measurement for route distances.

    Declaration

    Objective-C

    @property (nonatomic) AWSLocationDistanceUnit distanceUnit;

    Swift

    var distanceUnit: AWSLocationDistanceUnit { get set }

  • The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable durationSeconds;

    Swift

    var durationSeconds: NSNumber? { get set }

  • Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y].

    The first 2 bbox parameters describe the lower southwest corner:

    • The first bbox position is the X coordinate or longitude of the lower southwest corner.

    • The second bbox position is the Y coordinate or latitude of the lower southwest corner.

    The next 2 bbox parameters describe the upper northeast corner:

    • The third bbox position is the X coordinate, or longitude of the upper northeast corner.

    • The fourth bbox position is the Y coordinate, or latitude of the upper northeast corner.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSNumber *> *_Nullable routeBBox;

    Swift

    var routeBBox: [NSNumber]? { get set }