Table of Contents

Class FillUp

Namespace
Geotab.Checkmate.ObjectModel.Fuel
Assembly
Geotab.Checkmate.ObjectModel.dll

An event representing adding fuel to an asset. Many sources of data are evaluated to determine a fill-up. FuelTransactions, StatusData (fuel level percent, fuel level volume, fuel used, tank capacity, odometer), LogRecords, Trips are all used to calculate fill-up events.

[ReportClass]
public class FillUp : EntityWithVersion, IEntity, IComparable, IIdentifiable, IVersion, IDeviceProvider, IDriverProvider, IDateTimeProvider, IOdometerProvider, ISimpleCoordinatesProvider, IDeletedDateTimeProvider
Inheritance
FillUp
Implements
Inherited Members

Constructors

FillUp()

Initializes a new instance of the FillUp class.

public FillUp()

FillUp(Device?, Driver?, DateTime?, double?, float?, double?, decimal?, string?, ISimpleCoordinate?, FuelUpEventConfidences?, double?, FillUpExtrema?, IList<FuelTransaction>?, FuelTransactionProductType?)

Initializes a new instance of the FillUp class.

public FillUp(Device? device, Driver? driver, DateTime? dateTime, double? odometer, float? distance, double? volume, decimal? cost, string? currencyCode, ISimpleCoordinate? location, FuelUpEventConfidences? confidence, double? totalFuelUsed, FillUpExtrema? tankLevelExtrema, IList<FuelTransaction>? fuelTransactions, FuelTransactionProductType? productType)

Parameters

device Device

The Device.

driver Driver

The Driver.

dateTime DateTime?

The DateTime that the fill-up occurred.

odometer double?

The odometer.

distance float?

The distance traveled since the last fill-up event.

volume double?

The volume.

cost decimal?

The cost.

currencyCode string

The currencyCode.

location ISimpleCoordinate

The location.

confidence FuelUpEventConfidences?

The FuelUpEventConfidences.

totalFuelUsed double?

The fuel used since the last fill-up event.

tankLevelExtrema FillUpExtrema

The fuel tank level change.

fuelTransactions IList<FuelTransaction>

The raw fuel transactions.

productType FuelTransactionProductType?

The FuelTransactionProductType.

FillUp(Id?, long?, Device?, Driver?, DateTime?, double?, float?, double?, decimal?, string?, ISimpleCoordinate?, FuelUpEventConfidences?, double?, FillUpExtrema?, IList<FuelTransaction>?, FuelTransactionProductType?)

Initializes a new instance of the FillUp class.

public FillUp(Id? id, long? version, Device? device, Driver? driver, DateTime? dateTime, double? odometer, float? distance, double? volume, decimal? cost, string? currencyCode, ISimpleCoordinate? location, FuelUpEventConfidences? confidence, double? totalFuelUsed, FillUpExtrema? tankLevelExtrema, IList<FuelTransaction>? fuelTransactions, FuelTransactionProductType? productType)

Parameters

id Id

The id.

version long?

The version.

device Device

The Device.

driver Driver

The Driver.

dateTime DateTime?

The DateTime that the fill-up occurred.

odometer double?

The odometer.

distance float?

The distance traveled since last fill-up event.

volume double?

The volume.

cost decimal?

The cost.

currencyCode string

The currencyCode.

location ISimpleCoordinate

The location.

confidence FuelUpEventConfidences?

The confidence.

totalFuelUsed double?

The fuel used since the last fill-up event.

tankLevelExtrema FillUpExtrema

The fuel tank level change.

fuelTransactions IList<FuelTransaction>

The raw fuel transactions.

productType FuelTransactionProductType?

The FuelTransactionProductType.

Properties

Confidence

Gets or sets the FuelUpEventConfidences associated with the Fuel record. Default [None].

public FuelUpEventConfidences? Confidence { get; set; }

Property Value

FuelUpEventConfidences?

FuelUpEventConfidences

Cost

Gets or sets the cost of the fuel transaction. Default [0].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FuelEventCost })]
public decimal? Cost { get; set; }

Property Value

decimal?

decimal

CurrencyCode

Gets or sets the three digit ISO 427 currency code (http://www.xe.com/iso4217.php). Default ["USD"].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FuelEventCurrencyCode })]
public string? CurrencyCode { get; set; }

Property Value

string

string

DateTime

Gets or sets the UTC date and time of the fuel event.

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FuelEventDateTime })]
public DateTime? DateTime { get; set; }

Property Value

DateTime?

DateTime

DeletedDateTime

An interface for an entity that can be marked as deleted.

public DateTime? DeletedDateTime { get; set; }

Property Value

DateTime?

DerivedVolume

Gets or sets the volume in Liters derived from fuel tank capacity. Default [-1].

public double? DerivedVolume { get; set; }

Property Value

double?

double

DeviationFactor

Gets or sets the difference in fuel out vs fuel in.

public double? DeviationFactor { get; set; }

Property Value

double?

double

Device

Gets or sets the Device associated with the fuel used event.

public Device? Device { get; set; }

Property Value

Device

Device

Distance

Gets or sets the distance in meters traveled since the last fill-up.

public float? Distance { get; set; }

Property Value

float?

float

Driver

Gets or sets the Driver associated with the transaction.

public Driver? Driver { get; set; }

Property Value

Driver

Driver

FuelTransactions

Gets or sets the FuelTransactions matched to this fill-up.

public IList<FuelTransaction>? FuelTransactions { get; set; }

Property Value

IList<FuelTransaction>

IList<T>

Location

Gets or sets the Coordinate of the transaction retailer. Default [0,0].

public ISimpleCoordinate? Location { get; set; }

Property Value

ISimpleCoordinate

ISimpleCoordinate

Odometer

Gets or sets the odometer reading in meters. Default [0].

public double? Odometer { get; set; }

Property Value

double?

double

ProductType

Gets or sets the FuelTransactionProductType of this transaction. Default [Unknown].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FuelEventProductType })]
public FuelTransactionProductType? ProductType { get; set; }

Property Value

FuelTransactionProductType?

FuelTransactionProductType

TankCapacity

Gets or sets the FuelTankCapacity and how it was derived.

public FuelTankCapacity? TankCapacity { get; set; }

Property Value

FuelTankCapacity

FuelTankCapacity

TankLevelExtrema

Gets or sets the FillUpExtrema representing the fuel tank level change at the time of the fill-up.

public FillUpExtrema? TankLevelExtrema { get; set; }

Property Value

FillUpExtrema

FillUpExtrema

TotalFuelUsed

Gets or sets the total fuel used in Liters up to this point in time. Default [-1].

[ExcelColumnHeader(new ReportHeading[] { ReportHeading.FuelUpEventTotalFuelUsed }, IsFuelVolume = true)]
public double? TotalFuelUsed { get; set; }

Property Value

double?

double

Volume

Gets or sets the volume of fuel added in Liters. Default [0].

public double? Volume { get; set; }

Property Value

double?

double

Methods

Clone()

Creates a new object that is a copy of the current instance.

public override IEntity Clone()

Returns

IEntity

A new object that is a copy of this instance.

PopulateDefaults()

Populate the fill-up defaults.

public void PopulateDefaults()