Package 

Class StepInfo

  • All Implemented Interfaces:
    
public final class StepInfo

    Container of a data for a current route step. Can be treated as a maneuver info.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class StepInfo.Companion

    • Constructor Summary

      Constructors 
      Constructor Description
      StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex, Integer turnAction, Integer turnAssistAction, Double distanceToTurn, Double maneuverLength, Boolean isHighwayExit, Boolean isNextQuickTurn, String routeID)
      StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex, Integer turnAction, Integer turnAssistAction, Double distanceToTurn, Double maneuverLength, Boolean isHighwayExit, Boolean isNextQuickTurn)
      StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex, Integer turnAction, Integer turnAssistAction, Double distanceToTurn, Double maneuverLength, Boolean isHighwayExit)
      StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex, Integer turnAction, Integer turnAssistAction, Double distanceToTurn, Double maneuverLength)
      StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex, Integer turnAction, Integer turnAssistAction, Double distanceToTurn)
      StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex, Integer turnAction, Integer turnAssistAction)
      StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex, Integer turnAction)
      StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex)
      StepInfo(SpeedInfo speedInfo, Integer currentLegIndex)
      StepInfo(SpeedInfo speedInfo)
      StepInfo()

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final SpeedInfo getSpeedInfo() Current speed info of a vehicle
      final Integer getCurrentLegIndex() Index of a current leg.
      final Integer getCurrentStepIndex() Index of a step in the current leg.
      final Integer getTurnAction() Guidance action for the next maneuver.
      final Integer getTurnAssistAction() Assist action for the next maneuver.
      final Double getDistanceToTurn() Distance from the current CVP position to the point of the maneuver
      final Double getManeuverLength() Step length - the distance from the start of the maneuver to its end
      final Boolean isHighwayExit() Flag indicating that the next maneuver is an exit from the highway
      final Boolean isNextQuickTurn() Flag indicating that the next maneuver is a quick turn
      final String getRouteID() String ID of a current route

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • StepInfo

        StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex, Integer turnAction, Integer turnAssistAction, Double distanceToTurn, Double maneuverLength, Boolean isHighwayExit, Boolean isNextQuickTurn, String routeID)

      • StepInfo

        StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex, Integer turnAction, Integer turnAssistAction, Double distanceToTurn, Double maneuverLength, Boolean isHighwayExit, Boolean isNextQuickTurn)

      • StepInfo

        StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex, Integer turnAction, Integer turnAssistAction, Double distanceToTurn, Double maneuverLength, Boolean isHighwayExit)

      • StepInfo

        StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex, Integer turnAction, Integer turnAssistAction, Double distanceToTurn, Double maneuverLength)

      • StepInfo

        StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex, Integer turnAction, Integer turnAssistAction, Double distanceToTurn)

      • StepInfo

        StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex, Integer turnAction, Integer turnAssistAction)

      • StepInfo

        StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex, Integer turnAction)

      • StepInfo

        StepInfo(SpeedInfo speedInfo, Integer currentLegIndex, Integer currentStepIndex)

      • StepInfo

        StepInfo(SpeedInfo speedInfo, Integer currentLegIndex)

      • StepInfo

        StepInfo()

    • Method Detail

      • getCurrentLegIndex

         final Integer getCurrentLegIndex()

        Index of a current leg. Leg is the set of steps between two waypoints. If the route consists with only one destination, then the route will have only one leg. In this case index will be 0.

      • getCurrentStepIndex

         final Integer getCurrentStepIndex()

        Index of a step in the current leg. Step is a sub-route from the CVP up to the next turn or maneuver.

      • getTurnAction

         final Integer getTurnAction()

        Guidance action for the next maneuver.

      • getTurnAssistAction

         final Integer getTurnAssistAction()

        Assist action for the next maneuver. Assist actions are special types of maneuvers that require additional attention,

      • getDistanceToTurn

         final Double getDistanceToTurn()

        Distance from the current CVP position to the point of the maneuver

      • getManeuverLength

         final Double getManeuverLength()

        Step length - the distance from the start of the maneuver to its end

      • isHighwayExit

         final Boolean isHighwayExit()

        Flag indicating that the next maneuver is an exit from the highway

      • isNextQuickTurn

         final Boolean isNextQuickTurn()

        Flag indicating that the next maneuver is a quick turn

      • getRouteID

         final String getRouteID()

        String ID of a current route