remainingBudgetAt

fun remainingBudgetAt(routeOffset: Distance, withAuxPower: AuxiliaryPower? = null): Result<Consumption>

Calculates the remaining battery charge at a given distance along the route.

Important: This is a Public Preview API. It may be changed or removed at any time.

This function takes charging stops into account. Thus, to calculate the energy used between two offsets, the total energy used is the difference between the remaining budgets at the two offsets plus the total energy charged at any charging stops between these points. If the requested point is exactly at a charging stop, the remaining budget is the arrival charge at that stop. If the requested point is not reachable, the remaining budget is negative.

This function can only be used if the route was planned using a Vehicle with an ElectricEngine containing consumption parameters.

Return

A Result containing a Consumption.Energy instance indicating the remaining budget at routeOffset, or a RouteDataFailure instance if an error occurred.

Parameters

routeOffset

The distance from the start of the route indicating up to which point the remaining budget should be calculated.

withAuxPower

A different assumed auxiliary power which should be used for the consumption estimation. If withAuxPower is not null, the function calculates a hypothetical state of charge at routeOffset if the aux power had been withAuxPower. This allows estimation of the powertrain's consumption by passing a zero aux power as well as simulating a higher comfort consumption.