Navigation/com.benomad.msdk.navigation.progress/GuidanceProgress

GuidanceProgress

open class GuidanceProgress(val state: NavigationProgressState, val currentSpeed: Double, val currentSpeedLimit: Double, val currentAddress: Address?, val currentGPSPosition: Location?, val currentMapMatchedPosition: GeoPoint?, val currentMapMatchedHeading: Double, val currentEnergyLoad: Double, val currentSoc: Double, val distanceToDest: Double, val drivingDurationToDest: Int, val drivingAndStopDurationToDest: Int, val distanceToNextInstruction: Double, val durationToNextInstruction: Int, val distanceToNextWaypoint: Double, val durationToNextWaypoint: Int, val nextWaypointIndex: Int, val totalDistance: Double, val totalDrivingTime: Int, val totalDrivingAndStopDuration: Int, val currentRouteInstructionIndex: Int, val currentRouteSectionIndex: Int, val energyLoadAtNextChargeStop: Double, val socAtNextChargeStop: Double, val nextChargeStopDuration: Int) : TrackingProgress

Class that holds progress info about the current guidance

Parameters

state

the current NavigationProgressState of the navigation

currentSpeed

the current speed in km/h of the user

currentSpeedLimit

the current speed limit in km/h of the current road.

currentAddress

the current Address that corresponds to the user location.

currentGPSPosition

the current user Location

currentMapMatchedPosition

the map-matched GeoPoint that corresponds to the position of the user on the current road.

currentMapMatchedHeading

the current orientation of the vehicle (angle) on the current map-matched location in degrees

currentEnergyLoad

If an EV Profile has been set, it corresponds to the current estimated energy load of the vehicle in kWh

currentSoc

If an EV Profile has been set, it corresponds to the current estimated SoC (battery level) of the vehicle in %

distanceToDest

the remaining distance in meters to the destination

drivingDurationToDest

the remaining duration (in seconds) to the destination (including stop times and charge durations).

drivingAndStopDurationToDest

Deprecated (use drivingDurationToDest instead)

distanceToNextInstruction

the remaining distance in meters to the next ManeuverType

durationToNextInstruction

the remaining duration in seconds to the next ManeuverType

distanceToNextWaypoint

the remaining distance in meters to the next RouteWaypoint

durationToNextWaypoint

the remaining duration in seconds to the next RouteWaypoint

nextWaypointIndex

index in Route.waypoints of the current route that corresponds to the next RouteWaypoint to reach (in Range 1, Route.waypoints.size-1)

totalDistance

Deprecated (use Route.length instead) : the total distance in meters of the current route. Its value changes after a re-reroute.

totalDrivingTime

Deprecated (use Route.drivingDuration instead) : the total estimated duration in seconds of the current route. Its value changes after a re-reroute.

totalDrivingAndStopDuration

Deprecated (use Route.travelDuration instead) : the total estimated duration in seconds of the current route that takes into account the stop times and charge durations of the route.

currentRouteInstructionIndex

the index that corresponds to the current Instruction index in the Route.sheet of the current Route

currentRouteSectionIndex

the index that corresponds to the current RouteSection index in the Route.sections of the current Route

energyLoadAtNextChargeStop

the estimated energy load in kWh of the vehicle at the next RouteWaypoint.chargePoolStop. If there is no remaining RouteWaypoint.chargePoolStop on the Route, this value is the estimated energy load of the vehicle at arrival.

socAtNextChargeStop

the estimated SoC in % of the vehicle at the next RouteWaypoint.chargePoolStop. If there is no remaining RouteWaypoint.chargePoolStop on the Route, this value is the estimated SoC of the vehicle at arrival.

nextChargeStopDuration

the duration in seconds of the charge at next station (the next ChargePoolStop in Route.waypoints) to reach the SoC planned for this station's departure. It doesn't take into account the defined RechargeParameters.stopFixedTime.

Inheritors

CircuitProgress

Constructors

GuidanceProgress

constructor(state: Int, currentSpeed: Double, currentSpeedLimit: Double, currentAddress: Address?, locLongitude: Double, locLatitude: Double, locAltitude: Double, locBearing: Float, locSatUsed: Int, currentMapMatchedPosition: GeoPoint?, currentMapMatchedHeading: Double, currentEnergyLoad: Double, currentSoc: Double, distanceToDest: Double, drivingDurationToDest: Int, drivingAndStopDurationToDest: Int, distanceToNextInstruction: Double, durationToNextInstruction: Int, distanceToNextWaypoint: Double, durationToNextWaypoint: Int, nextWaypointIndex: Int, totalDistance: Double, totalDrivingTime: Int, totalDrivingAndStopDuration: Int, currentRouteInstructionIndex: Int, currentRouteSectionIndex: Int, energyLoadAtNextChargeStop: Double, socAtNextChargeStop: Double, nextChargeStopDuration: Int)

Internal constructor called from JNI code : Don't modify its prototype !

constructor(state: NavigationProgressState, currentSpeed: Double, currentSpeedLimit: Double, currentAddress: Address?, currentGPSPosition: Location?, currentMapMatchedPosition: GeoPoint?, currentMapMatchedHeading: Double, currentEnergyLoad: Double, currentSoc: Double, distanceToDest: Double, drivingDurationToDest: Int, drivingAndStopDurationToDest: Int, distanceToNextInstruction: Double, durationToNextInstruction: Int, distanceToNextWaypoint: Double, durationToNextWaypoint: Int, nextWaypointIndex: Int, totalDistance: Double, totalDrivingTime: Int, totalDrivingAndStopDuration: Int, currentRouteInstructionIndex: Int, currentRouteSectionIndex: Int, energyLoadAtNextChargeStop: Double, socAtNextChargeStop: Double, nextChargeStopDuration: Int)