Car

java.lang.Object
- com.SIMRacingApps.Car

Direct Known Subclasses:

iRacingCar
```
public class Car
extends java.lang.Object
```
Provides all information about a car. Each car will have an ID assigned to it by the SIM. Each SIM has to subclass Car and provide the SIM specific data for all methods that it has information for.

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`	`Car.LapType` Defines and validates an enumerated String class of the different types of laps that can be returned by methods that take a LapType as an argument.
`static class`	`Car.Message` This class enumerates the various messages that a SIM can raise that applies to a specific car.
`static class`	`Car.SpotterMessages` Defines the messages the spotter can say.
`static class`	`Car.Status` Defines an enumerated String class for where the car is.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String[] Tires

Fields
Modifier and Type	Field and Description
`static java.lang.String[]`	`Tires`

Constructor Summary

Constructors
Constructor and Description
`Car(SIMPlugin SIMPlugin)` Class constructor
`Car(SIMPlugin SIMPlugin, int id, java.lang.String name, java.lang.String carPath)` Class constructor to be used by the SIM specific version to establish the "id", "name" and "track" of the car.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`_dumpGauges()`
`Data`	`_getDataPublisherMaxTires()`
`java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>>`	`_getDefaultGauges()` Returns a map to the default gauges found in the Car.json file.
`Gauge`	`_getGauge(java.lang.String gaugeType)` Returns an instance of the Gauge Type specified for this car.
`java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>>`	`_getSIMGauges()` Returns a map to the default gauges found in the SIM's .json file.
`void`	`_postInitialization()` Each SIM that subclasses Car, should call this at the end of the constructor to allow global functionality to be added to the car.
`Data`	`getBearing()`
`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`	`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`	`getDriverName()`
`Data`	`getDriverName(boolean allowMapping)` Returns the name of the current driver of the car.
`Data`	`getDriverName(java.lang.String allowName)`
`Data`	`getDriverNameShort()`
`Data`	`getDriverNameShort(boolean allowMapping)` Returns the name of the current driver of the car in a shortened format.
`Data`	`getDriverNameShort(java.lang.String allowName)`
`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`	`getFuelLaps()`
`Data`	`getFuelLaps(int lapsToAverage)` Returns the number of laps you can run on the existing fuel in the tank.
`Data`	`getFuelLaps(java.lang.String sLapsToAverage)`
`Data`	`getFuelLapsMaximum()`
`Data`	`getFuelLapsMaximum(int lapsToAverage)` Returns the maximum number of laps you can go on a full fuel tank.
`Data`	`getFuelLapsMaximum(java.lang.String lapsToAverage)`
`Data`	`getFuelLevelAtStartFinish()`
`Data`	`getFuelLevelAtStartFinish(java.lang.String UOM)` Returns the fuel level the last time the car crossed the start/finish line.
`Data`	`getFuelLevelNeeded()`
`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`	`getFuelLevelNeeded(java.lang.String lapsToAverage)`
`Data`	`getFuelLevelNeeded(java.lang.String lapsToAverage, java.lang.String laps)`
`Data`	`getFuelLevelNeeded(java.lang.String lapsToAverage, java.lang.String laps, java.lang.String UOM)`
`Data`	`getFuelLevelPerLap()`
`Data`	`getFuelLevelPerLap(int lapsToAverage, java.lang.String UOM)` Returns the amount of fuel being consumed per lap.
`Data`	`getFuelLevelPerLap(java.lang.String lapsToAverage)`
`Data`	`getFuelLevelPerLap(java.lang.String lapsToAverage, java.lang.String UOM)`
`Data`	`getFuelLevelToFinish()`
`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`	`getFuelLevelToFinish(java.lang.String lapsToAverage)`
`Data`	`getFuelLevelToFinish(java.lang.String lapsToAverage, java.lang.String lapsRemaining)`
`Data`	`getFuelLevelToFinish(java.lang.String lapsToAverage, java.lang.String lapsRemaining, java.lang.String UOM)`
`Data`	`getGauge()`
`Data`	`getGauge(java.lang.String gaugeType)` Returns a Data object of the Gauge Type specified for this car as a json string.
`Data`	`getHasAutomaticPitCommands()` Returns if the SIM supports sending pit commands remotely.
`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`	`getIsBelowMinimumSpeed()` This returns (true) if the car is below the minimum speed.
`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`	`getIsEqual()`
`Data`	`getIsEqual(java.lang.String carIdentifier)` Returns true if the 2 cars refer to the same car
`Data`	`getIsFixedSetup()` Returns true if the car is in a fixed setup session.
`Data`	`getIsOverSpeedLimit()` Returns true if the car is over the specified speed limit.
`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`	`getIsUnderSpeedLimit()` Returns true if the car is under the specified speed limit.
`Data`	`getIsYellowFlag()` Returns true if the yellow flag has been waved for this car.
`Data`	`getLap()`
`Data`	`getLap(java.lang.String lapType)`
`Data`	`getLap(java.lang.String lapType, int lapsToAverage)` Returns the lap based on the specified reference type.
`Data`	`getLap(java.lang.String lapType, java.lang.String lapsToAverage)`
`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()`
`Data`	`getLapTime(java.lang.String lapType)`
`Data`	`getLapTime(java.lang.String lapType, int lapsToAverage)` Returns the time of the lap based on the specified reference type.
`Data`	`getLapTime(java.lang.String lapType, java.lang.String lapsToAverage)`
`Data`	`getLapTimeDelta()`
`Data`	`getLapTimeDelta(java.lang.String lapType)` Returns the time delta of the lap based on the specified reference type.
`Data`	`getLapTimeDeltaPercent()`
`Data`	`getLapTimeDeltaPercent(java.lang.String lapType)` Returns the time delta as a percentage of the lap based on the specified reference type.
`Data`	`getLapTimeDeltaReference()`
`Data`	`getLapTimeDeltaReference(java.lang.String lapType)` Returns the time delta reference of the lap based on the specified reference type.
`Data`	`getLapTimeProjected()` Estimates what the current lap time will be based on your current speed against your previous lap time.
`Data`	`getLapTimes()` Returns the lap time of each lap in in an array The array is indexed as zero based.
`Data`	`getLatitude()`
`Data`	`getLatitude(java.lang.String UOM)` Returns the Latitude location of the car.
`Data`	`getLatitudeAcceleration()`
`Data`	`getLatitudeAcceleration(java.lang.String UOM)` Returns the Latitudinal Acceleration.
`Data`	`getLongitude()`
`Data`	`getLongitude(java.lang.String UOM)` Returns the Longitude location of the car.
`Data`	`getLongitudeAcceleration()`
`Data`	`getLongitudeAcceleration(java.lang.String UOM)` Returns the Longitudinal Acceleration.
`Data`	`getManufacturerLogo()` Returns the filename of the manufacturer's logo for this car.
`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`	`getMergePointLatitude()` Returns the merge point latitude.
`Data`	`getMergePointLongitude()` Returns the merge point longitude.
`Data`	`getMessages()` Returns a string of a semicolon separate list of messages that are currently active for this car.
`Data`	`getName()` Returns a name of the car as reported by the SIM.
`Data`	`getNumber()` Returns the number of the car.
`Data`	`getNumberFont()` Returns the font of the car's number.
`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`	`getPitSpeedLimit()`
`Data`	`getPitSpeedLimit(java.lang.String UOM)` Returns the pit road speed limit in the car's unit of measure.
`Data`	`getPitStopsRemaining()`
`Data`	`getPitStopsRemaining(int lapstoaverage)` Returns the number of pit stops remaining based on fuel mileage.
`Data`	`getPitStopsRemaining(java.lang.String laps)`
`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`	`getPositionClassDelta()` Returns the number of positions changed for your class.
`Data`	`getPositionClassQualifying()` Returns the qualifying position based on other cars in this session for your class.
`Data`	`getPositionDelta()` Returns the number of positions changed.
`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`	`getRPMPitRoadSpeed()` Returns the RPM for pit road speed while in 2nd gear
`Data`	`getSector()` Returns the sector number this car is currently in.
`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`	`getStatusClass()` Returns the status of the car and the car identifier as one string.
`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`	`isValid()` Returns true if the car instance is actually in the session as defined by the SIM.
`Data`	`setAdminFlag(boolean onOffFlag)` Sets this car/driver's admin status.
`Data`	`setAdminFlag(java.lang.String onOffFlag)`
`Data`	`setBlackFlag()`
`Data`	`setBlackFlag(int quantity, java.lang.String uom)` Sets a black flag for this car/driver.
`Data`	`setBlackFlag(java.lang.String quantity)`
`Data`	`setBlackFlag(java.lang.String quantity, java.lang.String uom)`
`Data`	`setCamera()`
`Data`	`setCamera(java.lang.String cameraName)` Changes the camera to focus on this car.
`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`	`setChatFlag(java.lang.String onOffFlag)`
`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`	`setRPMPitRoadSpeed(double rpm)` Sets the pit road speed as the RPMs in 2nd gear.
`Data`	`setWaveAroundFlag()` Wave this car around the pace car.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - Tires
```
public static java.lang.String[] Tires
```
- Constructor Detail
  - Car
```
public Car(SIMPlugin SIMPlugin)
```
    Class constructor
    
    Parameters:
    
    SIMPlugin - An instance of SIMPlugin.
  - Car
```
public Car(SIMPlugin SIMPlugin,
           int id,
           java.lang.String name,
           java.lang.String carPath)
```
    Class constructor to be used by the SIM specific version to establish the "id", "name" and "track" of the car.
    
    Parameters:
    
    SIMPlugin - An instance of SIMPlugin.
    
    id - A numeric value used by the SIM to identify a car
    
    name - The name of the car as returned by the SIM
    
    carPath - The relative path to the car's .json file provided by the SIM. Allow settings to remap it.
- Method Detail
  - isME
```
public boolean isME()
```
    A convenience function that returns true if the car is an instance of "ME".
    
    Returns:
    
    true or false
  - isValid
```
public boolean isValid()
```
    Returns true if the car instance is actually in the session as defined by the SIM.
    
    Returns:
    
    true or false
  - getBearing
```
public Data getBearing(java.lang.String UOM)
```
    Returns the bearing of the car.
    PATH = /Car/(CARIDENTIFIER)/Bearing/(UOM)
    
    Parameters:
    
    UOM - (Optional) A unit of measure to return. Defaults to degrees.
    
    Returns:
    
    The bearing of the car where 0 is 3 o'clock.
  - getBearing
```
public Data getBearing()
```
  - getCautions
```
public Data getCautions()
```
    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
    
    Returns:
    
    The number of cautions in a Data container.
  - getClassColor
```
public Data getClassColor()
```
    Returns the color of the car's class if in a multi-class session
    PATH = /Car/(CARIDENTIFIER)/ClassColor
    
    Returns:
    
    The name of the class in a Data container.
  - getClassName
```
public Data getClassName()
```
    Returns the name of the car's class in a multicar session.
    PATH = /Car/(CARIDENTIFIER)/ClassName
    
    Returns:
    
    The name of the class in a Data container.
  - getColor
```
public Data getColor()
```
    Returns the main color of the car as an RGB value.
    PATH = /Car/(CARIDENTIFIER)/Color
    
    Returns:
    
    The color of the car in a Data container.
  - getColorNumber
```
public Data getColorNumber()
```
    Returns the main color of the car number as an RGB value.
    PATH = /Car/(CARIDENTIFIER)/ColorNumber
    
    Returns:
    
    The color of the car number in a Data container.
  - getColorNumberBackground
```
public Data getColorNumberBackground()
```
    Returns the main color of the car number's background as an RGB value.
    PATH = /Car/(CARIDENTIFIER)/ColorNumberBackground
    
    Returns:
    
    The color of the car number's background in a Data container.
  - getColorNumberOutline
```
public Data getColorNumberOutline()
```
    Returns the main color of the car number's outline as an RGB value.
    PATH = /Car/(CARIDENTIFIER)/ColorNumberOutline
    
    Returns:
    
    The color of the car number's outline in a Data container.
  - getDescription
```
public Data getDescription()
```
    Returns the printable description of the car.
    PATH = /Car/(CARIDENTIFIER)/Description
    
    Returns:
    
    The description of the car in a Data container.
  - getDiscontinuality
```
public Data getDiscontinuality()
```
    Returns the number of times the car has blinked out.
    PATH = /Car/(CARIDENTIFIER)/Discontinuality
    
    Returns:
    
    The number of blinks in a Data container.
  - getDriverClubName
```
public Data getDriverClubName()
```
    Returns the club name of the current driver of the car.
    PATH = /Car/(CARIDENTIFIER)/ClubName
    
    Returns:
    
    The club name in a Data container.
  - getDriverDivisionName
```
public Data getDriverDivisionName()
```
    Returns the division name of the current driver of the car.
    PATH = /Car/(CARIDENTIFIER)/DriverDivisionName
    
    Returns:
    
    The division name in a Data container.
  - getDriverInitials
```
public Data getDriverInitials()
```
    Returns the initials of the current driver of the car.
    PATH = /Car/(CARIDENTIFIER)/DriverInitials
    
    Returns:
    
    The initials in a Data container.
  - getDriverLicenseColor
```
public Data getDriverLicenseColor()
```
    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
    
    Returns:
    
    The license color in a Data container.
  - getDriverLicenseColorText
```
public 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. 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
    
    Returns:
    
    The license color in a Data container.
  - getDriverName
```
public Data getDriverName(boolean allowMapping)
```
    Returns the name of the current driver of the car.
    PATH = /Car/(CARIDENTIFIER)/DriverName
    
    Parameters:
    
    allowMapping - true allows the user to map the name in settings to something else.
    
    Returns:
    
    The name in a Data container.
  - getDriverName
```
public Data getDriverName(java.lang.String allowName)
```
  - getDriverName
```
public Data getDriverName()
```
  - getDriverNameShort
```
public Data getDriverNameShort(boolean allowMapping)
```
    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
    
    Parameters:
    
    allowMapping - true allows the user to map the name in settings to something else.
    
    Returns:
    
    The drivers shortened name in a Data container.
  - getDriverNameShort
```
public Data getDriverNameShort(java.lang.String allowName)
```
  - getDriverNameShort
```
public Data getDriverNameShort()
```
  - getDriverRating
```
public Data getDriverRating()
```
    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
    
    Returns:
    
    The rating in a Data container.
  - getDriverRatingDelta
```
public Data getDriverRatingDelta()
```
    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
    
    Returns:
    
    The rating in a Data container.
  - getFuelLaps
```
public Data getFuelLaps(int lapsToAverage)
```
    Returns the number of laps you can run on the existing fuel in the tank.
    PATH = /Car/(CARIDENTIFIER)/FuelLaps/(LAPSTOAVERAGE)
    
    Parameters:
    
    lapsToAverage - (Optional) The number of laps to average. This is passed to getFuelLevelPerLap(int, java.lang.String). Default 0.
    
    Returns:
    
    The number of laps in a Data container.
  - getFuelLaps
```
public Data getFuelLaps(java.lang.String sLapsToAverage)
```
  - getFuelLaps
```
public Data getFuelLaps()
```
  - getFuelLapsMaximum
```
public Data getFuelLapsMaximum(int lapsToAverage)
```
    Returns the maximum number of laps you can go on a full fuel tank.
    PATH = /Car/(CARIDENTIFIER)/FuelLapsMaximum/(LAPSTOAVERAGE)
    
    Parameters:
    
    lapsToAverage - (Optional) The number of laps to average. This is passed to getFuelLevelPerLap(int, java.lang.String). Default 0.
    
    Returns:
    
    The number of laps in a Data container.
  - getFuelLapsMaximum
```
public Data getFuelLapsMaximum(java.lang.String lapsToAverage)
```
  - getFuelLapsMaximum
```
public Data getFuelLapsMaximum()
```
  - getFuelLevelAtStartFinish
```
public Data getFuelLevelAtStartFinish(java.lang.String UOM)
```
    Returns the fuel level the last time the car crossed the start/finish line.
    PATH = /Car/(CARIDENTIFIER)/FuelLevelAtStartFinish/(UOM)
    
    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.
  - getFuelLevelAtStartFinish
```
public Data getFuelLevelAtStartFinish()
```
  - getFuelLevelToFinish
```
public 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. 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)
    
    Parameters:
    
    lapsToAverage - (Optional) The number of laps to average. This is passed to 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.
  - getFuelLevelToFinish
```
public Data getFuelLevelToFinish(java.lang.String lapsToAverage,
                                 java.lang.String lapsRemaining,
                                 java.lang.String UOM)
```
  - getFuelLevelToFinish
```
public Data getFuelLevelToFinish(java.lang.String lapsToAverage,
                                 java.lang.String lapsRemaining)
```
  - getFuelLevelToFinish
```
public Data getFuelLevelToFinish(java.lang.String lapsToAverage)
```
  - getFuelLevelToFinish
```
public Data getFuelLevelToFinish()
```
  - getFuelLevelNeeded
```
public 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. It calls 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)
    
    Parameters:
    
    lapsToAverage - (Optional) The number of laps to average. This is passed to 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.
  - getFuelLevelNeeded
```
public Data getFuelLevelNeeded(java.lang.String lapsToAverage,
                               java.lang.String laps,
                               java.lang.String UOM)
```
  - getFuelLevelNeeded
```
public Data getFuelLevelNeeded(java.lang.String lapsToAverage,
                               java.lang.String laps)
```
  - getFuelLevelNeeded
```
public Data getFuelLevelNeeded(java.lang.String lapsToAverage)
```
  - getFuelLevelNeeded
```
public Data getFuelLevelNeeded()
```
  - getFuelLevelPerLap
```
public Data getFuelLevelPerLap(int lapsToAverage,
                               java.lang.String UOM)
```
    Returns the amount of fuel being consumed per lap.
    PATH = /Car/(CARIDENTIFIER)/FuelLevelPerLap/(LAPSTOAVERAGE)/(UOM)
    
    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.
  - getFuelLevelPerLap
```
public Data getFuelLevelPerLap(java.lang.String lapsToAverage,
                               java.lang.String UOM)
```
  - getFuelLevelPerLap
```
public Data getFuelLevelPerLap(java.lang.String lapsToAverage)
```
  - getFuelLevelPerLap
```
public Data getFuelLevelPerLap()
```
  - getLatitudeAcceleration
```
public Data getLatitudeAcceleration(java.lang.String UOM)
```
    Returns the Latitudinal Acceleration.
    PATH = /Car/(CARIDENTIFIER)/LatitudeAcceration/(UOM)
    
    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.
    
    Since:
    
    1.10
  - getLatitudeAcceleration
```
public Data getLatitudeAcceleration()
```
  - getLongitudeAcceleration
```
public Data getLongitudeAcceleration(java.lang.String UOM)
```
    Returns the Longitudinal Acceleration.
    PATH = /Car/(CARIDENTIFIER)/LongitudeAcceration/(UOM)
    
    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.
    
    Since:
    
    1.10
  - getLongitudeAcceleration
```
public Data getLongitudeAcceleration()
```
  - _getGauge
```
public Gauge _getGauge(java.lang.String gaugeType)
```
    Returns an instance of the Gauge Type specified for this car. If the car does not contain a gauge of this type, it returns a generic gauge.
    
    Parameters:
    
    gaugeType - One of the enumerated types defined by Gauge.Type
    
    Returns:
    
    A Gauge defined by Gauge
  - getGauge
```
public Data getGauge(java.lang.String gaugeType)
```
    Returns a Data object of the Gauge Type specified for this car as a json string. If the car does not contain a gauge of this type, it returns a generic gauge.
    PATH = /Car/(CARIDENTIFIER)/Gauge/(GAUGETYPE)
    
    Parameters:
    
    gaugeType - (Optional) One of the enumerated types defined by Gauge.Type, default All.
    
    Returns:
    
    A Gauge defined by Gauge
  - getGauge
```
public Data getGauge()
```
  - getHasAutomaticPitCommands
```
public Data getHasAutomaticPitCommands()
```
    Returns if the SIM supports sending pit commands remotely. Each SIM should override this method and return a Y, if it does. The default is N.
    PATH = /Car/(CARIDENTIFIER)/HasAutomaticPitCommands
    
    Returns:
    
    true or false in a Data container.
  - getId
```
public Data getId()
```
    Returns the numeric id of this car.
    PATH = /Car/(CARIDENTIFIER)/Id
    
    Returns:
    
    Id in a Data container.
  - getImageUrl
```
public Data getImageUrl()
```
    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
    
    Returns:
    
    URL to image of this car
  - getIncidents
```
public Data getIncidents()
```
    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
    
    Returns:
    
    The number of incidents for the driver of this car in a Data container.
  - getIncidentsTeam
```
public Data getIncidentsTeam()
```
    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
    
    Returns:
    
    The number of incidents for this car's team in a Data container.
  - getIsBelowMinimumSpeed
```
public Data getIsBelowMinimumSpeed()
```
    This returns (true) if the car is below the minimum speed. The following variables can be set via the arguments if you do not agree with these defaults.
```
     -minimum-speed-laps         = 3
     -minimum-speed-laps-leader  = 3
     -minimum-speed-percentage   = 110
 
```
    The minimum speed uses lap times and is calculated by averaging the last (minimum-speed-laps-leader) green flag laps of the leader, multiplied by (minimum-speed-percentage). For example: if the average is 50 seconds, the minimum would be 55 seconds. After the car has completed at least the (minimum-speed-laps) since the last pit stop, and they are still on the track, each of the previous (minimum-speed-laps) are checked. If any of them are below the maximum lap time, then false is returned to indicate the car is okay. So, if all of them are above the maximum lap time, true is returned to indicate the car is too slow. NASCAR's minimum is the Poll Speed or whatever is appropriate at that point in the race, multiplied by 110%. So, to simulate "whatever is appropriate" automatically, the last (minimum-speed-laps-leader) laps of the leader is used.
    PATH = /Car/(CARIDENTIFIER)/IsBelowMinimumSpeed
    Returns:
    
    true or false in a Data container.
  - getIsBlackFlag
```
public Data getIsBlackFlag()
```
    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
    
    Returns:
    
    true or false in a Data container.
  - getIsBlueFlag
```
public Data getIsBlueFlag()
```
    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
    
    Returns:
    
    true or false in a Data container.
  - getIsDisqualifyFlag
```
public Data getIsDisqualifyFlag()
```
    Returns true if the disqualify flag has been waved for this car. This means you must exist the race.
    PATH = /Car/(CARIDENTIFIER)/IsDisqualifyFlag
    
    Returns:
    
    true or false in a Data container.
  - getIsDriving
```
public Data getIsDriving()
```
    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
    
    Returns:
    
    true or false in a Data container.
  - getIsEqual
```
public Data getIsEqual(java.lang.String carIdentifier)
```
    Returns true if the 2 cars refer to the same car
    PATH = /Car/(CARIDENTIFIER)/IsEqual/(CARIDENTIFIER)
    
    Parameters:
    
    carIdentifier - (Optional) Car as defined by Session.getCar(String). Default REFERENCE.
    
    Returns:
    
    true or false in a Data container.
  - getIsEqual
```
public Data getIsEqual()
```
  - getIsFixedSetup
```
public Data getIsFixedSetup()
```
    Returns true if the car is in a fixed setup session.
    PATH = /Car/(CARIDENTIFIER)/IsFixedSetup
    
    Returns:
    
    true or false in a Data container.
  - getIsOverSpeedLimit
```
public Data getIsOverSpeedLimit()
```
    Returns true if the car is over the specified speed limit.
    PATH = /Car/(CARIDENTIFIER)/IsOverSpeedLimit
    
    Returns:
    
    true or false in a Data container.
    
    Data.getState(java.lang.String)
    
    OVERLIMIT
    Set if you will only get an End Of Line penalty for speeding
    
    WAYOVERLIMIT
    Set if you will get a black flag for excessive speeding and have to serve a stop and go under green
  - getIsPitSpeedLimiter
```
public Data getIsPitSpeedLimiter()
```
    Returns true if the car has the pit speed limiter on.
    PATH = /Car/(CARIDENTIFIER)/IsPitSpeedLimiter
    
    Returns:
    
    true or false in a Data container.
  - getIsPaceCar
```
public Data getIsPaceCar()
```
    Returns true if the car is the pace car.
    PATH = /Car/(CARIDENTIFIER)/IsPaceCar
    
    Returns:
    
    true or false in a Data container.
  - getIsSpectator
```
public Data getIsSpectator()
```
    Returns true if the car is a spectator.
    PATH = /Car/(CARIDENTIFIER)/IsSpectator
    
    Returns:
    
    true or false in a Data container.
  - getIsUnderSpeedLimit
```
public Data getIsUnderSpeedLimit()
```
    Returns true if the car is under the specified speed limit.
    PATH = /Car/(CARIDENTIFIER)/IsUnderSpeedLimit
    
    Returns:
    
    true or false in a Data container.
    
    Data.getState(java.lang.String)
    
    APPROACHINGLIMIT
    Set if you just below the speed limit
  - getIsYellowFlag
```
public Data getIsYellowFlag()
```
    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
    
    Returns:
    
    true or false in a Data container.
  - getLap
```
public Data getLap(java.lang.String lapType,
                   int lapsToAverage)
```
    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)
    
    Parameters:
    
    lapType - (Optional) as defined by Car.LapType. Default CURRENT.
    
    lapsToAverage - (Optional) as defined by Car.LapType. Default 9999.
    
    Returns:
    
    lap in a Data container.
  - getLap
```
public Data getLap(java.lang.String lapType,
                   java.lang.String lapsToAverage)
```
  - getLap
```
public Data getLap(java.lang.String lapType)
```
  - getLap
```
public Data getLap()
```
  - getLapsToGo
```
public Data getLapsToGo()
```
    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
    
    Returns:
    
    The number of laps remaining in a Data container.
  - getLapTime
```
public Data getLapTime(java.lang.String lapType,
                       int lapsToAverage)
```
    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)
    
    Parameters:
    
    lapType - (Optional) as defined by Car.LapType. Default CURRENT.
    
    lapsToAverage - (Optional) as defined by Car.LapType. Default 9999.
    
    Returns:
    
    time in a Data container.
  - getLapTime
```
public Data getLapTime(java.lang.String lapType,
                       java.lang.String lapsToAverage)
```
  - getLapTime
```
public Data getLapTime(java.lang.String lapType)
```
  - getLapTime
```
public Data getLapTime()
```
  - getLapTimeDelta
```
public Data getLapTimeDelta(java.lang.String lapType)
```
    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)
    
    Parameters:
    
    lapType - (Optional) as defined by Car.LapType. Default CURRENT.
    
    Returns:
    
    time in a Data container.
  - getLapTimeDelta
```
public Data getLapTimeDelta()
```
  - getLapTimeDeltaPercent
```
public Data getLapTimeDeltaPercent(java.lang.String lapType)
```
    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)
    
    Parameters:
    
    lapType - as defined by Car.LapType
    
    Returns:
    
    time in a Data container.
  - getLapTimeDeltaPercent
```
public Data getLapTimeDeltaPercent()
```
  - getLapTimeDeltaReference
```
public Data getLapTimeDeltaReference(java.lang.String lapType)
```
    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)
    
    Parameters:
    
    lapType - as defined by Car.LapType. Default CURRENT.
    
    Returns:
    
    time in a Data container.
  - getLapTimeDeltaReference
```
public Data getLapTimeDeltaReference()
```
  - getLapTimeProjected
```
public Data getLapTimeProjected()
```
    Estimates what the current lap time will be based on your current speed against your previous lap time.
    PATH = /Car/(CARIDENTIFIER)/LapTimeProjected
    
    Returns:
    
    The Lap Time Estimate in a Data container.
  - getLapTimes
```
public Data getLapTimes()
```
    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
    
    Returns:
    
    The lap times array in a Data container.
  - getLapInvalidFlags
```
public Data getLapInvalidFlags()
```
    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
    
    Returns:
    
    The valid flags array in a Data container.
  - getLatitude
```
public Data getLatitude(java.lang.String UOM)
```
    Returns the Latitude location of the car.
    PATH = /Car/(CARIDENTIFIER)/Latitude/(UOM)
    
    Parameters:
    
    UOM - (Optional) A unit of measure to return. Defaults to degrees.
    
    Returns:
    
    The Location of the car
  - getLatitude
```
public Data getLatitude()
```
  - getLongitude
```
public Data getLongitude(java.lang.String UOM)
```
    Returns the Longitude location of the car.
    PATH = /Car/(CARIDENTIFIER)/Longitude/(UOM)
    
    Parameters:
    
    UOM - (Optional) A unit of measure to return. Defaults to degrees.
    
    Returns:
    
    The Location of the car
  - getLongitude
```
public Data getLongitude()
```
  - getManufacturerLogo
```
public Data getManufacturerLogo()
```
    Returns the filename of the manufacturer's logo for this car. The filename will be the complete relative path such that it can be found in the classpath.
    PATH = /Car/(CARIDENTIFIER)/ManufacturerLogo
    
    Returns:
    
    The filename of the manufacturer's logo.
  - _getDataPublisherMaxTires
```
public Data _getDataPublisherMaxTires()
```
  - getMaxTires
```
public Data getMaxTires()
```
    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
    
    Returns:
    
    The maximum number of tire sets.
    
    Since:
    
    1.2
  - getMergePoint
```
public Data getMergePoint()
```
    Returns the merge point as a percentage from the start/finish line.
    PATH = /Car/(CARIDENTIFIER)/MergePoint
    
    Returns:
    
    The merge point.
  - getMergePointLatitude
```
public Data getMergePointLatitude()
```
    Returns the merge point latitude.
    PATH = /Car/(CARIDENTIFIER)/MergePointLatitude
    
    Returns:
    
    The merge point latitude.
  - getMergePointLongitude
```
public Data getMergePointLongitude()
```
    Returns the merge point longitude.
    PATH = /Car/(CARIDENTIFIER)/MergePointLongitude
    
    Returns:
    
    The merge point longitude.
  - getMessages
```
public Data getMessages()
```
    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
    
    Returns:
    
    A list of messages in a Data container.
  - getName
```
public Data getName()
```
    Returns a name of the car as reported by the SIM.
    PATH = /Car/(CARIDENTIFIER)/Name
    
    Returns:
    
    The name of the car in a Data container.
  - getNumber
```
public Data getNumber()
```
    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
    
    Returns:
    
    The car number in a Data container.
  - getNumberFont
```
public Data getNumberFont()
```
    Returns the font of the car's number.
    PATH = /Car/(CARIDENTIFIER)/NumberFont
    
    Returns:
    
    The slant in a Data container.
  - getNumberSlant
```
public Data getNumberSlant()
```
    Returns the slant of the car's number. Can be "normal","left","right","forward","backwards".
    PATH = /Car/(CARIDENTIFIER)/NumberSlant
    
    Returns:
    
    The slant in a Data container.
  - getPitLocation
```
public Data getPitLocation()
```
    Returns the pit location as a percentage from the start/finish line.
    PATH = /Car/(CARIDENTIFIER)/PitLocation
    
    Returns:
    
    The pit location. State is OFF if not known.
  - getPitSpeedLimit
```
public Data getPitSpeedLimit(java.lang.String UOM)
```
    Returns the pit road speed limit in the car's unit of measure.
    PATH = /Car/(CARIDENTIFIER)/PitSpeedLimit/(UOM)
    
    Parameters:
    
    UOM - (Optional) The unit of measure to return the result in. Default is the same UOM as the speedometer.
    
    Returns:
    
    The pit road speed limit.
  - getPitSpeedLimit
```
public Data getPitSpeedLimit()
```
  - getPitStopsRemaining
```
public Data getPitStopsRemaining(int lapstoaverage)
```
    Returns the number of pit stops remaining based on fuel mileage. It takes into consideration what you are currently have setup to add when you pit.
    PATH = /Car/(CARIDENTIFIER)/PitStopsRemaining/{LAPSTOAVERAGE}
    
    Parameters:
    
    lapstoaverage - (Optional) The number of laps to average to get the fuel mileage. Defaults to 0, your worst lap.
    
    Returns:
    
    The number of pit stops remaining in a Data container.
  - getPitStopsRemaining
```
public Data getPitStopsRemaining(java.lang.String laps)
```
  - getPitStopsRemaining
```
public Data getPitStopsRemaining()
```
  - getPitTime
```
public Data getPitTime()
```
    Returns the amount of time the last pit stop took.
    PATH = /Car/(CARIDENTIFIER)/PitTime
    
    Returns:
    
    The pit stop time in a Data container.
  - getPitTimes
```
public Data getPitTimes()
```
    Returns the times this car pitted by lap.
    PATH = /Car/(CARIDENTIFIER)/PitTimes
    
    Returns:
    
    An array of times when the car pitted. Index by lap, zero based.
  - getPosition
```
public Data getPosition()
```
    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
    
    Returns:
    
    The position in a Data container.
  - getPositionLowest
```
public Data getPositionLowest()
```
    Returns the lowest position in the current session. Positions start at 1, such that 1 is considered the leader.
    PATH = /Car/(CARIDENTIFIER)/PositionLowest
    
    Returns:
    
    The position in a Data container.
  - getPositionHighest
```
public Data getPositionHighest()
```
    Returns the highest position in the current session. Positions start at 1, such that 1 is considered the leader.
    PATH = /Car/(CARIDENTIFIER)/PositionHighest
    
    Returns:
    
    The position in a Data container.
  - getPositionDelta
```
public Data getPositionDelta()
```
    Returns the number of positions changed. Positions start at 1, such that 1 is considered the leader.
    PATH = /Car/(CARIDENTIFIER)/PositionDelta
    
    Returns:
    
    The position delta in a Data container.
  - getPositions
```
public 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. This means to get the position for lap 1, look at array[0].
    PATH = /Car/(CARIDENTIFIER)/Positions
    
    Returns:
    
    The position in a Data container.
  - getPositionsClass
```
public 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. This means to get the position for lap 1, look at array[0].
    PATH = /Car/(CARIDENTIFIER)/PositionsClass
    
    Returns:
    
    The class position in a Data container.
  - getPositionClass
```
public Data getPositionClass()
```
    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
    
    Returns:
    
    The position in a Data container.
  - getPositionLowestClass
```
public Data getPositionLowestClass()
```
    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
    
    Returns:
    
    The position in a Data container.
  - getPositionHighestClass
```
public Data getPositionHighestClass()
```
    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
    
    Returns:
    
    The position in a Data container.
  - getPositionClassDelta
```
public Data getPositionClassDelta()
```
    Returns the number of positions changed for your class. Positions start at 1, such that 1 is considered the leader.
    PATH = /Car/(CARIDENTIFIER)/PositionClassDelta
    
    Returns:
    
    The position delta of your class in a Data container.
  - getPositionQualifying
```
public Data getPositionQualifying()
```
    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
    
    Returns:
    
    The qualifying position in a Data container.
  - getPositionClassQualifying
```
public Data getPositionClassQualifying()
```
    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
    
    Returns:
    
    The qualifying position in your class in a Data container.
  - getPushToPassRemaining
```
public Data getPushToPassRemaining()
```
    Returns the number of seconds remaining on the push to pass counter.
    PATH = /Car/(CARIDENTIFIER)/PushToPassRemaining
    
    Returns:
    
    The number of seconds in a Data container.
  - getIsPushToPassActive
```
public Data getIsPushToPassActive()
```
    Returns the push to pass active status.
    PATH = /Car/(CARIDENTIFIER)/IsPushToPassStatus
    
    Returns:
    
    The true if push to pass is active in a Data container.
  - getRadioChannel
```
public Data getRadioChannel()
```
    Returns the radio channel number that this car is currently transmitting on.
    PATH = /Car/(CARIDENTIFIER)/RadioChannel
    
    Returns:
    
    The radio channel number in a Data container.
  - getRadioChannelName
```
public Data getRadioChannelName()
```
    Returns the radio channel name that this car is currently transmitting on.
    PATH = /Car/(CARIDENTIFIER)/RadioChannelName
    
    Returns:
    
    The radio channel in a Data container.
  - getRepairTime
```
public Data getRepairTime()
```
    Returns the amount of time required to repair the car.
    PATH = /Car/(CARIDENTIFIER)/RepairTime
    
    Returns:
    
    The repair time in a Data container.
  - getRepairTimeOptional
```
public Data getRepairTimeOptional()
```
    Returns the amount of time that is optional to repair the car.
    PATH = /Car/(CARIDENTIFIER)/RepairTimeOptional
    
    Returns:
    
    The optional repair time in a Data container.
  - getRPMPitRoadSpeed
```
public Data getRPMPitRoadSpeed()
```
    Returns the RPM for pit road speed while in 2nd gear
    PATH = /Car/(CARIDENTIFIER)/RPMPitRoadSpeed
    
    Returns:
    
    The RPM in a Data container.
  - getSector
```
public Data getSector()
```
    Returns the sector number this car is currently in. Returns zero(0) if car is not on the track, else the sector number starting with 1.
    PATH = /Car/(CARIDENTIFIER)/Sector
    
    Returns:
    
    The sector number in a Data container.
  - getSpotterMessage
```
public Data getSpotterMessage()
```
    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
    
    Returns:
    
    The spotter message in a Data container.
  - getStartFinishTimes
```
public Data getStartFinishTimes()
```
    Returns the times this car crossed the start/finish by lap.
    PATH = /Car/(CARIDENTIFIER)/StartFinishTimes
    
    Returns:
    
    An array of times when the car passed the start/finish. Index by lap, zero based.
  - getTeamName
```
public Data getTeamName()
```
    Returns the team name if the current session has teams.
    PATH = /Car/(CARIDENTIFIER)/TeamName
    
    Returns:
    
    The team name. Blank if session does not have teams
  - setAdminFlag
```
public Data setAdminFlag(boolean onOffFlag)
```
    Sets this car/driver's admin status. This command is SIM specific and requires special privileges to succeed.
    PATH = /Car/(CARIDENTIFIER)/setAdminFlag/(Y/N)
    
    Parameters:
    
    onOffFlag - The admin status.
    
    Returns:
    
    The string sent to SIM in a Data container.
  - setAdminFlag
```
public Data setAdminFlag(java.lang.String onOffFlag)
```
  - setBlackFlag
```
public Data setBlackFlag(int quantity,
                         java.lang.String uom)
```
    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)
    
    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.
  - setBlackFlag
```
public Data setBlackFlag(java.lang.String quantity,
                         java.lang.String uom)
```
  - setBlackFlag
```
public Data setBlackFlag(java.lang.String quantity)
```
  - setBlackFlag
```
public Data setBlackFlag()
```
  - setCamera
```
public Data setCamera(java.lang.String cameraName)
```
    Changes the camera to focus on this car. This is very SIM specific. Some cameras can do this, others cannot. The name of the group and camera is also very SIM specific. Some SIM limit the camera you can choose based on if you are driving or spectating or watch a replay. So, if the SIM doesn't allow the change, then this function will not really know. Therefore, there is not an error condition.
    PATH = /Car/(CARIDENTIFIER)/setCamera/CameraName
    
    Parameters:
    
    cameraName - (Optional) The name of the camera. Default to current camera.
    
    Returns:
    
    The group/camera name in a Data container.
  - setCamera
```
public Data setCamera()
```
  - setChat
```
public Data setChat(java.lang.String text)
```
    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)
    
    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)
```
    Sets this car/driver's chat status. This command is SIM specific and requires special privileges to succeed.
    PATH = /Car/(CARIDENTIFIER)/setChatFlag/(Y/N)
    
    Parameters:
    
    onOffFlag - The chat status.
    
    Returns:
    
    The string sent to SIM in a Data container.
  - setChatFlag
```
public Data setChatFlag(java.lang.String onOffFlag)
```
  - setReloadPaint
```
public Data setReloadPaint()
```
    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
    
    Returns:
    
    The string sent to SIM in a Data container.
  - setDisqualifyFlag
```
public Data setDisqualifyFlag()
```
    Disqualify this car but leave them in the session. This command is SIM specific and requires special privileges to succeed.
    PATH = /Car/(CARIDENTIFIER)/setDisqualifyFlag
    
    Returns:
    
    The string sent to SIM in a Data container.
  - setEndOfLineFlag
```
public Data setEndOfLineFlag()
```
    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
    
    Returns:
    
    The string sent to SIM in a Data container.
  - setClearPenaltiesFlag
```
public Data setClearPenaltiesFlag()
```
    Clear all penalties, DQ, EOL, Black Flags. This command is SIM specific and requires special privileges to succeed.
    PATH = /Car/(CARIDENTIFIER)/setClearPenaltiesFlag
    
    Returns:
    
    The string sent to SIM in a Data container.
  - setRemoveFlag
```
public Data setRemoveFlag()
```
    Remove the user from the session. This command is SIM specific and requires special privileges to succeed.
    PATH = /Car/(CARIDENDIFIER)/setRemoveFlag
    
    Returns:
    
    The string sent to SIM in a Data container.
  - setWaveAroundFlag
```
public Data setWaveAroundFlag()
```
    Wave this car around the pace car. This command is SIM specific and requires special privileges to succeed.
    PATH = /Car/(CARIDENTIFIER)/setWaveAroundFlag
    
    Returns:
    
    The requested setting in a Data container.
  - setRPMPitRoadSpeed
```
public Data setRPMPitRoadSpeed(double rpm)
```
    Sets the pit road speed as the RPMs in 2nd gear. Calculates the states as a percentage of that number. Designed to be called internally by the SIM code. But, I suppose it could be called externally by a client simulating a real Tachometer where they push a button while following the pace car at pit road speed.
    PATH = /Car/(CARIDENTIFIER)/setRPMPitRoadSpeed/(RPM)
    
    Parameters:
    
    rpm - The RPMs that is pit road speed.
    
    Returns:
    
    The RPM in a Data container.
  - getStatus
```
public Data getStatus()
```
    Returns the current status of the car as defined by Car.Status
    PATH = /Car/(CARIDENTIFIER)/Status
    
    Returns:
    
    The current status in a Data container.
  - getStatusClass
```
public Data getStatusClass()
```
    Returns the status of the car and the car identifier as one string.
    PATH = /Car/(CARIDENTIFIER)/StatusClass
    
    Returns:
    
    status + "-" + identifier in a Data container.
  - getWarnings
```
public Data getWarnings()
```
    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
    Returns:
    
    A list of warnings in a Data container.
  - _getDefaultGauges
```
public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> _getDefaultGauges()
```
    Returns a map to the default gauges found in the Car.json file.
    
    Returns:
    
    A map of the gauges or null if not found
  - _getSIMGauges
```
public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> _getSIMGauges()
```
    Returns a map to the default gauges found in the SIM's .json file.
    
    Returns:
    
    A map of the gauges or null if not found
  - _dumpGauges
```
public void _dumpGauges()
```
  - _postInitialization
```
public void _postInitialization()
```
    Each SIM that subclasses Car, should call this at the end of the constructor to allow global functionality to be added to the car. One, update the shift states from the settings so users can override them.

Class Car

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Tires

Constructor Detail

Car

Car

Method Detail

isME

isValid

getBearing

getBearing

getCautions

getClassColor

getClassName

getColor

getColorNumber

getColorNumberBackground

getColorNumberOutline

getDescription

getDiscontinuality

getDriverClubName

getDriverDivisionName

getDriverInitials

getDriverLicenseColor

getDriverLicenseColorText

getDriverName

getDriverName

getDriverName

getDriverNameShort

getDriverNameShort

getDriverNameShort

getDriverRating

getDriverRatingDelta

getFuelLaps

getFuelLaps

getFuelLaps

getFuelLapsMaximum

getFuelLapsMaximum

getFuelLapsMaximum

getFuelLevelAtStartFinish

getFuelLevelAtStartFinish

getFuelLevelToFinish

getFuelLevelToFinish

getFuelLevelToFinish

getFuelLevelToFinish

getFuelLevelToFinish

getFuelLevelNeeded

getFuelLevelNeeded

getFuelLevelNeeded

getFuelLevelNeeded

getFuelLevelNeeded

getFuelLevelPerLap

getFuelLevelPerLap

getFuelLevelPerLap

getFuelLevelPerLap

getLatitudeAcceleration

getLatitudeAcceleration

getLongitudeAcceleration

getLongitudeAcceleration

_getGauge

getGauge

getGauge

getHasAutomaticPitCommands

getId

getImageUrl

getIncidents

getIncidentsTeam

getIsBelowMinimumSpeed

getIsBlackFlag

getIsBlueFlag

getIsDisqualifyFlag

getIsDriving

getIsEqual

getIsEqual

getIsFixedSetup