com.SIMRacingApps.SIMPlugins.iRacing.Gauges

Class Changeables

java.lang.Object

com.SIMRacingApps.Gauge

com.SIMRacingApps.SIMPlugins.iRacing.iRacingGauge

com.SIMRacingApps.SIMPlugins.iRacing.Gauges.Changeables

public class Changeables
extends iRacingGauge

This class is responsible for managing the changes the SIM can make, but it doesn't tell us it changed them in the pit flags. But, it does tell us what the next value will be, but not the current value. For current value, we will have to save the next value when we pit.

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
Changeables(java.lang.String type, iRacingCar car, Track track, IODriver IODriver, java.lang.String varName, java.lang.String defaultUOM, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> simGaugesBefore, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> simGaugesAfter)

Method Summary

Modifier and Type	Method and Description
void	_onDataVersionChange(State status, int currentLap, double sessionTime, double lapCompletedPercent, double trackLength)
Data	getCount() Returns the number of times this gauge was used.
Data	getLapsHistorical() Returns the number of laps since the last change.
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.

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, decrementValueNext, getCapacityIncrement, getCapacityIncrement, getCapacityMaximum, getCapacityMaximum, getCapacityMaximumRaw, getCapacityMinimum, getCapacityMinimum, getCapacityMinimumRaw, getChangeFlag, getIsChangeable, getIsDirty, getIsFixed, getLapChanged, getLaps, getLaps, getMajorIncrement, getMajorIncrement, getMaxCount, getMaximum, getMaximum, getMinimum, getMinimum, getMinorIncrement, getMinorIncrement, getMultiplier, getName, getOnResetChange, getType, getTypeName, getUOM, getValueCurrent, getValueHistorical, getValueNext, incrementValueNext, incrementValueNext, setChangeFlag, setChangeFlag, setValueNext, setValueNext, setValueNext, setValueNext, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Changeables

public Changeables(java.lang.String type,
                   iRacingCar car,
                   Track track,
                   IODriver IODriver,
                   java.lang.String varName,
                   java.lang.String defaultUOM,
                   java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> simGaugesBefore,
                   java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> simGaugesAfter)

Method Detail

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.