GpsReceiver
USI.Core
Named satellite-navigation receiver guidance. The component represents the same aviation concept whether its provider is a GPS, integrated FMS, or another area-navigation implementation.
public sealed class GpsReceiver : AircraftComponentNodeProperties
Number
public int Number { get; }Gets the one-based receiver number used in the component name.
Methods
TryGetApproachActiveAsync
public Task<USIResult<Boolean>> TryGetApproachActiveAsync()Gets whether the primary navigator is actively flying an instrument approach.
TryGetApproachAirportIdentifierAsync
public Task<USIResult<String>> TryGetApproachAirportIdentifierAsync()Gets the airport identifier associated with the loaded approach.
TryGetApproachAirportUtcOffsetAsync
public Task<USIResult<TimeSpan>> TryGetApproachAirportUtcOffsetAsync()Gets the loaded approach airport's signed offset from UTC.
TryGetApproachIdentifierAsync
public Task<USIResult<String>> TryGetApproachIdentifierAsync()Gets the loaded instrument approach identifier when exposed by the navigator.
TryGetApproachLoadedAsync
public Task<USIResult<Boolean>> TryGetApproachLoadedAsync()Gets whether an instrument approach is loaded in the primary navigator.
TryGetApproachPhaseAsync
public Task<USIResult<GpsApproachPhase>> TryGetApproachPhaseAsync()Gets the current instrument-approach phase when exposed by the navigator.
TryGetApproachSegmentTypeAsync
public Task<USIResult<GpsApproachSegmentType>> TryGetApproachSegmentTypeAsync()Gets the geometry of the current instrument-approach segment.
TryGetApproachTransitionIdentifierAsync
public Task<USIResult<String>> TryGetApproachTransitionIdentifierAsync()Gets the selected transition identifier for the loaded approach.
TryGetApproachTypeAsync
public Task<USIResult<GpsApproachType>> TryGetApproachTypeAsync()Gets the navigation-aid type of the loaded instrument approach.
TryGetApproachWaypointCountAsync
public Task<USIResult<Int32>> TryGetApproachWaypointCountAsync()Gets the number of waypoints in the loaded instrument approach.
TryGetApproachWaypointIndexAsync
public Task<USIResult<Int32>> TryGetApproachWaypointIndexAsync()Gets the zero-based current waypoint index in the loaded approach.
TryGetApproachWaypointIsRunwayAsync
public Task<USIResult<Boolean>> TryGetApproachWaypointIsRunwayAsync()Gets whether the current approach waypoint represents the runway.
TryGetApproachWaypointTypeAsync
public Task<USIResult<GpsApproachWaypointType>> TryGetApproachWaypointTypeAsync()Gets the operational role of the current approach waypoint.
TryGetBarometricHeightAboveLandingThresholdAsync
public Task<USIResult<Length>> TryGetBarometricHeightAboveLandingThresholdAsync()TryGetBarometricHeightAboveLandingThresholdFeetAsync
public Task<USIResult<Double>> TryGetBarometricHeightAboveLandingThresholdFeetAsync()Gets barometric height above the selected landing threshold in feet. This is not radio altitude.
TryGetBearingToDestinationDegreesMagneticAsync
public Task<USIResult<Double>> TryGetBearingToDestinationDegreesMagneticAsync()Gets magnetic bearing to the active destination.
TryGetCdiFullScaleAsync
public Task<USIResult<Length>> TryGetCdiFullScaleAsync()TryGetCdiFullScaleNauticalMilesAsync
public Task<USIResult<Double>> TryGetCdiFullScaleNauticalMilesAsync()Gets full-scale lateral CDI displacement in nautical miles.
TryGetCdiSensitivityAsync
public Task<USIResult<GpsCdiSensitivity>> TryGetCdiSensitivityAsync()Gets the current satellite-navigation guidance service level.
TryGetClosingSpeedAsync
public Task<USIResult<Speed>> TryGetClosingSpeedAsync()TryGetClosingSpeedKnotsAsync
public Task<USIResult<Double>> TryGetClosingSpeedKnotsAsync()Gets closing speed to the active distance source in knots.
TryGetCopilotHorizontalDeviationDotsAsync
public Task<USIResult<Double>> TryGetCopilotHorizontalDeviationDotsAsync()Gets copilot-side lateral GPS course deviation in dots.
TryGetCrossTrackErrorAsync
public Task<USIResult<Length>> TryGetCrossTrackErrorAsync()TryGetCrossTrackErrorNauticalMilesAsync
public Task<USIResult<Double>> TryGetCrossTrackErrorNauticalMilesAsync()Gets signed lateral displacement from the active leg in nautical miles. The provider's native sign is preserved; zero is on course.
TryGetDesiredMagneticTrackAsync
public Task<USIResult<Angle>> TryGetDesiredMagneticTrackAsync()TryGetDesiredTrackDegreesMagneticAsync
public Task<USIResult<Double>> TryGetDesiredTrackDegreesMagneticAsync()Gets the active leg's desired magnetic track.
TryGetDestinationIdentifierAsync
public Task<USIResult<String>> TryGetDestinationIdentifierAsync()Gets the identifier of the waypoint currently being navigated to.
TryGetDestinationReachedAsync
public Task<USIResult<Boolean>> TryGetDestinationReachedAsync()Gets whether the active flight-plan destination has been reached.
TryGetDistanceAvailableAsync
public Task<USIResult<Boolean>> TryGetDistanceAvailableAsync()Gets whether this navigator has a valid distance solution.
TryGetDistanceSourceIdentifierAsync
public Task<USIResult<String>> TryGetDistanceSourceIdentifierAsync()Gets the identifier associated with this navigator's distance source.
TryGetDistanceToDestinationAsync
public Task<USIResult<Length>> TryGetDistanceToDestinationAsync()TryGetDistanceToDestinationNauticalMilesAsync
public Task<USIResult<Double>> TryGetDistanceToDestinationNauticalMilesAsync()Gets great-circle distance to the active destination in nautical miles.
TryGetDistanceToLandingThresholdAsync
public Task<USIResult<Length>> TryGetDistanceToLandingThresholdAsync()TryGetDistanceToLandingThresholdNauticalMilesAsync
public Task<USIResult<Double>> TryGetDistanceToLandingThresholdNauticalMilesAsync()Gets this navigator's displayed distance to the landing threshold or associated ILS DME in nautical miles.
TryGetEstimatedArrivalZuluTimeOfDayAsync
public Task<USIResult<TimeSpan>> TryGetEstimatedArrivalZuluTimeOfDayAsync()Gets the estimated UTC arrival time-of-day at the active waypoint. The value is a clock time since midnight rather than a duration from now.
TryGetEstimatedTimeEnrouteAsync
public Task<USIResult<TimeSpan>> TryGetEstimatedTimeEnrouteAsync()Gets estimated time remaining to the active navigation target.
TryGetFailureDetectedAsync
public Task<USIResult<Boolean>> TryGetFailureDetectedAsync()Gets whether this satellite-navigation receiver has failed.
TryGetFinalApproachSegmentIdentifierAsync
public Task<USIResult<String>> TryGetFinalApproachSegmentIdentifierAsync()Gets this navigator's active final-approach-segment identifier.
TryGetFlightPlanChangesPendingAsync
public Task<USIResult<Boolean>> TryGetFlightPlanChangesPendingAsync()Gets whether this navigator has modifications waiting to be executed.
TryGetFlightPlanEstimatedArrivalZuluTimeOfDayAsync
public Task<USIResult<TimeSpan>> TryGetFlightPlanEstimatedArrivalZuluTimeOfDayAsync()Gets the estimated UTC arrival time-of-day at the final destination in the loaded flight plan.
TryGetFlightPlanEstimatedTimeEnrouteAsync
public Task<USIResult<TimeSpan>> TryGetFlightPlanEstimatedTimeEnrouteAsync()Gets estimated time remaining to the final destination in the loaded flight plan.
TryGetFlightPlanVerticalAdvisoryAsync
public Task<USIResult<FlightPlanVerticalAdvisory>> TryGetFlightPlanVerticalAdvisoryAsync()Gets the vertical-planning advisory shown by this navigator.
TryGetFrequencyEntryModeAsync
public Task<USIResult<GpsFrequencyEntryMode>> TryGetFrequencyEntryModeAsync()Gets whether this integrated navigator is accepting communication- radio or navigation-radio frequency entry.
TryGetHorizontalDeviationDotsAsync
public Task<USIResult<Double>> TryGetHorizontalDeviationDotsAsync()Gets lateral GPS course deviation in dots. Positive values place the guidance needle to the right of center.
TryGetLandingThresholdIdentifierAsync
public Task<USIResult<String>> TryGetLandingThresholdIdentifierAsync()Gets this navigator's active landing-threshold identifier.
TryGetMagneticBearingToDestinationAsync
public Task<USIResult<Angle>> TryGetMagneticBearingToDestinationAsync()TryGetObsCourseDegreesMagneticAsync
public Task<USIResult<Double>> TryGetObsCourseDegreesMagneticAsync()Gets the selected OBS course in magnetic degrees.
TryGetObsMagneticCourseAsync
public Task<USIResult<Angle>> TryGetObsMagneticCourseAsync()TryGetObsModeActiveAsync
public Task<USIResult<Boolean>> TryGetObsModeActiveAsync()Gets whether automatic waypoint sequencing is suspended in OBS mode.
TryGetPositionFixAsync
public Task<USIResult<GpsPositionFix>> TryGetPositionFixAsync()Gets the geodetic position calculated by the navigator rather than the simulator's general aircraft-position state.
TryGetPowerSwitchEnabledAsync
public Task<USIResult<Boolean>> TryGetPowerSwitchEnabledAsync()Gets whether this navigator's own equipment power switch is enabled.
TryGetRelativeBearingToDestinationAsync
public Task<USIResult<Angle>> TryGetRelativeBearingToDestinationAsync()TryGetRelativeBearingToDestinationDegreesAsync
public Task<USIResult<Double>> TryGetRelativeBearingToDestinationDegreesAsync()Gets signed bearing to the active destination relative to aircraft heading. Positive values are clockwise/right and the result is in the range -180 inclusive through 180 exclusive.
TryGetRequiredTrueHeadingAsync
public Task<USIResult<Angle>> TryGetRequiredTrueHeadingAsync()TryGetRequiredTrueHeadingDegreesAsync
public Task<USIResult<Double>> TryGetRequiredTrueHeadingDegreesAsync()Gets the true aircraft heading required by the navigator to reach the active destination when the provider exposes that steering solution.
TryGetRequiredVerticalSpeedAsync
public Task<USIResult<Speed>> TryGetRequiredVerticalSpeedAsync()TryGetRequiredVerticalSpeedFeetPerMinuteAsync
public Task<USIResult<Double>> TryGetRequiredVerticalSpeedFeetPerMinuteAsync()Gets vertical speed required to reach the active target altitude in feet per minute when the provider exposes that navigator solution.
TryGetSelectedRunwayElevationAsync
public Task<USIResult<Length>> TryGetSelectedRunwayElevationAsync()TryGetSelectedRunwayElevationFeetAsync
public Task<USIResult<Double>> TryGetSelectedRunwayElevationFeetAsync()Gets the selected runway threshold elevation in feet MSL.
TryGetTargetAltitudeAsync
public Task<USIResult<Length>> TryGetTargetAltitudeAsync()TryGetTargetAltitudeFeetAsync
public Task<USIResult<Double>> TryGetTargetAltitudeFeetAsync()Gets the altitude constraint of the active target waypoint.
TryGetTrackAngleErrorAsync
public Task<USIResult<Angle>> TryGetTrackAngleErrorAsync()TryGetTrackAngleErrorDegreesAsync
public Task<USIResult<Double>> TryGetTrackAngleErrorDegreesAsync()Gets signed track-angle error for the active leg. Positive values mean the aircraft's ground track is clockwise/right of desired track.
TryGetTrueBearingToDestinationAsync
public Task<USIResult<Angle>> TryGetTrueBearingToDestinationAsync()TryGetTrueBearingToDestinationDegreesAsync
public Task<USIResult<Double>> TryGetTrueBearingToDestinationDegreesAsync()Gets the true bearing from the aircraft to the active destination. USI derives this from the navigator's magnetic bearing and the aircraft's local magnetic variation when no separate provider value is required.
TryGetVerticalAngleErrorAsync
public Task<USIResult<Angle>> TryGetVerticalAngleErrorAsync()TryGetVerticalAngleErrorDegreesAsync
public Task<USIResult<Double>> TryGetVerticalAngleErrorDegreesAsync()Gets signed angular displacement from the active vertical path in degrees.
TryGetVerticalDeviationAsync
public Task<USIResult<Length>> TryGetVerticalDeviationAsync()TryGetVerticalDeviationDotsAsync
public Task<USIResult<Double>> TryGetVerticalDeviationDotsAsync()Gets vertical GPS path deviation in dots. Positive values place the guidance needle above center.
TryGetVerticalDeviationFullScaleAsync
public Task<USIResult<Length>> TryGetVerticalDeviationFullScaleAsync()TryGetVerticalDeviationFullScaleMetersAsync
public Task<USIResult<Double>> TryGetVerticalDeviationFullScaleMetersAsync()Gets full-scale vertical-path displacement in meters.
TryGetVerticalDeviationMetersAsync
public Task<USIResult<Double>> TryGetVerticalDeviationMetersAsync()Gets signed vertical displacement from the active path in meters. Positive values follow the displayed needle convention and place the guidance needle above center.
TryGetVerticalGuidanceAvailableAsync
public Task<USIResult<Boolean>> TryGetVerticalGuidanceAvailableAsync()Gets whether the active GPS guidance includes a vertical path.
TryGetVerticalGuidanceSourceAsync
public Task<USIResult<GpsVerticalGuidanceSource>> TryGetVerticalGuidanceSourceAsync()Gets whether this navigator's vertical-guidance indication is driven by satellite navigation or a ground-based glideslope receiver.
TryGetVerticalPathAngleAsync
public Task<USIResult<Angle>> TryGetVerticalPathAngleAsync()TryGetVerticalPathAngleDegreesAsync
public Task<USIResult<Double>> TryGetVerticalPathAngleDegreesAsync()Gets the active vertical-path angle in degrees.
TryGetWaypointNavigationActiveAsync
public Task<USIResult<Boolean>> TryGetWaypointNavigationActiveAsync()Gets whether waypoint-based GPS navigation is active.
TryGetWaypointSequencingStateAsync
public Task<USIResult<GpsWaypointSequencingState>> TryGetWaypointSequencingStateAsync()Gets how the primary navigator will sequence the active waypoint.
TrySetFrequencyEntryModeAsync
public Task<USIResult> TrySetFrequencyEntryModeAsync(GpsFrequencyEntryMode mode)Selects whether this integrated navigator accepts communication-radio or navigation-radio frequency entry.
TrySetPowerSwitchEnabledAsync
public Task<USIResult> TrySetPowerSwitchEnabledAsync(bool enabled)Enables or disables this navigator's own equipment power switch.
