Interface

IAircraftDynamics

USI.Core

Provides simulator-neutral aerodynamic and motion values for the user aircraft.

public interface IAircraftDynamics

Methods

TryGetAerodynamicReferenceCharacteristicsAsync

public Task<USIResult<AircraftAerodynamicReferenceCharacteristics>> TryGetAerodynamicReferenceCharacteristicsAsync()

Gets one immutable snapshot of the aircraft's authored aerodynamic reference angles, lift-curve slope, and static-pitch stability angle.

TryGetAirflowForwardVelocityAsync

public Task<USIResult<Double>> TryGetAirflowForwardVelocityAsync()

Gets air-relative forward velocity in feet per second.

TryGetAirflowRightwardVelocityAsync

public Task<USIResult<Double>> TryGetAirflowRightwardVelocityAsync()

Gets air-relative rightward velocity in feet per second.

TryGetAirflowUpwardVelocityAsync

public Task<USIResult<Double>> TryGetAirflowUpwardVelocityAsync()

Gets air-relative upward velocity in feet per second.

TryGetAirRelativeCourseDegreesTrueAsync

public Task<USIResult<Double>> TryGetAirRelativeCourseDegreesTrueAsync()

Gets the aircraft's direction of travel through the surrounding air mass in degrees true, normalized to zero inclusive and 360 exclusive.

TryGetAirRelativeFlightPathAngleDegreesAsync

public Task<USIResult<Double>> TryGetAirRelativeFlightPathAngleDegreesAsync()

Gets the aircraft's air-relative flight-path angle in degrees, positive above the local horizontal plane.

TryGetAirRelativeTrajectoryAsync

public Task<USIResult<AirRelativeTrajectory>> TryGetAirRelativeTrajectoryAsync()

Gets the composed true course and vertical flight-path angle of the aircraft relative to the surrounding air mass.

TryGetAngleOfAttackAsync

public Task<USIResult<Double>> TryGetAngleOfAttackAsync()

Gets flight-model angle of attack in degrees.

TryGetAttainedLoadFactorExtremaAsync

public Task<USIResult<AircraftLoadFactorExtrema>> TryGetAttainedLoadFactorExtremaAsync()

Gets the minimum and maximum load factors attained over the provider's current observation interval.

TryGetAxialLoadFactorAsync

public Task<USIResult<Double>> TryGetAxialLoadFactorAsync()

Gets axial load factor along the aircraft's longitudinal body axis, in multiples of standard gravity.

TryGetBodyAngularAccelerationsAsync

public Task<USIResult<BodyAngularAccelerationVector>> TryGetBodyAngularAccelerationsAsync()

Gets composed roll, pitch, and yaw accelerations in degrees per second squared.

TryGetBodyAngularRatesAsync

public Task<USIResult<BodyAngularVelocityVector>> TryGetBodyAngularRatesAsync()

Gets composed roll, pitch, and yaw rates in degrees per second.

TryGetBodyForwardAccelerationAsync

public Task<USIResult<Double>> TryGetBodyForwardAccelerationAsync()

Gets aircraft-relative forward acceleration in feet per second squared.

TryGetBodyForwardVelocityAsync

public Task<USIResult<Double>> TryGetBodyForwardVelocityAsync()

Gets aircraft-relative forward velocity in feet per second.

TryGetBodyLoadFactorsAsync

public Task<USIResult<AircraftBodyLoadFactors>> TryGetBodyLoadFactorsAsync()

Gets one immutable normal, axial, and lateral body-axis load-factor snapshot in multiples of standard gravity.

TryGetBodyRelativeAccelerationAsync

public Task<USIResult<BodyRelativeAccelerationVector>> TryGetBodyRelativeAccelerationAsync()

Gets a composed aircraft-relative acceleration vector in feet per second squared.

TryGetBodyRelativeAirflowAsync

public Task<USIResult<BodyRelativeAirflowVector>> TryGetBodyRelativeAirflowAsync()

Gets the velocity of air relative to the aircraft in the common right/up/forward frame.

TryGetBodyRelativeVelocityAsync

public Task<USIResult<BodyRelativeVelocityVector>> TryGetBodyRelativeVelocityAsync()

Gets a composed aircraft-relative velocity vector in feet per second.

TryGetBodyRightwardAccelerationAsync

public Task<USIResult<Double>> TryGetBodyRightwardAccelerationAsync()

Gets aircraft-relative rightward acceleration in feet per second squared.

TryGetBodyRightwardVelocityAsync

public Task<USIResult<Double>> TryGetBodyRightwardVelocityAsync()

Gets aircraft-relative rightward velocity in feet per second.

TryGetBodyUpwardAccelerationAsync

public Task<USIResult<Double>> TryGetBodyUpwardAccelerationAsync()

Gets aircraft-relative upward acceleration in feet per second squared.

TryGetBodyUpwardVelocityAsync

public Task<USIResult<Double>> TryGetBodyUpwardVelocityAsync()

Gets aircraft-relative upward velocity in feet per second.

TryGetDynamicPressurePoundsPerSquareFootAsync

public Task<USIResult<Double>> TryGetDynamicPressurePoundsPerSquareFootAsync()

Gets aerodynamic dynamic pressure in pounds-force per square foot.

TryGetEarthRelativeAccelerationAsync

public Task<USIResult<EarthRelativeAccelerationVector>> TryGetEarthRelativeAccelerationAsync()

Gets a composed earth-relative acceleration vector in feet per second squared.

TryGetEarthRelativeVelocityAsync

public Task<USIResult<EarthRelativeVelocityVector>> TryGetEarthRelativeVelocityAsync()

Gets a composed earth-relative velocity vector in feet per second.

TryGetEastwardAccelerationAsync

public Task<USIResult<Double>> TryGetEastwardAccelerationAsync()

Gets earth-relative eastward acceleration in feet per second squared.

TryGetEastwardVelocityAsync

public Task<USIResult<Double>> TryGetEastwardVelocityAsync()

Gets earth-relative eastward velocity in feet per second.

TryGetFlightPathAngleDegreesAsync

public Task<USIResult<Double>> TryGetFlightPathAngleDegreesAsync()

Gets actual earth-relative flight-path angle in degrees, positive above the local horizontal plane.

TryGetForceAndMomentSnapshotAsync

public Task<USIResult<AircraftForceAndMomentSnapshot>> TryGetForceAndMomentSnapshotAsync()

Gets an immutable source-preserving decomposition of aircraft force and moment in stable SI units and common body axes.

TryGetHoverInducedVelocityMetersPerSecondAsync

public Task<USIResult<Double>> TryGetHoverInducedVelocityMetersPerSecondAsync()

Gets the aircraft-wide difference between average rotor inflow and outflow velocity in meters per second. This is not propwash speed.

TryGetLateralLoadFactorAsync

public Task<USIResult<Double>> TryGetLateralLoadFactorAsync()

Gets lateral load factor along the aircraft's transverse body axis, in multiples of standard gravity.

TryGetNormalLoadFactorAsync

public Task<USIResult<Double>> TryGetNormalLoadFactorAsync()

Gets normal load factor in multiples of standard gravity.

TryGetNorthwardAccelerationAsync

public Task<USIResult<Double>> TryGetNorthwardAccelerationAsync()

Gets earth-relative northward acceleration in feet per second squared.

TryGetNorthwardVelocityAsync

public Task<USIResult<Double>> TryGetNorthwardVelocityAsync()

Gets earth-relative northward velocity in feet per second.

TryGetPitchAccelerationAsync

public Task<USIResult<Double>> TryGetPitchAccelerationAsync()

Gets body-axis pitch acceleration in degrees per second squared.

TryGetPitchRateAsync

public Task<USIResult<Double>> TryGetPitchRateAsync()

Gets body-axis pitch rate in degrees per second.

TryGetRollAccelerationAsync

public Task<USIResult<Double>> TryGetRollAccelerationAsync()

Gets body-axis roll acceleration in degrees per second squared.

TryGetRollRateAsync

public Task<USIResult<Double>> TryGetRollRateAsync()

Gets body-axis roll rate in degrees per second.

TryGetSideslipAngleAsync

public Task<USIResult<Double>> TryGetSideslipAngleAsync()

Gets aerodynamic sideslip angle in degrees.

TryGetSideslipRateDegreesPerSecondAsync

public Task<USIResult<Double>> TryGetSideslipRateDegreesPerSecondAsync()

Gets the instantaneous rate of change of aerodynamic sideslip angle in degrees per second. This is distinct from body-axis yaw rate.

TryGetSnapshotAsync

public Task<USIResult<AircraftMotionSnapshot>> TryGetSnapshotAsync()

Gets one immutable common snapshot of aerodynamic and three-axis motion.

TryGetSurfaceContactsAsync

public Task<USIResult<IReadOnlyList<AircraftSurfaceContact>>> TryGetSurfaceContactsAsync()

Gets the currently active physical surface contacts reported for the aircraft, in common body axes and units.

TryGetTotalSpeedFeetPerSecondAsync

public Task<USIResult<Double>> TryGetTotalSpeedFeetPerSecondAsync()

Gets total earth-relative aircraft speed in feet per second.

TryGetTouchdownNormalVelocityFeetPerSecondAsync

public Task<USIResult<Double>> TryGetTouchdownNormalVelocityFeetPerSecondAsync()

Gets the aircraft's last touchdown velocity normal to the surface in feet per second. The provider's signed physical value is preserved.

TryGetTurnRateAsync

public Task<USIResult<Double>> TryGetTurnRateAsync()

Gets aircraft turn-indicator rate in degrees per second.

TryGetUpwardAccelerationAsync

public Task<USIResult<Double>> TryGetUpwardAccelerationAsync()

Gets earth-relative upward acceleration in feet per second squared.

TryGetUpwardVelocityAsync

public Task<USIResult<Double>> TryGetUpwardVelocityAsync()

Gets earth-relative upward velocity in feet per second.

TryGetWakeTurbulenceEffectRatioAsync

public Task<USIResult<Double>> TryGetWakeTurbulenceEffectRatioAsync()

Gets the fraction of modeled wake-turbulence force applied to this aircraft, from zero (suppressed) through one (full effect).

TryGetWindshieldAirflowSpeedFeetPerSecondAsync

public Task<USIResult<Double>> TryGetWindshieldAirflowSpeedFeetPerSecondAsync()

Gets the speed of airflow over the windshield in feet per second.

TryGetYawAccelerationAsync

public Task<USIResult<Double>> TryGetYawAccelerationAsync()

Gets body-axis yaw acceleration in degrees per second squared.

TryGetYawRateAsync

public Task<USIResult<Double>> TryGetYawRateAsync()

Gets body-axis yaw rate in degrees per second.

TrySetWakeTurbulenceEffectRatioAsync

public Task<USIResult> TrySetWakeTurbulenceEffectRatioAsync(double ratio)

Sets the fraction of modeled wake-turbulence force applied to this aircraft, from zero (suppressed) through one (full effect).