Package 

Class AlongRouteTrafficFlowSegment

  • All Implemented Interfaces:
    android.os.Parcelable

    
    public final class AlongRouteTrafficFlowSegment
     implements Parcelable
                        

    Data model representing along route traffic flow segment.

    Instances are typically immutable after construction. Use builders or factory methods where provided.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Constructor Summary

      Constructors 
      Constructor Description
      AlongRouteTrafficFlowSegment(Integer startLegIndex, Integer startStepIndex, Integer startEdgeIndex, Float startEdgeOffset, Integer endLegIndex, Integer endStepIndex, Integer endEdgeIndex, Float endEdgeOffset, Float distanceFromRouteStart, Float flowLength, Float flowSpeed, Integer congestionLevel, TrafficDataAdditionalInfo additionalInfo)
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final Integer getStartLegIndex() zero based of start leg index of this part of traffic flow belongs to
      final Unit setStartLegIndex(Integer startLegIndex) zero based of start leg index of this part of traffic flow belongs to
      final Integer getStartStepIndex() zero based of start step index of this part of traffic flow belongs to
      final Unit setStartStepIndex(Integer startStepIndex) zero based of start step index of this part of traffic flow belongs to
      final Integer getStartEdgeIndex() zero based of start edge index of this part of traffic flow belongs to
      final Unit setStartEdgeIndex(Integer startEdgeIndex) zero based of start edge index of this part of traffic flow belongs to
      final Float getStartEdgeOffset() offset of the start edge from the start of the edge, in meters.
      final Unit setStartEdgeOffset(Float startEdgeOffset) offset of the start edge from the start of the edge, in meters.
      final Integer getEndLegIndex() zero based of end leg index of this part of traffic flow belongs to
      final Unit setEndLegIndex(Integer endLegIndex) zero based of end leg index of this part of traffic flow belongs to
      final Integer getEndStepIndex() zero based of end step index of this part of traffic flow belongs to
      final Unit setEndStepIndex(Integer endStepIndex) zero based of end step index of this part of traffic flow belongs to
      final Integer getEndEdgeIndex() zero based of end edge index of this part of traffic flow belongs to
      final Unit setEndEdgeIndex(Integer endEdgeIndex) zero based of end edge index of this part of traffic flow belongs to
      final Float getEndEdgeOffset() offset of the end edge from the start of the edge, in meters.
      final Unit setEndEdgeOffset(Float endEdgeOffset) offset of the end edge from the start of the edge, in meters.
      final Float getDistanceFromRouteStart() distance from the start of corresponding route where this flow started, in meters
      final Unit setDistanceFromRouteStart(Float distanceFromRouteStart) distance from the start of corresponding route where this flow started, in meters
      final Float getFlowLength() length of the flow segment, in meters
      final Unit setFlowLength(Float flowLength) length of the flow segment, in meters
      final Float getFlowSpeed() average speed of the flow segment, in meters per second.
      final Unit setFlowSpeed(Float flowSpeed) average speed of the flow segment, in meters per second.
      final Integer getCongestionLevel() congestion level of this part of flow, see TrafficLevel definition
      final Unit setCongestionLevel(Integer congestionLevel) congestion level of this part of flow, see TrafficLevel definition
      final TrafficDataAdditionalInfo getAdditionalInfo() additional information for the flow.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AlongRouteTrafficFlowSegment

        AlongRouteTrafficFlowSegment(Integer startLegIndex, Integer startStepIndex, Integer startEdgeIndex, Float startEdgeOffset, Integer endLegIndex, Integer endStepIndex, Integer endEdgeIndex, Float endEdgeOffset, Float distanceFromRouteStart, Float flowLength, Float flowSpeed, Integer congestionLevel, TrafficDataAdditionalInfo additionalInfo)
    • Method Detail

      • getStartLegIndex

         final Integer getStartLegIndex()

        zero based of start leg index of this part of traffic flow belongs to

      • setStartLegIndex

         final Unit setStartLegIndex(Integer startLegIndex)

        zero based of start leg index of this part of traffic flow belongs to

      • getStartStepIndex

         final Integer getStartStepIndex()

        zero based of start step index of this part of traffic flow belongs to

      • setStartStepIndex

         final Unit setStartStepIndex(Integer startStepIndex)

        zero based of start step index of this part of traffic flow belongs to

      • getStartEdgeIndex

         final Integer getStartEdgeIndex()

        zero based of start edge index of this part of traffic flow belongs to

      • setStartEdgeIndex

         final Unit setStartEdgeIndex(Integer startEdgeIndex)

        zero based of start edge index of this part of traffic flow belongs to

      • getStartEdgeOffset

         final Float getStartEdgeOffset()

        offset of the start edge from the start of the edge, in meters. Negative value stands for invalid offset.

      • setStartEdgeOffset

         final Unit setStartEdgeOffset(Float startEdgeOffset)

        offset of the start edge from the start of the edge, in meters. Negative value stands for invalid offset.

      • getEndLegIndex

         final Integer getEndLegIndex()

        zero based of end leg index of this part of traffic flow belongs to

      • setEndLegIndex

         final Unit setEndLegIndex(Integer endLegIndex)

        zero based of end leg index of this part of traffic flow belongs to

      • getEndStepIndex

         final Integer getEndStepIndex()

        zero based of end step index of this part of traffic flow belongs to

      • setEndStepIndex

         final Unit setEndStepIndex(Integer endStepIndex)

        zero based of end step index of this part of traffic flow belongs to

      • getEndEdgeIndex

         final Integer getEndEdgeIndex()

        zero based of end edge index of this part of traffic flow belongs to

      • setEndEdgeIndex

         final Unit setEndEdgeIndex(Integer endEdgeIndex)

        zero based of end edge index of this part of traffic flow belongs to

      • getEndEdgeOffset

         final Float getEndEdgeOffset()

        offset of the end edge from the start of the edge, in meters. Negative value stands for invalid offset.

      • setEndEdgeOffset

         final Unit setEndEdgeOffset(Float endEdgeOffset)

        offset of the end edge from the start of the edge, in meters. Negative value stands for invalid offset.

      • getDistanceFromRouteStart

         final Float getDistanceFromRouteStart()

        distance from the start of corresponding route where this flow started, in meters

      • setDistanceFromRouteStart

         final Unit setDistanceFromRouteStart(Float distanceFromRouteStart)

        distance from the start of corresponding route where this flow started, in meters

      • getFlowLength

         final Float getFlowLength()

        length of the flow segment, in meters

      • setFlowLength

         final Unit setFlowLength(Float flowLength)

        length of the flow segment, in meters

      • getFlowSpeed

         final Float getFlowSpeed()

        average speed of the flow segment, in meters per second. value 0 means blocked flow, negative values means data not available

      • setFlowSpeed

         final Unit setFlowSpeed(Float flowSpeed)

        average speed of the flow segment, in meters per second. value 0 means blocked flow, negative values means data not available

      • getCongestionLevel

         final Integer getCongestionLevel()

        congestion level of this part of flow, see TrafficLevel definition

      • setCongestionLevel

         final Unit setCongestionLevel(Integer congestionLevel)

        congestion level of this part of flow, see TrafficLevel definition