Package com.azure.maps.traffic.models

Class TrafficFlowSegmentData

java.lang.Object
com.azure.maps.traffic.models.TrafficFlowSegmentData
public final class TrafficFlowSegmentData extends Object
This object is returned from a successful Traffic Flow Segment call.

  • Method Details

    • getFunctionalRoadClass

      public String getFunctionalRoadClass()
      Get the functionalRoadClass property: Functional Road Class. This indicates the road type: 0: Motorway, freeway or other major road. 1: Major road, less important than a motorway. 2: Other major road. 3: Secondary road. 4: Local connecting road. 5: Local road of high importance. 6: Local road.
      Returns:
      the functionalRoadClass value.

    • getCurrentSpeed

      public Integer getCurrentSpeed()
      Get the currentSpeed property: The current average speed at the selected point, in the units requested. This is calculated from the currentTravelTime and the length of the selected segment.
      Returns:
      the currentSpeed value.

    • getFreeFlowSpeed

      public Integer getFreeFlowSpeed()
      Get the freeFlowSpeed property: The free flow speed expected under ideal conditions, expressed in the units requested. This is related to the freeFlowTravelTime.
      Returns:
      the freeFlowSpeed value.

    • getCurrentTravelTime

      public Integer getCurrentTravelTime()
      Get the currentTravelTime property: Current travel time in seconds, across this traffic segment, based on fused real-time measurements between the defined locations in the specified direction.
      Returns:
      the currentTravelTime value.

    • getFreeFlowTravelTime

      public Integer getFreeFlowTravelTime()
      Get the freeFlowTravelTime property: The travel time in seconds, across this traffic segment, which would be expected under ideal free flow conditions.
      Returns:
      the freeFlowTravelTime value.

    • getConfidence

      public Float getConfidence()
      Get the confidence property: The confidence is a measure of the quality of the provided travel time and speed. A value of 1 means full confidence, that the response contains the highest quality data. Lower values indicate the degree that the response may vary from the actual conditions on the road. Any value greater than 0.6 means the information was based on real-time probe input. A value of 0.5 means the reported speed is based on historical info. A value between 0.5 and 0.6 has a calculated weighted average between historical and live speeds.
      Returns:
      the confidence value.

    • getCoordinates

      public TrafficFlowSegmentDataPropertiesCoordinates getCoordinates()
      Get the coordinates property: Includes the coordinates describing the shape of the segment. Coordinates are shifted from the road depending on the zoom level to support high quality visualization in every scale.
      Returns:
      the coordinates value.

    • getVersion

      public String getVersion()
      Get the version property: This indicates the software version that generated the response.
      Returns:
      the version value.

    • getOpenLrCode

      public String getOpenLrCode()
      Get the openLrCode property: OpenLR code for segment. See [OpenLR](https://en.wikipedia.org/wiki/OpenLR) for more information on the use of Open LR codes.
      Returns:
      the openLrCode value.