# Uses of Interface
com.mouseviator.fsuipc.datarequest.IDataRequest

Packages that use IDataRequest
Package | Description
--- | ---
com.mouseviator.fsuipc | This package contains two main classes that implement the Java FSUIPC SDK.
com.mouseviator.fsuipc.datarequest | This package provides interfaces `IDataRequest`, `IReadOnlyRequest` and `IWriteOnlyRequest` and an abstract class `DataRequest` that are basic building blocks for creating data requests to use with `FSUIPC` class.
com.mouseviator.fsuipc.datarequest.advanced | This package contains above the primitive data type requests...
com.mouseviator.fsuipc.datarequest.primitives | This package contains classes that implement data request for primitive data types, such as Byte, Integer, Long, Float, Double, String...
com.mouseviator.fsuipc.helpers | This package (and sub-packages) contains helper classes to get data requests for use with `FSUIPC` class to gather various sim data.
com.mouseviator.fsuipc.helpers.aircraft | This package contains helper classes to get data requests for use with `FSUIPC` class to gather various aircraft related data.
com.mouseviator.fsuipc.helpers.avionics | This package contains helper classes to get data requests for use with `FSUIPC` class to gather various aircraft avionics related data.

- ## Uses of IDataRequest in com.mouseviator.fsuipc

  Methods in com.mouseviator.fsuipc that return IDataRequest
  Modifier and Type | Method | Description
  --- | --- | ---
  `IDataRequest` | FSUIPC.`addContinualRequest​(IDataRequest dataRequest)` | This method will add data request to the continual requests array.
  `IDataRequest` | FSUIPC.`addOneTimeRequest​(IDataRequest dataRequest)` | This method will add data request to the one-time requests array.This array will be emptied once successfully processed via the `FSUIPC.processRequestsOnce()` function.

  Methods in com.mouseviator.fsuipc that return types with arguments of type IDataRequest
  Modifier and Type | Method | Description
  --- | --- | ---
  `java.util.AbstractQueue<IDataRequest>` | FSUIPC.`getOneTimeRequests()` | This function returns an array of one time data requests.

  Methods in com.mouseviator.fsuipc with parameters of type IDataRequest
  Modifier and Type | Method | Description
  --- | --- | ---
  `IDataRequest` | FSUIPC.`addContinualRequest​(IDataRequest dataRequest)` | This method will add data request to the continual requests array.
  `IDataRequest` | FSUIPC.`addOneTimeRequest​(IDataRequest dataRequest)` | This method will add data request to the one-time requests array.This array will be emptied once successfully processed via the `FSUIPC.processRequestsOnce()` function.
  `boolean` | FSUIPC.`removeContinualRequest​(IDataRequest dataRequest)` | This function will remove data request from continual requests array.

  Method parameters in com.mouseviator.fsuipc with type arguments of type IDataRequest
  Modifier and Type | Method | Description
  --- | --- | ---
  `void` | IFSUIPCListener.`onProcess​(java.util.AbstractQueue<IDataRequest> arRequests)` | This function will be called every time the FSUIPC_Process function is being called.Ie.

- ## Uses of IDataRequest in com.mouseviator.fsuipc.datarequest

  Subinterfaces of IDataRequest in com.mouseviator.fsuipc.datarequest
  Modifier and Type | Interface | Description
  --- | --- | ---
  `interface` | `IReadOnlyRequest<DataType>` | This interface extends the `IDataRequest` interface and should be used when implementing data request, that is read only, as it provides default implementation of `setValue(java.lang.Object)` function, which causes exception every once called.
  `interface` | `IWriteOnlyRequest<DataType>` | This interface extends the `IDataRequest` interface and should be used when implementing data request, that is write only, as it provides default implementation of `getValue()` function, which causes exception every once called.

- ## Uses of IDataRequest in com.mouseviator.fsuipc.datarequest.advanced

  Classes in com.mouseviator.fsuipc.datarequest.advanced that implement IDataRequest
  Modifier and Type | Class | Description
  --- | --- | ---
  `class` | `FSControlRequest` | This class implements special data request to send any FS control to flight simulator.

- ## Uses of IDataRequest in com.mouseviator.fsuipc.datarequest.primitives

  Classes in com.mouseviator.fsuipc.datarequest.primitives that implement IDataRequest
  Modifier and Type | Class | Description
  --- | --- | ---
  `class` | `ByteArrayRequest` | This class implements byte array data request for use with `FSUIPC` class.
  `class` | `ByteRequest` | This class implements byte data request for use with `FSUIPC` class.
  `class` | `DoubleRequest` | This class implements double data request for use with `FSUIPC` class.
  `class` | `FloatRequest` | This class implements short data request for use with `FSUIPC` class.
  `class` | `IntRequest` | This class implements integer data request for use with `FSUIPC` class.
  `class` | `LongRequest` | This class implements long data request for use with `FSUIPC` class.
  `class` | `ShortRequest` | This class implements short data request for use with `FSUIPC` class.
  `class` | `StringRequest` | This class implements string data request for use with `FSUIPC` class.

- ## Uses of IDataRequest in com.mouseviator.fsuipc.helpers

  Classes in com.mouseviator.fsuipc.helpers that implement IDataRequest
  Modifier and Type | Class | Description
  --- | --- | ---
  `static class` | `LuaHelper.LuaControlRequest` | This class implements Lua control request.
  `static class` | `LuaHelper.LuaParamRequest` | This class implements lua parameter request.
  `static class` | `LVarHelper.ByteLVarReadRequest` | This class implements LVar read (read-only) request.
  `static class` | `LVarHelper.ByteLVarWriteRequest` | This class implements LVar write (write-only) request.
  `static class` | `LVarHelper.DoubleLVarReadRequest` | This class implements LVar read (read-only) request.
  `static class` | `LVarHelper.DoubleLVarWriteRequest` | This class implements LVar write (write-only) request.
  `static class` | `LVarHelper.FloatLVarReadRequest` | This class implements LVar read (read-only) request.
  `static class` | `LVarHelper.FloatLVarWriteRequest` | This class implements LVar write (write-only) request.
  `static class` | `LVarHelper.IntegerLVarReadRequest` | This class implements LVar read (read-only) request.
  `static class` | `LVarHelper.IntegerLVarWriteRequest` | This class implements LVar write (write-only) request.
  `static class` | `LVarHelper.LVarControlRequest` | This class implements Lvar control offset.
  `static class` | `LVarHelper.LVarParamRequest` | This class implements Lvar parameter request.
  `static class` | `LVarHelper.ShortLVarReadRequest` | This class implements LVar read (read-only) request.
  `static class` | `LVarHelper.ShortLVarWriteRequest` | This class implements LVar write (write-only) request.
  `static class` | `MacroHelper.MacroExecuteRequest` | This class implements macro execute request.
  `static class` | `MacroHelper.MacroParamRequest` | This class implements macro parameter request.

  Methods in com.mouseviator.fsuipc.helpers that return IDataRequest
  Modifier and Type | Method | Description
  --- | --- | ---
  `IDataRequest<java.lang.Float>` | SimHelper.`getFrameRate()` | Returns request to get simulator actual frame rate.
  `IDataRequest<java.lang.Integer>` | SimHelper.`getFSUIPCAssignedMemorySize()` | Returns request to get the size of the memory currently assigned to FSUIPC.
  `IDataRequest<java.lang.String>` | SimHelper.`getFSXP3DVersion()` | This returns data request that returns FSX/P3D version that FSUIPC is connected to.
  `IDataRequest<java.lang.Double>` | SimHelper.`getGroundAltitude​(boolean bFeet)` | Returns request to get ground altitude.
  `IDataRequest<java.lang.Short>` | SimHelper.`getPauseIndicator()` | Return request to read sim pause indicator.
  `IDataRequest` | LVarHelper.LVarResult.`getResultRequest()` |
  `IDataRequest<java.lang.Short>` | SimHelper.`getSeason()` | Return request to read simulator season.
  `IDataRequest<java.lang.String>` | SimHelper.`getSituationFile()` | This will return request to read current simulator situation file.
  `IDataRequest` | LuaHelper.`luaKillAll()` | This function will generate request to send FSUIPC control to kill all running lua programs.
  `IDataRequest<java.lang.Short>` | SimHelper.`setPause​(boolean bPause)` | Return request to pause / un-pause the sim.WRITE ONLY!

  Methods in com.mouseviator.fsuipc.helpers with parameters of type IDataRequest
  Modifier and Type | Method | Description
  --- | --- | ---
  `void` | LVarHelper.LVarResult.`setResultRequest​(IDataRequest resultRequest)` | Sets the result request.

  Constructors in com.mouseviator.fsuipc.helpers with parameters of type IDataRequest
  Constructor | Description
  --- | ---
  `LVarResult​(LVarHelper.LVarControlRequest controlRequest, LVarHelper.LVarParamRequest paramRequest, IDataRequest resultRequest)` | Constructs new LVarResult with reference to the data requests for Lvar manipulation.

- ## Uses of IDataRequest in com.mouseviator.fsuipc.helpers.aircraft

  Methods in com.mouseviator.fsuipc.helpers.aircraft that return IDataRequest
  Modifier and Type | Method | Description
  --- | --- | ---
  `IDataRequest<java.lang.String>` | AircraftHelper.`getATCAircraftType()` | Returns request to get ATC aircraft type as declared in AircraftHelper.cfg.
  `IDataRequest<java.lang.Short>` | GearHelper.`getCenterWheelRPM()` | Returns data request to get center (nose or tail) wheel RPM.
  `IDataRequest<java.lang.Float>` | Engine1Helper.`getElapsedTime()` | This will return a request to read engine elapsed time.
  `IDataRequest<java.lang.Byte>` | AircraftHelper.`getEngineType()` | Returns request to get aircraft engine type.
  `IDataRequest<java.lang.Short>` | GearHelper.`getLeftWheelRPM()` | Returns data request to get left wheel RPM.
  `IDataRequest<java.lang.Float>` | AircraftHelper.`getMagneticVariation()` | Returns request to get aircraft magnetic variation in degrees.
  `IDataRequest<java.lang.Short>` | AircraftHelper.`getNumberOfEngines()` | Returns request to get number of aircraft engines.
  `IDataRequest<java.lang.Short>` | AircraftHelper.`getOnGround()` | Returns request to get whether the aircraft is on ground.
  `IDataRequest<java.lang.Short>` | GearHelper.`getRightWheelRPM()` | Returns data request to get right wheel RPM.

- ## Uses of IDataRequest in com.mouseviator.fsuipc.helpers.avionics

  Methods in com.mouseviator.fsuipc.helpers.avionics that return IDataRequest
  Modifier and Type | Method | Description
  --- | --- | ---
  `IDataRequest<java.lang.Double>` | GPSHelper.`getAltitude​(boolean bFeet)` | Returns request to get GPS altitude in meters of feet.
  `IDataRequest<java.lang.Byte>` | NavRadioHelper.`getBackCourseFlags()` | Returns data request to get back course flag.
  `IDataRequest<java.lang.Float>` | NavRadioHelper.`getCDINeedle()` | Returns data request to get Course deviation needle indication.
  `IDataRequest<java.lang.Byte>` | NavRadioHelper.`getCodeFlags()` | Returns data request to get back course flag.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getCourseToSet​(boolean bDegrees)` | Returns request to get GPS course to set in radians or degrees.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getCrossTrackError​(boolean bNauticalMiles)` | Returns request to get GPS cross track error in meters or nautical miles.
  `IDataRequest<java.lang.String>` | GPSHelper.`getDestinationAirportID()` | Returns request to get GPS previous waypoint string ID.
  `IDataRequest<java.lang.Integer>` | GPSHelper.`getDestinationETA()` | Returns request to get GPS destination ETA (estimated time arrival) in seconds local time.
  `IDataRequest<java.lang.Integer>` | GPSHelper.`getDestinationETE()` | Returns request to get GPS destination ETE (estimated time en-route) in seconds.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getDistanceToNextWaypoint​(boolean bNauticalMiles)` | Returns request to get GPS distance to next waypoint in meters or nautical miles.
  `IDataRequest<java.lang.Float>` | NavRadioHelper.`getDMEDistance()` | Returns data request to get DME distance.
  `IDataRequest<java.lang.Float>` | NavRadioHelper.`getDMESpeed()` | Returns data request to get DME speed.
  `IDataRequest<java.lang.Float>` | NavRadioHelper.`getDMETimeToStation()` | Returns data request to get DME time to station.
  `IDataRequest<java.lang.Double>` | NavRadioHelper.`getElevation1​(boolean bFeet)` | Returns data request to get VOR elevation in meters of feet.If the NAV radio is tuned to ILS, this data request will return elevation of the glide slope transmitter.
  `IDataRequest<java.lang.Double>` | NavRadioHelper.`getElevation2​(boolean bFeet)` | Returns data request to get VOR elevation in meters or feet.If the NAV radio is tuned to ILS, this data request will return elevation of the localiser transmitter.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getEstimatedFuelBurn​(boolean bLitres)` | Returns request to get GPS estimated fuel burn in gallons or litres.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getGroundSpeed​(boolean bKnots)` | Returns request to get GPS ground speed in m/s or knots.
  `IDataRequest<java.lang.Byte>` | NavRadioHelper.`getGSFlag()` | Returns data request to get glide slope flag.
  `IDataRequest<java.lang.Float>` | NavRadioHelper.`getGSINeedle()` | Returns data request to get Glide slope needle indication.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getHeading​(boolean bDegrees)` | Returns request to get GPS aircraft TRUE heading in radians or degrees.
  `IDataRequest<java.lang.String>` | NavRadioHelper.`getIdentity()` | Returns data request to get the nav radio identity (ICAO code).
  `IDataRequest<java.lang.Float>` | NavRadioHelper.`getILSGlideslopeInclination​(boolean bDegrees)` | Returns data request to get ILS glide slope inclination.
  `IDataRequest<java.lang.Float>` | NavRadioHelper.`getILSLocaliserInverseRunwayHeading()` | Returns data request to get ILS localiser inverse runway heading in degrees.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getLatitude()` | Returns request to get GPS latitude in degrees.
  `IDataRequest<java.lang.Double>` | NavRadioHelper.`getLatitude1()` | Returns data request to get VOR latitude in degrees.
  `IDataRequest<java.lang.Double>` | NavRadioHelper.`getLatitude2()` | Returns data request to get VOR latitude in degrees.
  `IDataRequest<java.lang.Byte>` | NavRadioHelper.`getLocaliserNeedle()` | Returns data request to get localiser needle indication.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getLongitude()` | Returns request to get GPS longitude in degrees.
  `IDataRequest<java.lang.Double>` | NavRadioHelper.`getLongitude1()` | Returns data request to get VOR longitude in degrees.
  `IDataRequest<java.lang.Double>` | NavRadioHelper.`getLongitude2()` | Returns data request to get VOR longitude in degrees.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getMagBearingToNextWaypoint​(boolean bDegrees)` | Returns request to get GPS magnetic bearing to next waypoint in radians or degrees.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getMagneticTrack​(boolean bDegrees)` | Returns request to get GPS aircraft magnetic track in radians or degrees.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getMagneticVariation​(boolean bDegrees)` | Returns request to get GPS magnetic variation in radians or degrees.
  `IDataRequest<java.lang.Float>` | NavRadioHelper.`getMagneticVariation​(boolean bDegrees)` | Returns data request to get VOR magnetic variation.
  `IDataRequest<java.lang.String>` | NavRadioHelper.`getName()` | Returns data request to get the nav radio name.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getNextWaypointAircraftAltitude​(boolean bFeet)` | Returns request to get GPS next waypoint aircraft altitude in meters of feet.
  `IDataRequest<java.lang.Integer>` | GPSHelper.`getNextWaypointETA()` | Returns request to get GPS next waypoint ETA (estimated time arrival) in seconds local time.
  `IDataRequest<java.lang.Integer>` | GPSHelper.`getNextWaypointETE()` | Returns request to get GPS next waypoint ETE (estimated time en-route) in seconds.
  `IDataRequest<java.lang.String>` | GPSHelper.`getNextWaypointID()` | Returns request to get GPS next waypoint string ID.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getNextWaypointLatitude()` | Returns request to get GPS next waypoint latitude in degrees.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getNextWaypointLongitude()` | Returns request to get GPS next waypoint longitude in degrees.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getPreviousWaypointAircraftAltitude​(boolean bFeet)` | Returns request to get GPS previous waypoint aircraft altitude in meters of feet.
  `IDataRequest<java.lang.String>` | GPSHelper.`getPreviousWaypointID()` | Returns request to get GPS previous waypoint string ID.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getPreviousWaypointLatitude()` | Returns request to get GPS previous waypoint latitude in degrees.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getPreviousWaypointLongitude()` | Returns request to get GPS previous waypoint longitude in degrees.
  `IDataRequest<java.lang.Byte>` | GPSHelper.`getPreviousWaypointValidFlag()` | Returns request to get GPS previous waypoint valid flag.
  `IDataRequest<java.lang.Float>` | NavRadioHelper.`getRadial​(boolean bDegrees)` | Returns data request to get VOR radial.The returned value will be in degrees Magnetic for a VOR, but TRUE for an ILS LOC.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getRequiredHeading​(boolean bDegrees)` | Returns request to get GPS aircraft required TRUE heading in radians or degrees.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getRouteTotalDistance​(boolean bNauticalMiles)` | Returns request to get GPS total route distance in meters or nautical miles.
  `IDataRequest<java.lang.Integer>` | NavRadioHelper.`getSignalStrength()` | Returns data request to get signal strength.
  `IDataRequest<java.lang.Byte>` | NavRadioHelper.`getToFromFlag()` | Returns data request to get To/From flag.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getTrackError​(boolean bDegrees)` | Returns request to get GPS track error in radians or degrees.
  `IDataRequest<java.lang.Double>` | GPSHelper.`getVerticalSpeed()` | Returns request to get GPS vertical speed.
  `IDataRequest<java.lang.Short>` | NavRadioHelper.`getVORRelativeBearing()` | Returns data request to get relative bearing to VOR.
  `IDataRequest<java.lang.Byte>` | RadioHelper.`swapFrequencies()` | Returns request to swap active/standby radio frequency.