com.SIMRacingApps.SIMPlugins.iRacing.Gauges

Class FuelLevel

java.lang.Object

com.SIMRacingApps.Gauge

com.SIMRacingApps.SIMPlugins.iRacing.iRacingGauge

com.SIMRacingApps.SIMPlugins.iRacing.Gauges.FuelLevel

public class FuelLevel
extends iRacingGauge

Since:

1.5

Author:

Jeffrey Gilliam

Copyright:

Copyright (C) 2015 - 2024 Jeffrey Gilliam

License:

Apache License 2.0

Nested Class Summary

Nested classes/interfaces inherited from class com.SIMRacingApps.Gauge

Gauge.Type

Constructor Summary

Constructors

Constructor and Description
FuelLevel(java.lang.String type, iRacingCar car, Track track, IODriver IODriver, java.lang.Integer driversIdx)

Method Summary

Modifier and Type	Method and Description
void	_onDataVersionChange(State status, int currentLap, double sessionTime, double lapCompletedPercent, double trackLength)
Data	decrementValueNext(java.lang.String UOM) Decrements the next value, to be applied at the next pit stop, according to the value set by Gauge._setCapacityIncrement(double,String).
Data	getCapacityIncrement(java.lang.String UOM) Returns the increment value that the gauge uses when you call Gauge.incrementValueNext(String) or Gauge.decrementValueNext(String).
Data	getCapacityMaximum(java.lang.String UOM) Returns the maximum number that this gauge will accept when calling Gauge.setValueNext(double,String) or Gauge.incrementValueNext(String)
Data	getCapacityMinimum(java.lang.String UOM) Returns the minimum number that this gauge will accept when calling Gauge.setValueNext(double,String) or Gauge.decrementValueNext(String)
Data	getCount() Returns the number of times this gauge was used.
Data	getLapsHistorical() Returns the number of laps since the last change.
Data	getMajorIncrement(java.lang.String UOM) Returns how often to show major tick marks between the minimum and the maximum.
Data	getMaximum(java.lang.String UOM) Returns the maximum value of where this gauge should end with the last tick mark (i.e.
Data	getMinorIncrement(java.lang.String UOM) Returns how often to show minor tick marks between the minimum and the maximum.
Data	getValueCurrent(java.lang.String UOM) Returns the current value of the gauge.
Data	getValueHistorical(java.lang.String UOM) Returns the historical value of the gauge taken at the time it was changed.
Data	getValueNext(java.lang.String UOM) Returns the value of the next value that the object will be at the next pit stop.
Data	incrementValueNext(java.lang.String UOM) Increments the next value, to be applied at the next pit stop, according to the value set by Gauge._setCapacityIncrement(double,String).
Data	setChangeFlag(boolean flag) Sets the change flag for this gauge and all the gauges grouped with it.
Data	setValueNext(double d, java.lang.String UOM) Sets the next value to be applied at the next pit stop.

Methods inherited from class com.SIMRacingApps.SIMPlugins.iRacing.iRacingGauge

_clearSIMCommandTimestamp, _getSIMCommandTimestamp, _getSIMCommandValue, _resetDetected, _setSIMCommandTimestamp, getLaps, getValueCurrent

Methods inherited from class com.SIMRacingApps.Gauge

_addStateRange, _addStateRange, _addStateRange, _removeStateRange, _setCapacityIncrement, _setCapacityMaximum, _setCapacityMinimum, _setIsChangable, _setIsDirty, _setIsFixed, _setMajorIncrement, _setMaximum, _setMinimum, _setMinorIncrement, _setOnResetChange, decrementValueNext, getCapacityIncrement, getCapacityMaximum, getCapacityMaximumRaw, getCapacityMinimum, getCapacityMinimumRaw, getChangeFlag, getIsChangeable, getIsDirty, getIsFixed, getLapChanged, getLaps, getLaps, getMajorIncrement, getMaxCount, getMaximum, getMinimum, getMinimum, getMinorIncrement, getMultiplier, getName, getOnResetChange, getType, getTypeName, getUOM, getValueCurrent, getValueHistorical, getValueNext, incrementValueNext, setChangeFlag, setValueNext, setValueNext, setValueNext, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FuelLevel

public FuelLevel(java.lang.String type,
                 iRacingCar car,
                 Track track,
                 IODriver IODriver,
                 java.lang.Integer driversIdx)

Method Detail

setChangeFlag

public Data setChangeFlag(boolean flag)

Description copied from class: Gauge

Sets the change flag for this gauge and all the gauges grouped with it. By default, this will not all the change flag to be true. Therefore, each gauge that can be changed, must override this and set the flag.

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/setChangeFlag/(FLAG)

Overrides:

setChangeFlag in class Gauge

Parameters:

flag - Y or N to change or not to change

Returns:

The change flag

setValueNext

public Data setValueNext(double d,
                         java.lang.String UOM)

Description copied from class: Gauge

Sets the next value to be applied at the next pit stop. If the gauge is fixed, then only the change flag will be set and the next value will not be changed. If below the minimum capacity, then it sets it to the minimum capacity. If above the maximum capacity, then it sets it to the maximum capacity. The value is rounded to the nearest increment as defined by Gauge._setCapacityIncrement(double,String). The change flag is set to Y even if the new value and the old value are the same.

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/setValueNext/(VALUE)/(UOM)

Overrides:

setValueNext in class Gauge

Parameters:

d - (Optional) The value to be set. Default 0.

UOM - (Optional) The unit of measure the new measure to be set is in. Also affects return value. Default to gauge's UOM.

Returns:

The new value, possibly adjusted.

decrementValueNext

public Data decrementValueNext(java.lang.String UOM)

Description copied from class: Gauge

Decrements the next value, to be applied at the next pit stop, according to the value set by Gauge._setCapacityIncrement(double,String). If the gauge is fixed, then only the change flag will be set and the next value will not be changed. The change flag is set to Y even if the new value and the old value are the same.

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/decrementValueNext/(UOM)

Overrides:

decrementValueNext in class Gauge

Parameters:

UOM - (Optional) The unit of measure to return the new value in. Default gauge's UOM.

Returns:

The new value.

incrementValueNext

public Data incrementValueNext(java.lang.String UOM)

Description copied from class: Gauge

Increments the next value, to be applied at the next pit stop, according to the value set by Gauge._setCapacityIncrement(double,String). If the gauge is fixed, then only the change flag will be set and the next value will not be changed. If increments above the maximum capacity, then it sets it to the maximum capacity. The change flag is set to Y even if the new value and the old value are the same.

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/incrementValueNext/(UOM)

Overrides:

incrementValueNext in class Gauge

Parameters:

UOM - (Optional) The unit of measure to return the new value in. Default to gauge's UOM.

Returns:

The new value.

getMaximum

public Data getMaximum(java.lang.String UOM)

Description copied from class: Gauge

Returns the maximum value of where this gauge should end with the last tick mark (i.e. 300). Note: The value would be after the multiplier has been applied.

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/Maximum/(UOM)

Overrides:

getMaximum in class Gauge

Parameters:

UOM - (Optional) The UOM to convert the value to, defaults to the gauge's UOM.

Returns:

The maximum value

getMajorIncrement

public Data getMajorIncrement(java.lang.String UOM)

Description copied from class: Gauge

Returns how often to show major tick marks between the minimum and the maximum. Note: The value would be after the multiplier has been applied.

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/MajorIncrement/(UOM)

Overrides:

getMajorIncrement in class Gauge

Parameters:

UOM - (Optional) The UOM to convert the value to, defaults to the gauge's UOM.

Returns:

The major increment value

getMinorIncrement

public Data getMinorIncrement(java.lang.String UOM)

Description copied from class: Gauge

Returns how often to show minor tick marks between the minimum and the maximum. Note: The value would be after the multiplier has been applied.

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/MinorIncrement/(UOM)

Overrides:

getMinorIncrement in class Gauge

Parameters:

UOM - (Optional) The UOM to convert the value to, defaults to the gauge's UOM.

Returns:

The minor increment value

getCapacityMaximum

public Data getCapacityMaximum(java.lang.String UOM)

Description copied from class: Gauge

Returns the maximum number that this gauge will accept when calling Gauge.setValueNext(double,String) or Gauge.incrementValueNext(String)

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/CapacityMaximum/(UOM)

Overrides:

getCapacityMaximum in class Gauge

Parameters:

UOM - (Optional) The UOM to convert the value to, defaults to the gauge's UOM.

Returns:

The maximum capacity.

getCapacityMinimum

public Data getCapacityMinimum(java.lang.String UOM)

Description copied from class: Gauge

Returns the minimum number that this gauge will accept when calling Gauge.setValueNext(double,String) or Gauge.decrementValueNext(String)

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/CapacityMinimum/(UOM)

Overrides:

getCapacityMinimum in class Gauge

Parameters:

UOM - (Optional) The UOM to convert the value to, defaults to the gauge's UOM.

Returns:

The minimum capacity.

getCapacityIncrement

public Data getCapacityIncrement(java.lang.String UOM)

Description copied from class: Gauge

Returns the increment value that the gauge uses when you call Gauge.incrementValueNext(String) or Gauge.decrementValueNext(String). Also, all values passed to Gauge.setValueNext(double,String) are rounded up to the the closest multiple of this value.

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/CapacityIncrement/(UOM)

Overrides:

getCapacityIncrement in class Gauge

Parameters:

UOM - (Optional) The UOM to convert the value to, defaults to the gauge's UOM.

Returns:

The incremental capacity.

getValueCurrent

public Data getValueCurrent(java.lang.String UOM)

Description copied from class: Gauge

Returns the current value of the gauge.

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/ValueCurrent/(UOM)

Overrides:

getValueCurrent in class iRacingGauge

Parameters:

UOM - (Optional) The unit of measure to return, default to the gauges UOM.

Returns:

The current value.

getValueNext

public Data getValueNext(java.lang.String UOM)

Description copied from class: Gauge

Returns the value of the next value that the object will be at the next pit stop. By default it returns the current value.

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/ValueNext/(UOM)

Overrides:

getValueNext in class Gauge

Parameters:

UOM - The unit of value to return.

Returns:

The value if the next value.

getValueHistorical

public Data getValueHistorical(java.lang.String UOM)

Description copied from class: Gauge

Returns the historical value of the gauge taken at the time it was changed.

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/ValueHistorical/(UOM)

Overrides:

getValueHistorical in class Gauge

Parameters:

UOM - (Optional) The unit of measure to return it in, defaults to the gauges UOM.

Returns:

The historical value.

getLapsHistorical

public Data getLapsHistorical()

Description copied from class: Gauge

Returns the number of laps since the last change.

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/LapsHistorical

Overrides:

getLapsHistorical in class Gauge

Returns:

The lap number of laps since the last change.

_onDataVersionChange

public void _onDataVersionChange(State status,
                                 int currentLap,
                                 double sessionTime,
                                 double lapCompletedPercent,
                                 double trackLength)

Overrides:

_onDataVersionChange in class iRacingGauge

getCount

public Data getCount()

Description copied from class: Gauge

Returns the number of times this gauge was used.

PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)/Count 1.2

Overrides:

getCount in class Gauge

Returns:

The number of times this gauge was changed.