com.SIMRacingApps.SIMPlugins.iRacing

Class iRacingCar

java.lang.Object

com.SIMRacingApps.Car

com.SIMRacingApps.SIMPlugins.iRacing.iRacingCar

public class iRacingCar
extends Car

Since:

1.0

Author:

Jeffrey Gilliam

Copyright:

Copyright (C) 2015 - 2024 Jeffrey Gilliam

License:

Apache License 2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	iRacingCar.dynamicIRating

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

Car.LapType, Car.Message, Car.SpotterMessages, Car.Status

Field Summary

Fields

Modifier and Type	Field and Description
iRacingCar.dynamicIRating	m_dynamicIRating

Fields inherited from class com.SIMRacingApps.Car

Tires

Constructor Summary

Constructors

Constructor and Description
iRacingCar(iRacingSIMPlugin SIMPlugin)
iRacingCar(iRacingSIMPlugin SIMPlugin, java.lang.Integer id, java.lang.String name, java.lang.Integer driversIdx)

Method Summary

Modifier and Type	Method and Description
java.lang.String	_getDriversIdx()
Data	getBearing(java.lang.String UOM) Returns the bearing of the car.
Data	getCautions() Returns the number of Cautions that this car has seen.
Data	getClassColor() Returns the color of the car's class if in a multi-class session
Data	getClassName() Returns the name of the car's class in a multicar session.
Data	getColor() Returns the main color of the car as an RGB value.
Data	getColorNumber() Returns the main color of the car number as an RGB value.
Data	getColorNumberBackground() Returns the main color of the car number's background as an RGB value.
Data	getColorNumberOutline() Returns the main color of the car number's outline as an RGB value.
Data	getDescription() Returns the printable description of the car.
Data	getDiscontinuality() Returns the number of times the car has blinked out.
Data	getDivisionName()
Data	getDriverClubName() Returns the club name of the current driver of the car.
Data	getDriverDivisionName() Returns the division name of the current driver of the car.
Data	getDriverInitials() Returns the initials of the current driver of the car.
Data	getDriverLicenseColor() Returns the license color of the current driver of the car.
Data	getDriverLicenseColorText() Returns the text color that best overlays the license color of the current driver of the car when it is used as a background.
Data	getDriverLicLevel()
Data	getDriverLicSubLevel()
Data	getDriverName(boolean allowMapping) Returns the name of the current driver of the car.
Data	getDriverNameShort(boolean allowMapping) Returns the name of the current driver of the car in a shortened format.
Data	getDriverRating() Returns the rating of the current driver of the car.
Data	getDriverRatingDelta() Returns the change of rating of the current driver of the car as the race progresses.
Data	getFuelLevelAtStartFinish(java.lang.String UOM) Returns the fuel level the last time the car crossed the start/finish line.
Data	getFuelLevelNeeded(int lapsToAverage, double laps, java.lang.String UOM) Returns the amount of fuel you need to add to complete the number of laps specified.
Data	getFuelLevelPerLap(int lapsToAverage, java.lang.String UOM) Returns the amount of fuel being consumed per lap.
Data	getFuelLevelToFinish(int lapsToAverage, double laps, java.lang.String UOM) Returns the total amount of fuel needed to finish the race regardless of how much is in the fuel tank.
Data	getHasAutomaticPitCommands() Automatic Pit Commands will not be enabled until a client calls this function to find out.
Data	getId() Returns the numeric id of this car.
Data	getImageUrl() Returns a URL to this car's image suitable for using in the "src" attribute of the "img" tag.
Data	getIncidents() Returns the number of incidents for the driver of this car.
Data	getIncidentsTeam() Returns the number of incidents for this car's team.
Data	getIsBlackFlag() Returns true if the black flag has been waved for this car.
Data	getIsBlueFlag() Returns true if the blue flag has been waved for this car.
Data	getIsDisqualifyFlag() Returns true if the disqualify flag has been waved for this car.
Data	getIsDriving() Returns true if are driving this car.
Data	getIsFixedSetup() Returns true if the car is in a fixed setup session.
Data	getIsPaceCar() Returns true if the car is the pace car.
Data	getIsPitSpeedLimiter() Returns true if the car has the pit speed limiter on.
Data	getIsPushToPassActive() Returns the push to pass active status.
Data	getIsSpectator() Returns true if the car is a spectator.
Data	getIsYellowFlag() Returns true if the yellow flag has been waved for this car.
Data	getLap(java.lang.String ref, int lapsToAverage) Returns the lap based on the specified reference type.
Data	getLapInvalidFlags() Returns the invalid status of each lap in in an array.
Data	getLapsToGo() Returns the number of laps this car has remaining.
Data	getLapTime(java.lang.String ref, int lapsToAverage) Returns the time of the lap based on the specified reference type.
Data	getLapTimeDelta(java.lang.String ref) Returns the time delta of the lap based on the specified reference type.
Data	getLapTimeDeltaPercent(java.lang.String ref) Returns the time delta as a percentage of the lap based on the specified reference type.
Data	getLapTimeDeltaReference(java.lang.String ref) Returns the time delta reference of the lap based on the specified reference type.
Data	getLapTimes() Returns the lap time of each lap in in an array The array is indexed as zero based.
Data	getLatitude(java.lang.String UOM) iRacing only outputs this value in the IBT files for ME This code checks to see if it exists before returning it, otherwise it calls the base class.
Data	getLatitudeAcceleration(java.lang.String UOM) Returns the Latitudinal Acceleration.
Data	getLongitude(java.lang.String UOM) iRacing only outputs this value in the IBT files for ME.
Data	getLongitudeAcceleration(java.lang.String UOM) Returns the Longitudinal Acceleration.
Data	getMaxTires() Returns the maximum number of tire sets for this session.
Data	getMergePoint() Returns the merge point as a percentage from the start/finish line.
Data	getMessages() Returns a string of a semicolon separate list of messages that are currently active for this car.
Data	getNumber() Returns the number of the car.
Data	getNumberFont() Returns the font of the car's number.
int	getNumberRaw() Returns the integer version of the car number to be used with camera commands.
Data	getNumberSlant() Returns the slant of the car's number.
Data	getPitLocation() Returns the pit location as a percentage from the start/finish line.
Data	getPitTime() Returns the amount of time the last pit stop took.
Data	getPitTimes() Returns the times this car pitted by lap.
Data	getPosition() Returns the current position based on all cars in the session.
Data	getPositionClass() Returns the current position based on the class the car is in.
Data	getPositionClassQualifying() Returns the qualifying position based on other cars in this session for your class.
Data	getPositionHighest() Returns the highest position in the current session.
Data	getPositionHighestClass() Returns the highest position in the current session for your class.
Data	getPositionLowest() Returns the lowest position in the current session.
Data	getPositionLowestClass() Returns the lowest position in the current session for your class.
Data	getPositionQualifying() Returns the qualifying position based on other cars in this session.
Data	getPositions() Returns the position at the end of each lap in in an array Positions start at 1, such that 1 is considered the leader, but the array is indexed as zero based.
Data	getPositionsClass() Returns the class position at the end of each lap in in an array Positions start at 1, such that 1 is considered the leader, but the array is indexed as zero based.
Data	getPushToPassRemaining() Returns the number of seconds remaining on the push to pass counter.
Data	getRadioChannel() Returns the radio channel number that this car is currently transmitting on.
Data	getRadioChannelName() Returns the radio channel name that this car is currently transmitting on.
Data	getRepairTime() Returns the amount of time required to repair the car.
Data	getRepairTimeOptional() Returns the amount of time that is optional to repair the car.
Data	getSpotterMessage() Returns the current spotter message.
Data	getStartFinishTimes() Returns the times this car crossed the start/finish by lap.
Data	getStatus() Returns the current status of the car as defined by Car.Status
Data	getTeamName() Returns the team name if the current session has teams.
Data	getWarnings() Returns a semicolon(;) separated list of engine warnings.
boolean	isME() A convenience function that returns true if the car is an instance of "ME".
boolean	isPaceCar()
boolean	isValid() Returns true if the car instance is actually in the session as defined by the SIM.
boolean	isValid(int id, int driversIdx)
boolean	onDataVersionChange()
Data	setAdminFlag(boolean onOffFlag) Sets this car/driver's admin status.
Data	setBlackFlag(int quantity, java.lang.String uom) Sets a black flag for this car/driver.
Data	setChat(java.lang.String text) Sends the text string as a chat message to this driver.
Data	setChatFlag(boolean onOffFlag) Sets this car/driver's chat status.
Data	setClearPenaltiesFlag() Clear all penalties, DQ, EOL, Black Flags.
Data	setDisqualifyFlag() Disqualify this car but leave them in the session.
Data	setEndOfLineFlag() Send this car to the end of the pacing line.
Data	setReloadPaint() Tell the SIM to reload the paint files for this car.
Data	setRemoveFlag() Remove the user from the session.
Data	setWaveAroundFlag() Wave this car around the pace car.

Methods inherited from class com.SIMRacingApps.Car

_dumpGauges, _getDataPublisherMaxTires, _getDefaultGauges, _getGauge, _getSIMGauges, _postInitialization, getBearing, getDriverName, getDriverName, getDriverNameShort, getDriverNameShort, getFuelLaps, getFuelLaps, getFuelLaps, getFuelLapsMaximum, getFuelLapsMaximum, getFuelLapsMaximum, getFuelLevelAtStartFinish, getFuelLevelNeeded, getFuelLevelNeeded, getFuelLevelNeeded, getFuelLevelNeeded, getFuelLevelPerLap, getFuelLevelPerLap, getFuelLevelPerLap, getFuelLevelToFinish, getFuelLevelToFinish, getFuelLevelToFinish, getFuelLevelToFinish, getGauge, getGauge, getIsBelowMinimumSpeed, getIsEqual, getIsEqual, getIsOverSpeedLimit, getIsUnderSpeedLimit, getLap, getLap, getLap, getLapTime, getLapTime, getLapTime, getLapTimeDelta, getLapTimeDeltaPercent, getLapTimeDeltaReference, getLapTimeProjected, getLatitude, getLatitudeAcceleration, getLongitude, getLongitudeAcceleration, getManufacturerLogo, getMergePointLatitude, getMergePointLongitude, getName, getPitSpeedLimit, getPitSpeedLimit, getPitStopsRemaining, getPitStopsRemaining, getPitStopsRemaining, getPositionClassDelta, getPositionDelta, getRPMPitRoadSpeed, getSector, getStatusClass, setAdminFlag, setBlackFlag, setBlackFlag, setBlackFlag, setCamera, setCamera, setChatFlag, setRPMPitRoadSpeed

Methods inherited from class java.lang.Object

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

Field Detail

m_dynamicIRating

public iRacingCar.dynamicIRating m_dynamicIRating

Constructor Detail

iRacingCar

public iRacingCar(iRacingSIMPlugin SIMPlugin)

iRacingCar

public iRacingCar(iRacingSIMPlugin SIMPlugin,
                  java.lang.Integer id,
                  java.lang.String name,
                  java.lang.Integer driversIdx)

Method Detail

_getDriversIdx

public java.lang.String _getDriversIdx()

getBearing

public Data getBearing(java.lang.String UOM)

Description copied from class: Car

Returns the bearing of the car.

PATH = /Car/(CARIDENTIFIER)/Bearing/(UOM)

Overrides:

getBearing in class Car

Parameters:

UOM - (Optional) A unit of measure to return. Defaults to degrees.

Returns:

The bearing of the car where 0 is 3 o'clock.

getCautions

public Data getCautions()

Description copied from class: Car

Returns the number of Cautions that this car has seen.

To get the number of caution laps seen by this car, use getLap("CAUTION")

PATH = /Car/(CARIDENTIFIER)/Cautions

Overrides:

getCautions in class Car

Returns:

The number of cautions in a Data container.

getClassColor

public Data getClassColor()

Description copied from class: Car

Returns the color of the car's class if in a multi-class session

PATH = /Car/(CARIDENTIFIER)/ClassColor

Overrides:

getClassColor in class Car

Returns:

The name of the class in a Data container.

getClassName

public Data getClassName()

Description copied from class: Car

Returns the name of the car's class in a multicar session.

PATH = /Car/(CARIDENTIFIER)/ClassName

Overrides:

getClassName in class Car

Returns:

The name of the class in a Data container.

getColor

public Data getColor()

Description copied from class: Car

Returns the main color of the car as an RGB value.

PATH = /Car/(CARIDENTIFIER)/Color

Overrides:

getColor in class Car

Returns:

The color of the car in a Data container.

getColorNumber

public Data getColorNumber()

Description copied from class: Car

Returns the main color of the car number as an RGB value.

PATH = /Car/(CARIDENTIFIER)/ColorNumber

Overrides:

getColorNumber in class Car

Returns:

The color of the car number in a Data container.

getColorNumberBackground

public Data getColorNumberBackground()

Description copied from class: Car

Returns the main color of the car number's background as an RGB value.

PATH = /Car/(CARIDENTIFIER)/ColorNumberBackground

Overrides:

getColorNumberBackground in class Car

Returns:

The color of the car number's background in a Data container.

getColorNumberOutline

public Data getColorNumberOutline()

Description copied from class: Car

Returns the main color of the car number's outline as an RGB value.

PATH = /Car/(CARIDENTIFIER)/ColorNumberOutline

Overrides:

getColorNumberOutline in class Car

Returns:

The color of the car number's outline in a Data container.

getDescription

public Data getDescription()

Description copied from class: Car

Returns the printable description of the car.

PATH = /Car/(CARIDENTIFIER)/Description

Overrides:

getDescription in class Car

Returns:

The description of the car in a Data container.

getDiscontinuality

public Data getDiscontinuality()

Description copied from class: Car

Returns the number of times the car has blinked out.

PATH = /Car/(CARIDENTIFIER)/Discontinuality

Overrides:

getDiscontinuality in class Car

Returns:

The number of blinks in a Data container.

getDriverClubName

public Data getDriverClubName()

Description copied from class: Car

Returns the club name of the current driver of the car.

PATH = /Car/(CARIDENTIFIER)/ClubName

Overrides:

getDriverClubName in class Car

Returns:

The club name in a Data container.

getDriverDivisionName

public Data getDriverDivisionName()

Description copied from class: Car

Returns the division name of the current driver of the car.

PATH = /Car/(CARIDENTIFIER)/DriverDivisionName

Overrides:

getDriverDivisionName in class Car

Returns:

The division name in a Data container.

getDriverInitials

public Data getDriverInitials()

Description copied from class: Car

Returns the initials of the current driver of the car.

PATH = /Car/(CARIDENTIFIER)/DriverInitials

Overrides:

getDriverInitials in class Car

Returns:

The initials in a Data container.

getDriverLicenseColor

public Data getDriverLicenseColor()

Description copied from class: Car

Returns the license color of the current driver of the car. License colors are SIM specific, do not make an assumption that one color ranks higher than another. They are intended to be presented to the user as a background or foreground color of an object.

PATH = /Car/(CARIDENTIFIER)/DriverLicenseColor

Overrides:

getDriverLicenseColor in class Car

Returns:

The license color in a Data container.

getDriverLicenseColorText

public Data getDriverLicenseColorText()

Description copied from class: Car

Returns the text color that best overlays the license color of the current driver of the car when it is used as a background. License colors are SIM specific, do not make an assumption that one color ranks higher than another. They are intended to be presented to the user as a background or foreground color of an object.

PATH = /Car/(CARIDENTIFIER)/Driver/LicenseColorText

Overrides:

getDriverLicenseColorText in class Car

Returns:

The license color in a Data container.

getDriverName

public Data getDriverName(boolean allowMapping)

Description copied from class: Car

Returns the name of the current driver of the car.

PATH = /Car/(CARIDENTIFIER)/DriverName

Overrides:

getDriverName in class Car

Parameters:

allowMapping - true allows the user to map the name in settings to something else.

Returns:

The name in a Data container.

getDriverNameShort

public Data getDriverNameShort(boolean allowMapping)

Description copied from class: Car

Returns the name of the current driver of the car in a shortened format. The actual format is up to each SIM and there's no set length. It's just shorter than their whole name.

PATH = /Car/(CARIDENTIFIER)/DriverNameShort

Overrides:

getDriverNameShort in class Car

Parameters:

allowMapping - true allows the user to map the name in settings to something else.

Returns:

The drivers shortened name in a Data container.

getDriverRating

public Data getDriverRating()

Description copied from class: Car

Returns the rating of the current driver of the car. Each SIM can define how a rating should be formed, so do not assume it is number. Do not try to parse it to break it down, as a specific format is not guaranteed. The rating is simply meant to be displayed.

PATH = /Car/(CARIDENTIFIER)/DriverRating

Overrides:

getDriverRating in class Car

Returns:

The rating in a Data container.

getDriverRatingDelta

public Data getDriverRatingDelta()

Description copied from class: Car

Returns the change of rating of the current driver of the car as the race progresses. Each SIM can define how a rating should be formed, so do not assume it is number. Do not try to parse it to break it down, as a specific format is not guaranteed. The rating delta is simply meant to be displayed.

PATH = /Car/(CARIDENTIFIER)/DriverRatingDelta

Overrides:

getDriverRatingDelta in class Car

Returns:

The rating in a Data container.

getFuelLevelPerLap

public Data getFuelLevelPerLap(int lapsToAverage,
                               java.lang.String UOM)

Description copied from class: Car

Returns the amount of fuel being consumed per lap.

PATH = /Car/(CARIDENTIFIER)/FuelLevelPerLap/(LAPSTOAVERAGE)/(UOM)

Overrides:

getFuelLevelPerLap in class Car

Parameters:

lapsToAverage - (Optional) The number of previous non-caution laps to average. Zero indicates use the worst lap. Default 0.

UOM - (Optional) A unit of measure to return. Set to null or a blank string to use car's UOM.

Returns:

The number of laps in a Data container.

getFuelLevelNeeded

public Data getFuelLevelNeeded(int lapsToAverage,
                               double laps,
                               java.lang.String UOM)

Description copied from class: Car

Returns the amount of fuel you need to add to complete the number of laps specified. It calls Car.getFuelLevelToFinish(int, double, String), then subtracts what is in your fuel tank. The amount could be more than will fit in the fuel cell.

PATH = /Car/(CARIDENTIFIER)/FuelLevelNeeded/(LAPSTOAVERAGE)/(LAPS)/(UOM)

Overrides:

getFuelLevelNeeded in class Car

Parameters:

lapsToAverage - (Optional) The number of laps to average. This is passed to Car.getFuelLevelPerLap(int, java.lang.String). Default 0.

laps - (Optional) The number of laps to calculate for. Defaults to laps remaining in the race minus current lap percent completed.

UOM - (Optional) A unit of measure to return. Set to null or a blank string to use SIM's default UOM.

Returns:

The number of laps in a Data container.

getFuelLevelToFinish

public Data getFuelLevelToFinish(int lapsToAverage,
                                 double laps,
                                 java.lang.String UOM)

Description copied from class: Car

Returns the total amount of fuel needed to finish the race regardless of how much is in the fuel tank. If the number of laps is not specified and you are in a RACE session, it will use your own laps to go.

PATH = /Car/(CARIDENTIFIER)/FuelLevelToFinish/(LAPSTOAVERAGE)/(LAPS)/(UOM)

Overrides:

getFuelLevelToFinish in class Car

Parameters:

lapsToAverage - (Optional) The number of laps to average. This is passed to Car.getFuelLevelPerLap(int, java.lang.String). Default 0.

laps - (Optional) The number of laps to calculate for. Defaults to remaining minus percentage of current lap completed.

UOM - (Optional) A unit of measure to return. Set to null or a blank string to use Car's UOM.

Returns:

The number of laps in a Data container.

getHasAutomaticPitCommands

public Data getHasAutomaticPitCommands()

Automatic Pit Commands will not be enabled until a client calls this function to find out. The client should not call this, unless they want to control the SIM, because it enables them.

Overrides:

getHasAutomaticPitCommands in class Car

Returns:

true or false in a Data container.

getId

public Data getId()

Description copied from class: Car

Returns the numeric id of this car.

PATH = /Car/(CARIDENTIFIER)/Id

Overrides:

getId in class Car

Returns:

Id in a Data container.

getImageUrl

public Data getImageUrl()

Description copied from class: Car

Returns a URL to this car's image suitable for using in the "src" attribute of the "img" tag. The beginning of the URL will be the name of the SIM. You will have to replace this with the [protocol://]host[:port] of where to locate the image for the SIM.

Using the SIMRacingApps Server, you can prefix "/SIMRacingApps/" + getImageUrl().getString() and call the server. Same for HTML5/JavaScript clients, just assign to the "src" attribute of the "img" tag.

PATH = /Car/(CARIDENTIFIER)/ImageUrl

Overrides:

getImageUrl in class Car

Returns:

URL to image of this car

getIncidents

public Data getIncidents()

Description copied from class: Car

Returns the number of incidents for the driver of this car. Different SIMs may measure these in different units of measure. The default is "x".

PATH = /Car/(CARIDENTIFIER)/Incidents

Overrides:

getIncidents in class Car

Returns:

The number of incidents for the driver of this car in a Data container.

getIncidentsTeam

public Data getIncidentsTeam()

Description copied from class: Car

Returns the number of incidents for this car's team. If this is not a team session, it returns zero with the state set to OFF. Different SIMs may measure these in different units of measure. The default is "x".

PATH = /Car/(CARIDENTIFIER)/IncidentsTeam

Overrides:

getIncidentsTeam in class Car

Returns:

The number of incidents for this car's team in a Data container.

getIsBlackFlag

public Data getIsBlackFlag()

Description copied from class: Car

Returns true if the black flag has been waved for this car. This flag means come to the pits to serve a penality.

PATH = /Car/(CARIDENTIFIER)/IsBlackFlag

Overrides:

getIsBlackFlag in class Car

Returns:

true or false in a Data container.

getIsBlueFlag

public Data getIsBlueFlag()

Description copied from class: Car

Returns true if the blue flag has been waved for this car. This flag means move out of the racing grove to give way to the leaders.

PATH = /Car/(CARIDENTIFIER)/IsBlueFlag

Overrides:

getIsBlueFlag in class Car

Returns:

true or false in a Data container.

getIsDisqualifyFlag

public Data getIsDisqualifyFlag()

Description copied from class: Car

Returns true if the disqualify flag has been waved for this car. This means you must exist the race.

PATH = /Car/(CARIDENTIFIER)/IsDisqualifyFlag

Overrides:

getIsDisqualifyFlag in class Car

Returns:

true or false in a Data container.

getIsDriving

public Data getIsDriving()

Description copied from class: Car

Returns true if are driving this car. The car could be on the track, but you are not in it. In team sessions, it could be one of your teammates.

PATH = /Car/(CARIDENTIFIER)/IsDriving

Overrides:

getIsDriving in class Car

Returns:

true or false in a Data container.

getIsFixedSetup

public Data getIsFixedSetup()

Description copied from class: Car

Returns true if the car is in a fixed setup session.

PATH = /Car/(CARIDENTIFIER)/IsFixedSetup

Overrides:

getIsFixedSetup in class Car

Returns:

true or false in a Data container.

isME

public boolean isME()

Description copied from class: Car

A convenience function that returns true if the car is an instance of "ME".

Overrides:

isME in class Car

Returns:

true or false

getIsPitSpeedLimiter

public Data getIsPitSpeedLimiter()

Description copied from class: Car

Returns true if the car has the pit speed limiter on.

PATH = /Car/(CARIDENTIFIER)/IsPitSpeedLimiter

Overrides:

getIsPitSpeedLimiter in class Car

Returns:

true or false in a Data container.

getIsSpectator

public Data getIsSpectator()

Description copied from class: Car

Returns true if the car is a spectator.

PATH = /Car/(CARIDENTIFIER)/IsSpectator

Overrides:

getIsSpectator in class Car

Returns:

true or false in a Data container.

getIsPaceCar

public Data getIsPaceCar()

Description copied from class: Car

Returns true if the car is the pace car.

PATH = /Car/(CARIDENTIFIER)/IsPaceCar

Overrides:

getIsPaceCar in class Car

Returns:

true or false in a Data container.

getIsYellowFlag

public Data getIsYellowFlag()

Description copied from class: Car

Returns true if the yellow flag has been waved for this car. This is not a full course caution flag. It is for a local issue near this car.

PATH = /Car/(CARIDENTIFIER)/IsYellowFlag

Overrides:

getIsYellowFlag in class Car

Returns:

true or false in a Data container.

getLap

public Data getLap(java.lang.String ref,
                   int lapsToAverage)

Description copied from class: Car

Returns the lap based on the specified reference type. Subclasses should extract the validated reference value from Data to use in deciding the return value.

Supported Reference Types are: AVERAGE, AVERAGESINCEPITTING, BEST, CAUTION, COMPLETED, COMPLETEDPERCENT, CURRENT, LED, PITTED, QUALIFYING, SESSIONBEST, SESSIONLAST, SINCEPITTING

PATH = /Car/(CARIDENTIFIER)/Lap/(LAPTYPE)/(LAPSTOAVERAGE)

Overrides:

getLap in class Car

Parameters:

ref - (Optional) as defined by Car.LapType. Default CURRENT.

lapsToAverage - (Optional) as defined by Car.LapType. Default 9999.

Returns:

lap in a Data container.

getLapsToGo

public Data getLapsToGo()

Description copied from class: Car

Returns the number of laps this car has remaining. It includes the laps down. If a time bound session, the the number of laps remaining are adjusted based on an average lap time. If you want the number of laps remaining in the session, use the leaders laps to go.

PATH = /Car/(CARIDENTIFIER)/LapsToGo

Overrides:

getLapsToGo in class Car

Returns:

The number of laps remaining in a Data container.

getLapTime

public Data getLapTime(java.lang.String ref,
                       int lapsToAverage)

Description copied from class: Car

Returns the time of the lap based on the specified reference type. Subclasses should extract the validated reference value from Data to use in deciding the return value.

Supported Reference Types are: AVERAGE, AVERAGESINCEPITTING, BEST, CURRENT, FINISHLINE, QUALIFYING, RACESTART, SESSIONBEST, SESSIONLAST

PATH = /Car/(CARIDENTIFIER)/LapTime/(LAPTYPE)/(LAPSTOAVERAGE)

Overrides:

getLapTime in class Car

Parameters:

ref - (Optional) as defined by Car.LapType. Default CURRENT.

lapsToAverage - (Optional) as defined by Car.LapType. Default 9999.

Returns:

time in a Data container.

getLapTimeDelta

public Data getLapTimeDelta(java.lang.String ref)

Description copied from class: Car

Returns the time delta of the lap based on the specified reference type. Subclasses should extract the validated reference value from Data to use in deciding the return value.

Supported Reference Types are: BEST, OPTIMAL, SESSIONBEST, SESSIONLAST, SESSIONOPTIMAL

PATH = /Car/(CARIDENTIFIER)/LapTimeDelta/(LAPTYPE)

Overrides:

getLapTimeDelta in class Car

Parameters:

ref - (Optional) as defined by Car.LapType. Default CURRENT.

Returns:

time in a Data container.

getLapTimeDeltaReference

public Data getLapTimeDeltaReference(java.lang.String ref)

Description copied from class: Car

Returns the time delta reference of the lap based on the specified reference type. The reference is used to calculate the projected time of the current lap. Subclasses should extract the validated reference value from Data to use in deciding the return value.

Supported Reference Types are: BEST, OPTIMAL, SESSIONBEST, SESSIONLAST, SESSIONOPTIMAL

PATH = /Car/(CARIDENTIFIER)/LapTimeDeltaReference/(LAPTYPE)

Overrides:

getLapTimeDeltaReference in class Car

Parameters:

ref - as defined by Car.LapType. Default CURRENT.

Returns:

time in a Data container.

getLapTimeDeltaPercent

public Data getLapTimeDeltaPercent(java.lang.String ref)

Description copied from class: Car

Returns the time delta as a percentage of the lap based on the specified reference type. Subclasses should extract the validated reference value from Data to use in deciding the return value.

Supported Reference Types are: BEST, OPTIMAL, SESSIONBEST, SESSIONLAST, SESSIONOPTIMAL

PATH = /Car/(CARIDENTIFIER)/LapTimeDeltaPercent/(LAPTYPE)

Overrides:

getLapTimeDeltaPercent in class Car

Parameters:

ref - as defined by Car.LapType

Returns:

time in a Data container.

getLapTimes

public Data getLapTimes()

Description copied from class: Car

Returns the lap time of each lap in in an array The array is indexed as zero based. This means to get the time for lap 1, look at array[0].

PATH = /Car/(CARIDENTIFIER)/LapTimes

Overrides:

getLapTimes in class Car

Returns:

The lap times array in a Data container.

getLapInvalidFlags

public Data getLapInvalidFlags()

Description copied from class: Car

Returns the invalid status of each lap in in an array. false means good green flag lap, true means under yellow, or pitted. Mainly used to determine the good laps to use in averages. The array is indexed as zero based. This means to get the flag for lap 1, look at array[0].

PATH = /Car/(CARIDENTIFIER)/LapInvalidFlags

Overrides:

getLapInvalidFlags in class Car

Returns:

The valid flags array in a Data container.

getLatitude

public Data getLatitude(java.lang.String UOM)

iRacing only outputs this value in the IBT files for ME This code checks to see if it exists before returning it, otherwise it calls the base class.

Overrides:

getLatitude in class Car

Parameters:

UOM - (Optional) A unit of measure to return. Defaults to degrees.

Returns:

The Location of the car

getLatitudeAcceleration

public Data getLatitudeAcceleration(java.lang.String UOM)

Description copied from class: Car

Returns the Latitudinal Acceleration.

PATH = /Car/(CARIDENTIFIER)/LatitudeAcceration/(UOM)

Overrides:

getLatitudeAcceleration in class Car

Parameters:

UOM - (Optional) A unit of measure to return. Set to null or a blank string to use car's UOM.

Returns:

The latitudinal acceleration in a Data container.

getLongitudeAcceleration

public Data getLongitudeAcceleration(java.lang.String UOM)

Description copied from class: Car

Returns the Longitudinal Acceleration.

PATH = /Car/(CARIDENTIFIER)/LongitudeAcceration/(UOM)

Overrides:

getLongitudeAcceleration in class Car

Parameters:

UOM - (Optional) A unit of measure to return. Set to null or a blank string to use car's UOM.

Returns:

The longitudinal acceleration in a Data container.

getLongitude

public Data getLongitude(java.lang.String UOM)

iRacing only outputs this value in the IBT files for ME. This code checks to see if it exists before returning it, otherwise it calls the base class.

Overrides:

getLongitude in class Car

Parameters:

UOM - (Optional) A unit of measure to return. Defaults to degrees.

Returns:

The Location of the car

getMaxTires

public Data getMaxTires()

Description copied from class: Car

Returns the maximum number of tire sets for this session. It first checks to see if the DataPublisher.Post plugin is loaded and publishing. If so, it asked if the server has a max tires count. The SIM could override this and return a number if the SIM supports it as well. The SIM should check to see if the plugin returned a value first before overriding it.

PATH = /Car/(CARIDENTIFIER)/MaxTires 1.2

Overrides:

getMaxTires in class Car

Returns:

The maximum number of tire sets.

getMergePoint

public Data getMergePoint()

Description copied from class: Car

Returns the merge point as a percentage from the start/finish line.

PATH = /Car/(CARIDENTIFIER)/MergePoint

Overrides:

getMergePoint in class Car

Returns:

The merge point.

getMessages

public Data getMessages()

Description copied from class: Car

Returns a string of a semicolon separate list of messages that are currently active for this car. It is possible to have multiple messages. Each message will have a semicolon before and after it, even at the begin and end of the string. Possible message values are determined by Car.Message. You can display as is, or use it as an index to the the translation for a particular language.

For example: ";REPAIR;"

PATH = /Car/(CARIDENTIFIER)/Messages

Overrides:

getMessages in class Car

Returns:

A list of messages in a Data container.

getNumber

public Data getNumber()

Description copied from class: Car

Returns the number of the car. It can be up to 3 characters where 0,00,000 are considered unique values. Don't treat it as numeric.

PATH = /Car/(CARIDENTIFIER)/Number

Overrides:

getNumber in class Car

Returns:

The car number in a Data container.

getNumberRaw

public int getNumberRaw()

Returns the integer version of the car number to be used with camera commands.

Returns:

The raw car number as an integer

getNumberFont

public Data getNumberFont()

Description copied from class: Car

Returns the font of the car's number.

PATH = /Car/(CARIDENTIFIER)/NumberFont

Overrides:

getNumberFont in class Car

Returns:

The slant in a Data container.

getNumberSlant

public Data getNumberSlant()

Description copied from class: Car

Returns the slant of the car's number. Can be "normal","left","right","forward","backwards".

PATH = /Car/(CARIDENTIFIER)/NumberSlant

Overrides:

getNumberSlant in class Car

Returns:

The slant in a Data container.

getPitTime

public Data getPitTime()

Description copied from class: Car

Returns the amount of time the last pit stop took.

PATH = /Car/(CARIDENTIFIER)/PitTime

Overrides:

getPitTime in class Car

Returns:

The pit stop time in a Data container.

getPitTimes

public Data getPitTimes()

Description copied from class: Car

Returns the times this car pitted by lap.

PATH = /Car/(CARIDENTIFIER)/PitTimes

Overrides:

getPitTimes in class Car

Returns:

An array of times when the car pitted. Index by lap, zero based.

getPitLocation

public Data getPitLocation()

Description copied from class: Car

Returns the pit location as a percentage from the start/finish line.

PATH = /Car/(CARIDENTIFIER)/PitLocation

Overrides:

getPitLocation in class Car

Returns:

The pit location. State is OFF if not known.

getPosition

public Data getPosition()

Description copied from class: Car

Returns the current position based on all cars in the session. Positions start at 1, such that 1 is considered the leader.

PATH = /Car/(CARIDENTIFIER)/Position

Overrides:

getPosition in class Car

Returns:

The position in a Data container.

getPositionHighest

public Data getPositionHighest()

Description copied from class: Car

Returns the highest position in the current session. Positions start at 1, such that 1 is considered the leader.

PATH = /Car/(CARIDENTIFIER)/PositionHighest

Overrides:

getPositionHighest in class Car

Returns:

The position in a Data container.

getPositionLowest

public Data getPositionLowest()

Description copied from class: Car

Returns the lowest position in the current session. Positions start at 1, such that 1 is considered the leader.

PATH = /Car/(CARIDENTIFIER)/PositionLowest

Overrides:

getPositionLowest in class Car

Returns:

The position in a Data container.

getPositions

public Data getPositions()

Description copied from class: Car

Returns the position at the end of each lap in in an array Positions start at 1, such that 1 is considered the leader, but the array is indexed as zero based. This means to get the position for lap 1, look at array[0].

PATH = /Car/(CARIDENTIFIER)/Positions

Overrides:

getPositions in class Car

Returns:

The position in a Data container.

getPositionClass

public Data getPositionClass()

Description copied from class: Car

Returns the current position based on the class the car is in. Positions start at 1, such that 1 is considered the leader.

PATH = /Car/(CARIDENTIFIER)/PositionClass

Overrides:

getPositionClass in class Car

Returns:

The position in a Data container.

getPositionHighestClass

public Data getPositionHighestClass()

Description copied from class: Car

Returns the highest position in the current session for your class. Positions start at 1, such that 1 is considered the leader.

PATH = /Car/(CARIDENTIFIER)/PositionHighestClass

Overrides:

getPositionHighestClass in class Car

Returns:

The position in a Data container.

getPositionLowestClass

public Data getPositionLowestClass()

Description copied from class: Car

Returns the lowest position in the current session for your class. Positions start at 1, such that 1 is considered the leader.

PATH = /Car/(CARIDENTIFIER)/PositionLowestClass

Overrides:

getPositionLowestClass in class Car

Returns:

The position in a Data container.

getPositionsClass

public Data getPositionsClass()

Description copied from class: Car

Returns the class position at the end of each lap in in an array Positions start at 1, such that 1 is considered the leader, but the array is indexed as zero based. This means to get the position for lap 1, look at array[0].

PATH = /Car/(CARIDENTIFIER)/PositionsClass

Overrides:

getPositionsClass in class Car

Returns:

The class position in a Data container.

getPositionQualifying

public Data getPositionQualifying()

Description copied from class: Car

Returns the qualifying position based on other cars in this session. Positions start at 1, such that 1 is considered the leader.

PATH = /Car/(CARIDENTIFIER)/PositionQualifying

Overrides:

getPositionQualifying in class Car

Returns:

The qualifying position in a Data container.

getPositionClassQualifying

public Data getPositionClassQualifying()

Description copied from class: Car

Returns the qualifying position based on other cars in this session for your class. Positions start at 1, such that 1 is considered the leader.

PATH = /Car/(CARIDENTIFIER)/PositionClassQualifying

Overrides:

getPositionClassQualifying in class Car

Returns:

The qualifying position in your class in a Data container.

getPushToPassRemaining

public Data getPushToPassRemaining()

Description copied from class: Car

Returns the number of seconds remaining on the push to pass counter.

PATH = /Car/(CARIDENTIFIER)/PushToPassRemaining

Overrides:

getPushToPassRemaining in class Car

Returns:

The number of seconds in a Data container.

getIsPushToPassActive

public Data getIsPushToPassActive()

Description copied from class: Car

Returns the push to pass active status.

PATH = /Car/(CARIDENTIFIER)/IsPushToPassStatus

Overrides:

getIsPushToPassActive in class Car

Returns:

The true if push to pass is active in a Data container.

getRadioChannel

public Data getRadioChannel()

Description copied from class: Car

Returns the radio channel number that this car is currently transmitting on.

PATH = /Car/(CARIDENTIFIER)/RadioChannel

Overrides:

getRadioChannel in class Car

Returns:

The radio channel number in a Data container.

getRadioChannelName

public Data getRadioChannelName()

Description copied from class: Car

Returns the radio channel name that this car is currently transmitting on.

PATH = /Car/(CARIDENTIFIER)/RadioChannelName

Overrides:

getRadioChannelName in class Car

Returns:

The radio channel in a Data container.

getSpotterMessage

public Data getSpotterMessage()

Description copied from class: Car

Returns the current spotter message. Messages supported are.

OFF

Spotter is not talking

CLEAR

no cars around us

CARLEFT

there is a car to our left

CARRIGHT

there is a car to our right

CARLEFTRIGHT

there are cars on each side

CARSLEFT

there are two or more cars to our left

CARSRIGHT

there are two or more cars to our right

PATH = /Car/(CARIDENTIFIER)/SpotterMessage

Overrides:

getSpotterMessage in class Car

Returns:

The spotter message in a Data container.

getStartFinishTimes

public Data getStartFinishTimes()

Description copied from class: Car

Returns the times this car crossed the start/finish by lap.

PATH = /Car/(CARIDENTIFIER)/StartFinishTimes

Overrides:

getStartFinishTimes in class Car

Returns:

An array of times when the car passed the start/finish. Index by lap, zero based.

getStatus

public Data getStatus()

Description copied from class: Car

Returns the current status of the car as defined by Car.Status

PATH = /Car/(CARIDENTIFIER)/Status

Overrides:

getStatus in class Car

Returns:

The current status in a Data container.

getWarnings

public Data getWarnings()

Description copied from class: Car

Returns a semicolon(;) separated list of engine warnings. The string will contain a leading and trailing semicolon, such that, a contains ";REVLIMITER;" can return true if found in the string. You can also split the string on semicolons and ignore the blank ones. Here is a list of all the possible values.

• ENGINESTALLED
• FUELLEVELCRITICAL
• FUELLEVELWARNING
• FUELPRESSURECRITICAL
• FUELPRESSUREWARNING
• OILLEVELCRITICAL
• OILLEVELWARNING
• OILPRESSURECRITICAL
• OILPRESSUREWARNING
• OILTEMPCRITICAL
• OILTEMPWARNING
• PITSPEEDLIMITER
• REVLIMITER
• REPAIRSREQUIRED
• VOLTAGECRITICAL
• VOLTAGEWARNING
• WATERLEVELCRITICAL
• WATERLEVELWARNING
• WATERPRESSURECRITICAL
• WATERPRESSUREWARNING
• WATERTEMPCRITICAL
• WATERTEMPWARNING

PATH = /Car/(CARIDENTIFIER)/Warnings

Overrides:

getWarnings in class Car

Returns:

A list of warnings in a Data container.

getDivisionName

public Data getDivisionName()

getDriverLicLevel

public Data getDriverLicLevel()

getDriverLicSubLevel

public Data getDriverLicSubLevel()

getFuelLevelAtStartFinish

public Data getFuelLevelAtStartFinish(java.lang.String UOM)

Description copied from class: Car

Returns the fuel level the last time the car crossed the start/finish line.

PATH = /Car/(CARIDENTIFIER)/FuelLevelAtStartFinish/(UOM)

Overrides:

getFuelLevelAtStartFinish in class Car

Parameters:

UOM - (Optional) A unit of measure to return. Set to null or a blank string to use SIM's default UOM. Default blank to use car's UOM.

Returns:

The fuel level in a Data container.

getRepairTime

public Data getRepairTime()

Description copied from class: Car

Returns the amount of time required to repair the car.

PATH = /Car/(CARIDENTIFIER)/RepairTime

Overrides:

getRepairTime in class Car

Returns:

The repair time in a Data container.

getRepairTimeOptional

public Data getRepairTimeOptional()

Description copied from class: Car

Returns the amount of time that is optional to repair the car.

PATH = /Car/(CARIDENTIFIER)/RepairTimeOptional

Overrides:

getRepairTimeOptional in class Car

Returns:

The optional repair time in a Data container.

getTeamName

public Data getTeamName()

Description copied from class: Car

Returns the team name if the current session has teams.

PATH = /Car/(CARIDENTIFIER)/TeamName

Overrides:

getTeamName in class Car

Returns:

The team name. Blank if session does not have teams

isPaceCar

public boolean isPaceCar()

isValid

public boolean isValid()

Description copied from class: Car

Returns true if the car instance is actually in the session as defined by the SIM.

Overrides:

isValid in class Car

Returns:

true or false

isValid

public boolean isValid(int id,
                       int driversIdx)

setAdminFlag

public Data setAdminFlag(boolean onOffFlag)

Description copied from class: Car

Sets this car/driver's admin status. This command is SIM specific and requires special privileges to succeed.

PATH = /Car/(CARIDENTIFIER)/setAdminFlag/(Y/N)

Overrides:

setAdminFlag in class Car

Parameters:

onOffFlag - The admin status.

Returns:

The string sent to SIM in a Data container.

setBlackFlag

public Data setBlackFlag(int quantity,
                         java.lang.String uom)

Description copied from class: Car

Sets a black flag for this car/driver. Can be number of seconds or laps. Defaults to zero seconds, stop and go. If seconds is negative, the SIM should issue a drive through. This command is SIM specific and requires special privileges to succeed.

PATH = /Car/(CARIDENTIFIER)/setBlackFlag/(SECONDS/LAPS)/(UOM)

Overrides:

setBlackFlag in class Car

Parameters:

quantity - The number of seconds or laps based on the UOM. Default to zero(0).

uom - The unit of measure of the quantity. "s" for seconds, "lap" for laps. Defaults to "s".

Returns:

The string sent to SIM in a Data container.

setChat

public Data setChat(java.lang.String text)

Description copied from class: Car

Sends the text string as a chat message to this driver. Each SIM must override this and provide this functionality.

PATH = /Car/(CARIDENTIFIER)/setChat/(TEXT)

Overrides:

setChat in class Car

Parameters:

text - The string to send to the chat window

Returns:

The text string sent to the driver in a Data container.

setChatFlag

public Data setChatFlag(boolean onOffFlag)

Description copied from class: Car

Sets this car/driver's chat status. This command is SIM specific and requires special privileges to succeed.

PATH = /Car/(CARIDENTIFIER)/setChatFlag/(Y/N)

Overrides:

setChatFlag in class Car

Parameters:

onOffFlag - The chat status.

Returns:

The string sent to SIM in a Data container.

setClearPenaltiesFlag

public Data setClearPenaltiesFlag()

Description copied from class: Car

Clear all penalties, DQ, EOL, Black Flags. This command is SIM specific and requires special privileges to succeed.

PATH = /Car/(CARIDENTIFIER)/setClearPenaltiesFlag

Overrides:

setClearPenaltiesFlag in class Car

Returns:

The string sent to SIM in a Data container.

setDisqualifyFlag

public Data setDisqualifyFlag()

Description copied from class: Car

Disqualify this car but leave them in the session. This command is SIM specific and requires special privileges to succeed.

PATH = /Car/(CARIDENTIFIER)/setDisqualifyFlag

Overrides:

setDisqualifyFlag in class Car

Returns:

The string sent to SIM in a Data container.

setEndOfLineFlag

public Data setEndOfLineFlag()

Description copied from class: Car

Send this car to the end of the pacing line. This command is SIM specific and requires special privileges to succeed.

PATH = /Car/(CARIDENTIFIER)/setEndOfLineFlag

Overrides:

setEndOfLineFlag in class Car

Returns:

The string sent to SIM in a Data container.

setReloadPaint

public Data setReloadPaint()

Description copied from class: Car

Tell the SIM to reload the paint files for this car. If SIM does not support this capability, then the NOTAVAILABLE state will be returned.

PATH = /Session/setReloadPaint

Overrides:

setReloadPaint in class Car

Returns:

The string sent to SIM in a Data container.

setRemoveFlag

public Data setRemoveFlag()

Description copied from class: Car

Remove the user from the session. This command is SIM specific and requires special privileges to succeed.

PATH = /Car/(CARIDENDIFIER)/setRemoveFlag

Overrides:

setRemoveFlag in class Car

Returns:

The string sent to SIM in a Data container.

setWaveAroundFlag

public Data setWaveAroundFlag()

Description copied from class: Car

Wave this car around the pace car. This command is SIM specific and requires special privileges to succeed.

PATH = /Car/(CARIDENTIFIER)/setWaveAroundFlag

Overrides:

setWaveAroundFlag in class Car

Returns:

The requested setting in a Data container.

onDataVersionChange

public boolean onDataVersionChange()