com.tomtom.online.sdk.data

Class SpeedToConsumptionMap

java.lang.Object

com.tomtom.online.sdk.data.SpeedToConsumptionMap

public class SpeedToConsumptionMap
extends java.lang.Object

A speed to fuel/energy consumption map. Units and constraints are defined by the context in which this is used.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.Integer,java.lang.Double>	speedToConsumptionPairs A map which contains pairs of speed-consumption values.

Constructor Summary

Constructors

Constructor and Description
SpeedToConsumptionMap()

Method Summary

Modifier and Type	Method and Description
void	addSpeedToConsumptionValue(int speed, double consumption) Add a speed-consumption pair to the map.
static SpeedToConsumptionMap	create(java.util.Map<java.lang.Integer,java.lang.Double> fromMap) A static method that returns a new instance of SpeedToConsumptionMap.
java.util.Map<java.lang.Integer,java.lang.Double>	getValues() Get a map of speed-consumption values.

Methods inherited from class java.lang.Object

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

Field Detail

speedToConsumptionPairs

public final java.util.Map<java.lang.Integer,java.lang.Double> speedToConsumptionPairs

A map which contains pairs of speed-consumption values. Filled with values in create(Map).

Constructor Detail

SpeedToConsumptionMap

public SpeedToConsumptionMap()

Method Detail

addSpeedToConsumptionValue

public void addSpeedToConsumptionValue(int speed,
                                       double consumption)

Add a speed-consumption pair to the map.

Parameters:

speed -

consumption -

getValues

@NonNull
public java.util.Map<java.lang.Integer,java.lang.Double> getValues()

Get a map of speed-consumption values.

Returns:

A map of speed-consumption values.

create

@NonNull
public static SpeedToConsumptionMap create(java.util.Map<java.lang.Integer,java.lang.Double> fromMap)

A static method that returns a new instance of SpeedToConsumptionMap. A map in a new instance that copies all values from that passed as parameter map.

Parameters:

fromMap - A reference map that values will be copied into in a new instance of this class.