RouteVehicleSpan (p.awso.0.9.1.doc.awso.geo-routes.Awso_geo

Sourcetype nonrec t = {

bestCaseDuration : DurationSeconds.t option;
(*
Duration of the computed span without traffic congestion. Unit: seconds
*)
carAccess : RouteSpanCarAccessAttributeList.t option;
(*
Access attributes for a car corresponding to the span.
*)
country : CountryCode3.t option;
(*
3 letter Country code corresponding to the Span.
*)
distance : DistanceMeters.t option;
(*
Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.
*)
duration : DurationSeconds.t option;
(*
Duration of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties. Unit: seconds
*)
dynamicSpeed : RouteSpanDynamicSpeedDetails.t option;
(*
Dynamic speed details corresponding to the span. Unit: kilometers per hour
*)
functionalClassification : RouteVehicleSpanFunctionalClassificationInteger.t option;
(*
A numerical value indicating the functional classification of the road segment corresponding to the span. Classification values are part of the hierarchical network that helps determine a logical and efficient route, and have the following definitions: Roads that allow for high volume, maximum speed traffic movement between and through major metropolitan areas. Roads that are used to channel traffic to functional class 1 roads for travel between and through cities in the shortest amount of time. Roads that intersect functional class 2 roads and provide a high volume of traffic movement at a lower level of mobility than functional class 2 roads. Roads that provide for a high volume of traffic movement at moderate speeds between neighborhoods. Roads with volume and traffic movement below the level of any other functional class.
*)
gate : RouteSpanGateAttribute.t option;
(*
Attributes corresponding to a gate. The gate is present at the end of the returned span.
*)
geometryOffset : RouteVehicleSpanGeometryOffsetInteger.t option;
(*
Offset in the leg geometry corresponding to the start of this span.
*)
incidents : IndexList.t option;
(*
Incidents corresponding to the span. These index into the Incidents in the parent Leg.
*)
names : LocalizedStringList.t option;
(*
Provides an array of names of the vehicle span in available languages.
*)
notices : IndexList.t option;
(*
Notices are additional information returned that indicate issues that occurred during route calculation.
*)
railwayCrossing : RouteSpanRailwayCrossingAttribute.t option;
(*
Attributes corresponding to a railway crossing. The gate is present at the end of the returned span.
*)
region : RouteVehicleSpanRegionString.t option;
(*
2-3 letter Region code corresponding to the Span. This is either a province or a state.
*)
roadAttributes : RouteSpanRoadAttributeList.t option;
(*
Attributes for the road segment corresponding to the span.
*)
routeNumbers : RouteNumberList.t option;
(*
Designated route name or number corresponding to the span.
*)
scooterAccess : RouteSpanScooterAccessAttributeList.t option;
(*
Access attributes for a scooter corresponding to the span.
*)
speedLimit : RouteSpanSpeedLimitDetails.t option;
(*
Speed limit details corresponding to the span. Unit: kilometers per hour
*)
tollSystems : IndexList.t option;
(*
Toll systems are authorities that collect payments for the toll.
*)
truckAccess : RouteSpanTruckAccessAttributeList.t option;
(*
Access attributes for a truck corresponding to the span.
*)
truckRoadTypes : IndexList.t option;
(*
Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico. There are currently no other supported values as of 26th April 2024.
*)
typicalDuration : DurationSeconds.t option;
(*
Duration of the computed span under typical traffic congestion. Unit: seconds
*)
zones : IndexList.t option;
(*
Zones corresponding to this leg of the route.
*)

}

val make : 
  ?bestCaseDuration:??? ->
  ?carAccess:??? ->
  ?country:??? ->
  ?distance:??? ->
  ?duration:??? ->
  ?dynamicSpeed:??? ->
  ?functionalClassification:??? ->
  ?gate:??? ->
  ?geometryOffset:??? ->
  ?incidents:??? ->
  ?names:??? ->
  ?notices:??? ->
  ?railwayCrossing:??? ->
  ?region:??? ->
  ?roadAttributes:??? ->
  ?routeNumbers:??? ->
  ?scooterAccess:??? ->
  ?speedLimit:??? ->
  ?tollSystems:??? ->
  ?truckAccess:??? ->
  ?truckRoadTypes:??? ->
  ?typicalDuration:??? ->
  ?zones:??? ->
  unit ->
  t

Source

val to_value : 
  t ->
  [> `Structure of
       (string
        * [> `Enum of string
          | `Integer of RouteVehicleSpanFunctionalClassificationInteger.t
          | `List of
            [> `Enum of string
            | `Integer of Integer.t
            | `Structure of
              (string * [> `Enum of string | `String of LanguageTag.t ]) list ]
              list
          | `Long of DurationSeconds.t
          | `String of CountryCode3.t
          | `Structure of
            (string
             * [> `Boolean of SensitiveBoolean.t
               | `Double of SpeedKilometersPerHour.t
               | `Long of DurationSeconds.t ])
              list ])
         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