Module Values.CalculateRouteSummarySource

A summary of the calculated route.

Sourcetype nonrec t = {
  1. routeBBox : BoundingBox.t option;
    (*

    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.

    *)
  2. dataSource : String_.t option;
    (*

    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.

    *)
  3. distance : CalculateRouteSummaryDistanceDouble.t option;
    (*

    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.

    *)
  4. durationSeconds : CalculateRouteSummaryDurationSecondsDouble.t option;
    (*

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

    *)
  5. distanceUnit : DistanceUnit.t option;
    (*

    The unit of measurement for route distances.

    *)
}
Sourceval make : ?routeBBox:??? -> ?dataSource:??? -> ?distance:??? -> ?durationSeconds:??? -> ?distanceUnit:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Double of CalculateRouteSummaryDistanceDouble.t | `Enum of string | `List of [> `Double of Double.t ] list | `String of String_.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t