com.SIMRacingApps.SIMPlugins.iRacing

Class iRacingTrack

java.lang.Object

com.SIMRacingApps.Track

com.SIMRacingApps.SIMPlugins.iRacing.iRacingTrack

public class iRacingTrack
extends Track

Since:

1.0

Author:

Jeffrey Gilliam

Copyright:

Copyright (C) 2015 - 2024 Jeffrey Gilliam

License:

Apache License 2.0

Nested Class Summary

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

Track.Category, Track.SectorType, Track.TrackLocation, Track.Type

Constructor Summary

Constructors

Constructor and Description
iRacingTrack(iRacingSIMPlugin SIMPlugin)

Method Summary

Modifier and Type	Method and Description
Data	getCategory() Returns the track category as defined by Track.Category
Data	getCity() Returns the city of where the track is as reported by the SIM SIMPlugin.
Data	getConfiguration() Returns the track configuration as reported by the SIM SIMPlugin.
Data	getCountry() Returns the country code of where the track is as reported by the SIM SIMPlugin.
Data	getDescription() Returns the description of the track.
Data	getLength(java.lang.String UOM) Returns the length of the track using the unit of measure the distance of this track is normally reported in.
Data	getName() Returns the name of the track as reported by the SIM.
Data	getPitSpeedLimit(java.lang.String UOM) Returns the Pit Speed Limit for this session as reported by the SIM SIMPlugin.
Data	getSectors(java.lang.String sectorType, java.lang.String UOM) Returns an array of sector starting and ending points.
Data	getTemp(java.lang.String UOM) Returns the current temperature of the track.
Data	getType() Returns the track's type as defined by Track.Type
Data	getWeatherFogLevel() Returns the fog level as a percentage.
Data	getWeatherRelativeHumidity() Returns the relative humidity as a percentage.
Data	getWeatherSkies() Returns the condition of the skies, like "Partly Cloudy".
Data	getWeatherTemp(java.lang.String UOM) Returns the current ambient temperature at the track.
Data	getWeatherWindDirection(java.lang.String UOM) Returns the wind direction, where East is zero degrees at 3 o'clock.
Data	getWeatherWindSpeed(java.lang.String UOM) Returns the wind speed.

Methods inherited from class com.SIMRacingApps.Track

_getMergePoint, _maxPercentage, getBearing, getBearing, getBearing, getBearing, getBearing, getFinishLineRotation, getFinishLineRotation, getImage, getImage, getLatitude, getLatitude, getLatitude, getLatitude, getLatitude, getLength, getLongitude, getLongitude, getLongitude, getLongitude, getLongitude, getMap, getNorth, getNorth, getPath, getPath, getPath, getPitSpeedLimit, getResolution, getResolution, getSectors, getSectors, getTemp, getTimeZone, getWeatherTemp, getWeatherWindDirection, getWeatherWindSpeed, reload

Methods inherited from class java.lang.Object

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

Constructor Detail

iRacingTrack

public iRacingTrack(iRacingSIMPlugin SIMPlugin)

Method Detail

getCategory

public Data getCategory()

Description copied from class: Track

Returns the track category as defined by Track.Category

PATH = /Track/Category

Overrides:

getCategory in class Track

Returns:

The category in a Data container.

getCity

public Data getCity()

Description copied from class: Track

Returns the city of where the track is as reported by the SIM SIMPlugin.

PATH = /Track/City

Overrides:

getCity in class Track

Returns:

The city in a Data container.

getConfiguration

public Data getConfiguration()

Description copied from class: Track

Returns the track configuration as reported by the SIM SIMPlugin.

PATH = /Track/Configuration

Overrides:

getConfiguration in class Track

Returns:

The configuration in a Data container.

getCountry

public Data getCountry()

Description copied from class: Track

Returns the country code of where the track is as reported by the SIM SIMPlugin.

PATH = /Track/Country

Overrides:

getCountry in class Track

Returns:

The country code in a Data container.

getDescription

public Data getDescription()

Description copied from class: Track

Returns the description of the track. This is a value that can be displayed to the user.

PATH = /Track/Description

Overrides:

getDescription in class Track

Returns:

The description of the track in a Data container.

getLength

public Data getLength(java.lang.String UOM)

Description copied from class: Track

Returns the length of the track using the unit of measure the distance of this track is normally reported in. This is defined in the JSON file. If not defined in the JSON file, then it will default to "mile" in the United States and "km" everywhere else. You can also pass in a UOM as an optional argument.

PATH = /Track/Length/(UOM)

Overrides:

getLength in class Track

Parameters:

UOM - (Optional), The UOM to return the track length in. Default to track's UOM, which is based on the country it's in.

Returns:

The length of the track in a Data container.

getName

public Data getName()

Description copied from class: Track

Returns the name of the track as reported by the SIM. This should include a specific configuration. Clients should make no assumptions about the format of this name. Use it to display only.

For example: atlanta_qualoval

PATH = /Track/Name

Overrides:

getName in class Track

Returns:

The name of the track in a Data container.

getPitSpeedLimit

public Data getPitSpeedLimit(java.lang.String UOM)

Description copied from class: Track

Returns the Pit Speed Limit for this session as reported by the SIM SIMPlugin.

PATH = /Track/PitSpeedLimit/(UOM)

Overrides:

getPitSpeedLimit in class Track

Parameters:

UOM - (Optional) The unit of measure to return the speed limit in, default to the track's UOM.

Returns:

The Pit Speed Limit

getSectors

public Data getSectors(java.lang.String sectorType,
                       java.lang.String UOM)

Description copied from class: Track

Returns an array of sector starting and ending points. If SectorType is PERCENTAGE, then with the index starting at zero, the even numbered indexes are the starting points and are inclusive. The odd numbered indexes are the ending points and are exclusive. The number of sectors can be derived by dividing the number of array entries by 2. If SectorType is COORDINATES, then with the index starting at zero, indexes are as follows, (0=startingLat, 1=startingLon, 2=endingLat, 3=endingLon). This pattern repeats throughout the array. The number of sectors can be derived by dividing the number of array entries by 4. If there are no sectors defined, an empty array is returned with a length of zero.

PATH = /Track/Sectors/(SECTORTYPE)/(UOM)

Overrides:

getSectors in class Track

Parameters:

sectorType - (optional) Indicates the type of the values being returned. Valid values are Track.SectorType, PERCENTAGE, COORDINATES. Defaults PERCENTAGE.

UOM - (optional) Specifies the unit of measure to return. %, RAD, DEG. Default is % and DEG.

Returns:

An array of sectors in a Data container.

getTemp

public Data getTemp(java.lang.String UOM)

Description copied from class: Track

Returns the current temperature of the track. The location of this temperature is SIM specific. Should not be used to understand where grip is best on the track. In most cases you will only want to display it.

PATH = /Track/Temp/(UOM)

Overrides:

getTemp in class Track

Parameters:

UOM - (Optional) The unit of measure to convert the temperature in, default to track's UOM.

Returns:

The temperature in a Data container.

getType

public Data getType()

Description copied from class: Track

Returns the track's type as defined by Track.Type

PATH = /Track/Type

Overrides:

getType in class Track

Returns:

The type in a Data container.

getWeatherFogLevel

public Data getWeatherFogLevel()

Description copied from class: Track

Returns the fog level as a percentage.

PATH = /Track/WeatherFogLevel

Overrides:

getWeatherFogLevel in class Track

Returns:

The fog level in a Data container.

getWeatherRelativeHumidity

public Data getWeatherRelativeHumidity()

Description copied from class: Track

Returns the relative humidity as a percentage.

PATH = /Track/WeatherRelativeHumidity

Overrides:

getWeatherRelativeHumidity in class Track

Returns:

The relative humidity in a Data container.

getWeatherSkies

public Data getWeatherSkies()

Description copied from class: Track

Returns the condition of the skies, like "Partly Cloudy".

PATH = /Track/WeatherSkies

Overrides:

getWeatherSkies in class Track

Returns:

The sky condition in a Data container.

getWeatherTemp

public Data getWeatherTemp(java.lang.String UOM)

Description copied from class: Track

Returns the current ambient temperature at the track.

PATH = /Track/WeatherTemp/(UOM)

Overrides:

getWeatherTemp in class Track

Parameters:

UOM - (Optional) The unit of measure to convert the temperature in, default to track's UOM.

Returns:

The temperature in a Data container.

getWeatherWindDirection

public Data getWeatherWindDirection(java.lang.String UOM)

Description copied from class: Track

Returns the wind direction, where East is zero degrees at 3 o'clock. If the UOM is "TEXT", then returns one of the following: N, NE, W, SW, S, SE, E, NE.

PATH = /Track/WeatherWindDirection/(UOM)

Overrides:

getWeatherWindDirection in class Track

Parameters:

UOM - (Optional) The unit of measure to return the wind direction in, defaults to "deg".

Returns:

The wind direction in a Data container.

getWeatherWindSpeed

public Data getWeatherWindSpeed(java.lang.String UOM)

Description copied from class: Track

Returns the wind speed.

PATH = /Track/WeatherWindSpeed/(UOM)

Overrides:

getWeatherWindSpeed in class Track

Parameters:

UOM - (Optional) The unit of measure to return the wind speed in, defaults to track's UOM for Pit Road Speed.

Returns:

The wind speed in a Data container.