Package com.SIMRacingApps

This package is the root level package of com.SIMRacingapps.

See: Description

Interface Summary

Interface	Description
SIMPlugin.Callback	This interface is used to call back to your implementation as data is received.

Class Summary

Class	Description
Car	Provides all information about a car.
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.
Car.Message	This class enumerates the various messages that a SIM can raise that applies to a specific car.
Car.SpotterMessages	Defines the messages the spotter can say.
Car.Status	Defines an enumerated String class for where the car is.
Data	A container for all values returned from all Simulators.
Data.State	Enumerates the States that are available, standard.
Gauge	The Gauge class is used to monitor anything on the car that has a value, or has a value that can be set on the next pit stop.
Gauge.Type	This defines all the possible gauge types.
Server	This class defines the static main() method used to start the internal server.
Session	The class defines access to session level data.
Session.CarIdentifiers	This class enumerates the various car identifiers.
Session.Message	This class enumerates the various messages that a SIM can raise that applies to all cars.
Session.RestartMethod	This class enumerates the values return by Session.getRestart() DOUBLEFILE SINGLEFILE
Session.Status	This class enumerates the values return by Session.getStatus() UNKNOWN ENGINES_STARTED GREEN CAUTION RED FINISHED
Session.Type	This class enumerates the values returned by Session.getType() UNKNOWN OPEN_QUALIFY LONE_QUALIFY OFFLINE OFFLINE_TESTING PRACTICE RACE
SIMPlugin	The SIMPlugin Class defines a generic interface for retrieving SIM data.
SIMPluginAWTEventDispatcher	This class is used by a Java AWT application to send data events to registered listeners.
TeamSpeak	This class implements the interface to the TeamSpeak Application.
Track	This class contains information about a track.
Track.Category	An enumeration of the track category returned by the SIM.
Track.SectorType	An enumeration of the track sector types returned by the SIM.
Track.TrackLocation	An enumeration of the track locations used by the SIM.
Track.Type	An enumeration of the track types returned by the SIM.
Windows	This class defines wrappers to all of the calls to the Windows API.
Windows.Handle	Defines a wrapper for a HANDLE to hide the Windows definition details
Windows.MsgId	Defines a wrapper for the MsgId to hide Windows definition details.
Windows.Pointer	Defines a wrapper for a Pointer to hide the JNA definition details
Windows.Robot	The Windows.Robot class is a subclass of the java.awt.Robot class.

Enum Summary

Enum	Description
Data.Type	Defines the Type the Value is

Exception Summary

Exception	Description
SIMPlugin.SIMPluginException	This class returns the exception message thrown by the SIMPlugin Class

Package com.SIMRacingApps Description

This package is the root level package of com.SIMRacingapps. It defines all of the SIM API level classes and methods. It also defines several servlets that are loaded into a J2EE server like Apache Tomcat. These servlets provide a Web Server interface to the SIM data.

com.SIMRacingApps.Connector
The base class of all SIM connectors. You do not instantiate this class directly. Instead, you call the static factor method com.SIMRacingApps.Connector#createConnector(String) and pass in the name of the SIM you want it to connect to. Supported SIMs are; iRacing.

The connector instance is the owner of the Session instance. Access to that instance is obtained through com.SIMRacingApps.Connector#getSession()

Session
The base class of all SIM sessions. Each SIM's connector should instantiate a SIM specific version of this class
Track
The base class of all SIM tracks. Each SIM's session should instantiate a SIM specific version of this class.
Car
The base class of all SIM cars. Each SIM's session should create SIM specific versions of the cars.
Gauge
The base class of all Gauges on a car. Each SIM's car should instantiate SIM specific versions of the gauges for each car.
TeamSpeak
This class is used to implement the interface to TeamSpeak. Each SIM does not have to implement a SIM specific version of this.

The connector has methods that each SIM has to implement to retrieve data.

There is an example Java App in the project called SIMRacingAppsJavaApp. Open the main.java file in this project and run it as a verification your project is setup properly.

For an example of how to use the Servlet, see the WebContent/apps/_template folder, to see how to subscribe to Web Events that are processed by Angular.