Class FuelAndElectricConverter

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

false Converts fuel/electric volumes/totals/economies between to and from different units. Volumes/totals are always returned even if 0. Economies will return 0 if the input is 0 to prevent divide by 0 exceptions.

public static class FuelAndElectricConverter

Inheritance

object

FuelAndElectricConverter

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

ConvertKwhToFuelVolume(float, VolumeUnit)

Convert the kwh to a fuel volume. Purely energy-based.

public static float ConvertKwhToFuelVolume(float kwhValue, VolumeUnit volumeUnit = VolumeUnit.Liter)

Parameters

kwhValue float

The kilowatt-hour energy value

volumeUnit VolumeUnit

The fuel volume unit.

Returns

float

The fuel volume which contains the same energy.

Exceptions

NotSupportedException

The VolumeUnit is not supported.

LocalizeElectricEconomy(float, ElectricEnergyEconomyUnit?, ElectricEnergyEconomyUnit?)

Converts to the localized electric energy economy.

public static float? LocalizeElectricEconomy(float economyIn, ElectricEnergyEconomyUnit? destUnit, ElectricEnergyEconomyUnit? sourceUnit = null)

Parameters

economyIn float

Input electric energy economy.

destUnit ElectricEnergyEconomyUnit?

Destination unit.

sourceUnit ElectricEnergyEconomyUnit?

Source unit, defaults to L/100 km.

Returns

float?

The localized fuel economy.

Exceptions

NotSupportedException

A FuelEconomyUnit is not supported.

LocalizeElectricEnergy(float, ElectricEnergyUnit, ElectricEnergyUnit)

Converts to the localized electric energy unit.

public static float LocalizeElectricEnergy(float energyIn, ElectricEnergyUnit destUnit, ElectricEnergyUnit sourceUnit = ElectricEnergyUnit.KilowattHour)

Parameters

energyIn float

Input energy volume.

destUnit ElectricEnergyUnit

Destination unit.

sourceUnit ElectricEnergyUnit

Source unit, defaults to kWh.

Returns

float

The local value.

Exceptions

NotSupportedException

A ElectricEnergyUnit is not supported.

LocalizeElectricPower(float, ElectricEnergyEconomyUnit?, ElectricEnergyEconomyUnit?)

Converts to the localized electric power unit. Reuses the electric economy unit but treats anything not W based as kW

public static float LocalizeElectricPower(float powerIn, ElectricEnergyEconomyUnit? destUnit, ElectricEnergyEconomyUnit? sourceUnit = null)

Parameters

powerIn float

Input power.

destUnit ElectricEnergyEconomyUnit?

Destination unit.

sourceUnit ElectricEnergyEconomyUnit?

Source unit, defaults to kWh.

Returns

float

The local value.

Exceptions

NotSupportedException

A ElectricEnergyUnit is not supported.

LocalizeFuelEconomy(float, FuelEconomyUnit?, FuelEconomyUnit?)

Converts to the localized fuel economy.

public static float? LocalizeFuelEconomy(float economyIn, FuelEconomyUnit? destUnit, FuelEconomyUnit? sourceUnit = FuelEconomyUnit.LitersPer100Km)

Parameters

economyIn float

Input fuel economy.

destUnit FuelEconomyUnit?

Destination unit.

sourceUnit FuelEconomyUnit?

Source unit, defaults to L/100 km.

Returns

float?

The localized fuel economy.

Exceptions

NotSupportedException

A FuelEconomyUnit is not supported.

LocalizeFuelVolume(float, VolumeUnit?, VolumeUnit?)

Converts to the localized fuel volume.

public static float LocalizeFuelVolume(float volumeIn, VolumeUnit? destUnit, VolumeUnit? sourceUnit = VolumeUnit.Liter)

Parameters

volumeIn float

Input fuel volume.

destUnit VolumeUnit?

Destination unit.

sourceUnit VolumeUnit?

Source unit, defaults to liters.

Returns

float

The local value.

Exceptions

NotSupportedException

A VolumeUnit is not supported.