Class FuelSettings

Namespace

Geotab.Checkmate.Settings

Assembly

Geotab.Checkmate.ObjectModel.dll

The settings for fuel and fill-ups.

public class FuelSettings

Inheritance

object

FuelSettings

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

FuelSettings()

Initializes a new instance of the FuelSettings class.

public FuelSettings()

Properties

CountOfTaperedFuelLevelRecords

Gets or sets the minimum amount of records that need to be continuously decreasing before considering FillUps processing (only applicable to Fuel Processing).

public int CountOfTaperedFuelLevelRecords { get; set; }

Property Value

int

The number of tapered records required before calculating FillUps.

DateCompareHoursEngineToCard

Gets or sets the buffer for matching engine data derived fill-ups to a transaction derived fill-up in minutes.

public int DateCompareHoursEngineToCard { get; set; }

Property Value

int

The buffer for matching engine data derived fill-ups to a transaction derived fill-up in minutes.

DeleteRecordsOnReprocess

Gets or sets a value indicating whether or not to delete records on fuel reprocessing.

public bool DeleteRecordsOnReprocess { get; set; }

Property Value

bool

true if fillups are deleted on reprocessing; otherwise, false.

DerivedVolumeOveragePercent

Gets or sets the max allowed percentage difference in total tank capacity between fuel transaction volume and volume derived from percentage changed and tank capacity to trigger suspect event. Default [10%].

public int DerivedVolumeOveragePercent { get; set; }

Property Value

int

The max allowed percentage difference in total tank capacity between fuel transaction volume and volume derived from percentage changed and tank capacity to trigger suspect event. Default [10%].

EnableContinuousWindowProcessing

Gets or sets a value indicating whether or not to enable continuous window processing. Enabling this option will continuously process fuel events for the data provided in a given window for a device. This option essentially overwrites the cache date.

public bool EnableContinuousWindowProcessing { get; set; }

Property Value

bool

true if performing continuous window processing; otherwise, false.

EnableFuelProcessing

Gets or sets a value indicating whether or not to enable live fuel processing.

[Obsolete("Fuel Processing is now disabled using the custom code DISABLE_FUEL_PROCESSING. See MYG-40233.", true)]
public bool EnableFuelProcessing { get; set; }

Property Value

bool

true if performing live fuel processing; otherwise, false.

FuzzyTransactionMatching

Gets or sets a value indicating whether [fuzzy transaction matching]. Testing feature of fuzzy string matching. Caution can be slow. Use fuzzy string matching against device description and fuel transaction description and device description and fuel transaction driver name. This is an experimental feature.

public bool FuzzyTransactionMatching { get; set; }

Property Value

bool

A value indicating whether [fuzzy transaction matching]. Testing feature of fuzzy string matching. Caution can be slow. Use fuzzy string matching against device description and fuel transaction description and device description and fuel transaction driver name. This is an experimental feature.

IndeterminateDuration

Gets or sets the min duration between last fuel level record and fuel transaction time used to quantify indeterminate support for fuel level.

public TimeSpan IndeterminateDuration { get; set; }

Property Value

TimeSpan

The indeterminate duration.

LocationDistanceBuffer

Gets or sets the location distance buffer to have a successful location match between device location and transaction location.

public int LocationDistanceBuffer { get; set; }

Property Value

int

The location distance buffer to have a successful location match between device location and transaction location.

LooseTransactionMatching

Gets or sets a value indicating whether [loose transaction matching]. Testing feature of fall-back to matching on purely location and date (no vehicle/driver match). Loose matching will prioritize matches where the time and location match over the VIN. This is an experimental feature.

public bool LooseTransactionMatching { get; set; }

Property Value

bool

A value indicating whether [loose transaction matching]. Testing feature of fall-back to matching on purely location and date (no vehicle/driver match). Loose matching will prioritize matches where the time and location match over the VIN. This is an experimental feature.

MatchTransactionOnDriver

Gets or sets a value indicating whether or not to match fuel transactions based on driver.

public bool MatchTransactionOnDriver { get; set; }

Property Value

bool

true if matching transactions based on driver; otherwise, false.

MaxDaysForFuelCache

Gets or sets the maximum age (in days) for data to be stored in the fuel cache.

public int MaxDaysForFuelCache { get; set; }

Property Value

int

The maximum days for fuel cache.

MaxDegreeOfParallelism

Gets or sets the MaxDegreeOfParallelism used when calculating fill-ups.

public int MaxDegreeOfParallelism { get; set; }

Property Value

int

The MaxDegreeOfParallelism used when calculating fill-ups.

MaxThreshold

Gets or sets the maximum threshold used to detect a fill-up from engine data.

public int MaxThreshold { get; set; }

Property Value

int

The maximum threshold used to detect a fill-up from engine data.

MaxWindowSize

Gets or sets the maximum window size used to smooth engine data in determining fill-ups.

public int MaxWindowSize { get; set; }

Property Value

int

The maximum window size used to smooth engine data in determining fill-ups.

MinSnapStartThreshold

Gets or sets the minimum difference to snap slowly increasing to start. All increasing after this will be snapped regardless of threshold.

public int MinSnapStartThreshold { get; set; }

Property Value

int

The minimum difference to snap slowly increasing to start. All increasing after this will be snapped regardless of threshold.

MinThreshold

Gets or sets the minimum threshold used to detect a fill-up from engine data.

public int MinThreshold { get; set; }

Property Value

int

The minimum threshold used to detect a fill-up from engine data.

MinWindowSize

Gets or sets the minimum window size used to smooth engine data in determining fill-ups.

public int MinWindowSize { get; set; }

Property Value

int

The minimum window size used to smooth engine data in determining fill-ups.

TransactionTripMatchingBuffer

Gets or sets we have observed transaction time off by as much as 5+ hours. The buffer for matching to a trip in minutes.

public int TransactionTripMatchingBuffer { get; set; }

Property Value

int

We have observed transaction time off by as much as 5+ hours. The buffer for matching to a trip in minutes.

WaitForTaperingFuelLevelIfIgnitionIsOff

Gets or sets a value indicating whether or not to wait for decreasing fuel levels even if the ignition is currently off.

[Obsolete("In progress fill-up now removed based solely on fuel level data. See MYG-51945.", true)]
public bool WaitForTaperingFuelLevelIfIgnitionIsOff { get; set; }

Property Value

bool

true if we should wait until fuel levels decrease even if ignition is currently off; otherwise, false.

Methods

Clone()

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

public object Clone()

Returns

object

A new object that is a copy of this instance.

Equals(object?)

Determines whether the specified object, is equal to this instance.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with this instance.

Returns

bool

true if the specified object is equal to this instance; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

public override int GetHashCode()

Returns

int

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.