Skip to content

/AWS1/CL_LOCCALCULATEROUTESUMM

A summary of the calculated route.

CONSTRUCTOR

IMPORTING

Required arguments:

it_routebbox TYPE /AWS1/CL_LOCBOUNDINGBOX_W=>TT_BOUNDINGBOX TT_BOUNDINGBOX

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.

iv_datasource TYPE /AWS1/LOCSTRING /AWS1/LOCSTRING

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.

iv_distance TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

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.

iv_durationseconds TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

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

iv_distanceunit TYPE /AWS1/LOCDISTANCEUNIT /AWS1/LOCDISTANCEUNIT

The unit of measurement for route distances.

Queryable Attributes

RouteBBox

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.

Accessible with the following methods

Method Description
GET_ROUTEBBOX() Getter for ROUTEBBOX, with configurable default
ASK_ROUTEBBOX() Getter for ROUTEBBOX w/ exceptions if field has no value
HAS_ROUTEBBOX() Determine if ROUTEBBOX has a value

DataSource

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.

Accessible with the following methods

Method Description
GET_DATASOURCE() Getter for DATASOURCE, with configurable default
ASK_DATASOURCE() Getter for DATASOURCE w/ exceptions if field has no value
HAS_DATASOURCE() Determine if DATASOURCE has a value

Distance

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.

Accessible with the following methods

Method Description
GET_DISTANCE() Getter for DISTANCE, with configurable default
ASK_DISTANCE() Getter for DISTANCE w/ exceptions if field has no value
STR_DISTANCE() String format for DISTANCE, with configurable default
HAS_DISTANCE() Determine if DISTANCE has a value

DurationSeconds

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

Accessible with the following methods

Method Description
GET_DURATIONSECONDS() Getter for DURATIONSECONDS, with configurable default
ASK_DURATIONSECONDS() Getter for DURATIONSECONDS w/ exceptions if field has no val
STR_DURATIONSECONDS() String format for DURATIONSECONDS, with configurable default
HAS_DURATIONSECONDS() Determine if DURATIONSECONDS has a value

DistanceUnit

The unit of measurement for route distances.

Accessible with the following methods

Method Description
GET_DISTANCEUNIT() Getter for DISTANCEUNIT, with configurable default
ASK_DISTANCEUNIT() Getter for DISTANCEUNIT w/ exceptions if field has no value
HAS_DISTANCEUNIT() Determine if DISTANCEUNIT has a value