HERE Android SDK Developer's Guide

ConsumptionParameters

The class ConsumptionParameters is a member of com.here.android.mpa.routing .

Class Summary

public final class ConsumptionParameters

extends java.lang.Object

Stores information about consumption parameters of vehicle.

[For complete information, see the section Class Details]

Nested Class Summary

Table 1. Nested Classes in ConsumptionParameters
Nested Classes

public static final class ConsumptionParameters.ConsumptionForSpeed

Specifies consumption per meter for different travel speeds.

Constructor Summary

Table 2. Constructors in ConsumptionParameters
Constructors

ConsumptionParameters ()

Default Constructor

Method Summary

Table 3. Methods in ConsumptionParameters
Methods

public static ConsumptionParameters createDefaultConsumptionParameters ()

Creates consumption parameters with default values.

public double getAccelerationMultiplier ()

Gets the acceleration multiplier.

public double getAscentMultiplier ()

Gets the ascent multiplier.

public double getAuxiliaryConsumption ()

Gets the auxiliary consumption.

public double getDecelerationMultiplier ()

Gets the deceleration multiplier.

public double getDescentMultiplier ()

Gets the descent multiplier.

public java.util.List <ConsumptionForSpeed> getSpeedParameters ()

Gets consumption per meter for different travel speeds.

public double getTurnTimeMultiplier ()

Gets the turn time multiplier.

public int hashCode ()

For documentation, see java.lang.Object

public void setAccelerationMultiplier (double multiplier)

Sets acceleration multiplier.

public void setAscentMultiplier (double multiplier)

Sets the ascent multiplier.

public void setAuxiliaryConsumption (double auxiliaryConsumption)

Sets auxiliary consumption per second.

public void setDecelerationMultiplier (double multiplier)

Sets deceleration multiplier.

public void setDescentMultiplier (double multiplier)

Sets descent multiplier.

public void setSpeedParameters (java.util.List <ConsumptionForSpeed> consumptionForSpeedList)

Sets consumption for different speeds.

public void setTurnTimeMultiplier (double multiplier)

Sets turn time multiplier.

Class Details

Stores information about consumption parameters of vehicle. Consumption parameters are used for consumption calculation (See Route and RouteConsumption).

IMPORTANT: Consumption calculation is a Beta feature. The related classes are subject to change without notice.

Constructor Details

ConsumptionParameters ()

Default Constructor

Method Details

public static ConsumptionParameters createDefaultConsumptionParameters ()

Creates consumption parameters with default values.

public double getAccelerationMultiplier ()

Gets the acceleration multiplier.

Returns:

The multiplier

public double getAscentMultiplier ()

Gets the ascent multiplier.

Returns:

The multiplier

public double getAuxiliaryConsumption ()

Gets the auxiliary consumption.

Returns:

The consumption value

public double getDecelerationMultiplier ()

Gets the deceleration multiplier.

Returns:

The multiplier

public double getDescentMultiplier ()

Gets the descent multiplier.

Returns:

The multiplier

public java.util.List <ConsumptionForSpeed> getSpeedParameters ()

Gets consumption per meter for different travel speeds.

Returns:

List of ConsumptionParameters.ConsumptionForSpeed instances or null if none are available.

public double getTurnTimeMultiplier ()

Gets the turn time multiplier.

Returns:

The multiplier

public int hashCode ()

For documentation, see java.lang.Object

public void setAccelerationMultiplier (double multiplier)

Sets acceleration multiplier. During speed up this parameter is used to model energy to fuel expenditure.

Parameters:

  • multiplier

    The acceleration multiplier

public void setAscentMultiplier (double multiplier)

Sets the ascent multiplier. It is multiplied by absolute height increase to model energy/fuel expenditure.

Parameters:

  • multiplier

    The ascent multiplier

public void setAuxiliaryConsumption (double auxiliaryConsumption)

Sets auxiliary consumption per second. Should be specified when we need to account for the consumption of lights, conditioner, radio, ...

Parameters:

  • auxiliaryConsumption

    The combined auxiliary consumption value

public void setDecelerationMultiplier (double multiplier)

Sets deceleration multiplier. During slowdown this parameter is used to model energy to fuel gain.

Parameters:

  • multiplier

    The deceleration multiplier

public void setDescentMultiplier (double multiplier)

Sets descent multiplier. It is multiplied by absolute height decrease to model energy/fuel gain.

Parameters:

  • multiplier

    The descent multiplier

public void setSpeedParameters (java.util.List <ConsumptionForSpeed> consumptionForSpeedList)

Sets consumption for different speeds.

Parameters:

Throws:

  • IllegalArgumentException

    if consumptionForSpeedList is null or empty.

public void setTurnTimeMultiplier (double multiplier)

Sets turn time multiplier. It is multiplied by turn travel time in seconds.

Parameters:

  • multiplier

    The turn time multiplier

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.