Interface

IAircraftWeightAndBalanceSystem

USI.Core

Simulator-neutral access to aircraft weight and balance state.

public interface IAircraftWeightAndBalanceSystem : IAircraftComponentCollection

Methods

TryGetCenterOfGravityEnvelopeAsync

public Task<USIResult<AircraftCenterOfGravityEnvelope>> TryGetCenterOfGravityEnvelopeAsync()

Gets the aircraft-authored forward, aft, left, and right center-of-gravity limits in signed forward/rightward feet relative to the aircraft reference point.

TryGetCenterOfGravityPositionAsync

public Task<USIResult<AircraftCenterOfGravityPosition>> TryGetCenterOfGravityPositionAsync()

Gets current longitudinal and lateral center of gravity in signed forward/rightward feet relative to the aircraft reference point.

TryGetConfiguredLongitudinalCenterOfGravityForwardFeetAsync

public Task<USIResult<Double>> TryGetConfiguredLongitudinalCenterOfGravityForwardFeetAsync()

Gets the aircraft-authored longitudinal center-of-gravity reference in signed feet, positive forward.

TryGetConfiguredRotationalInertiaPerUnitMassAsync

public Task<USIResult<AircraftRotationalInertiaPerUnitMass>> TryGetConfiguredRotationalInertiaPerUnitMassAsync()

Gets the loaded aircraft's configured rotational inertia divided by aircraft mass about its roll, pitch, and yaw axes, in square meters.

TryGetConfiguredVerticalCenterOfGravityUpwardFeetAsync

public Task<USIResult<Double>> TryGetConfiguredVerticalCenterOfGravityUpwardFeetAsync()

Gets the aircraft-authored vertical center of gravity in feet relative to the aircraft reference point. Positive values are above the point.

TryGetCurrentRotationalInertiaAsync

public Task<USIResult<AircraftRotationalInertiaTensor>> TryGetCurrentRotationalInertiaAsync()

Gets the current loaded-aircraft rotational inertia tensor in kilogram-square-meters.

TryGetEmptyWeightPoundsAsync

public Task<USIResult<Double>> TryGetEmptyWeightPoundsAsync()

Gets the aircraft's configured empty weight in pounds.

TryGetEmptyWeightRotationalInertiaAsync

public Task<USIResult<AircraftRotationalInertiaTensor>> TryGetEmptyWeightRotationalInertiaAsync()

Gets the configured empty-aircraft rotational inertia tensor in kilogram-square-meters.

TryGetFlightManagementGrossWeightPoundsAsync

public Task<USIResult<Double>> TryGetFlightManagementGrossWeightPoundsAsync()

Gets the flight-management gross-weight entry in pounds.

TryGetFlightManagementZeroFuelWeightPoundsAsync

public Task<USIResult<Double>> TryGetFlightManagementZeroFuelWeightPoundsAsync()

Gets the flight-management zero-fuel-weight entry in pounds.

TryGetGrossWeightMarginPoundsAsync

public Task<USIResult<Double>> TryGetGrossWeightMarginPoundsAsync()

Gets configured maximum gross weight minus current total weight in pounds. A negative value means the aircraft is currently above maximum gross weight.

TryGetLateralCenterOfGravityEnvelopeAsync

public Task<USIResult<AircraftLateralCenterOfGravityEnvelope>> TryGetLateralCenterOfGravityEnvelopeAsync()

Gets the aircraft-authored left and right lateral center-of-gravity limits in feet relative to the aircraft reference point. Both values use the same signed axis: positive right and negative left.

TryGetLateralCenterOfGravityPercentReferenceChordAsync

public Task<USIResult<Double>> TryGetLateralCenterOfGravityPercentReferenceChordAsync()

Gets lateral center of gravity as percent of the aircraft reference chord when the provider publishes that representation.

TryGetLateralCenterOfGravityRightwardFeetAsync

public Task<USIResult<Double>> TryGetLateralCenterOfGravityRightwardFeetAsync()

Gets current lateral center of gravity in feet relative to the aircraft reference point. Positive values are right of center.

TryGetLongitudinalCenterOfGravityEnvelopeAsync

public Task<USIResult<AircraftLongitudinalCenterOfGravityEnvelope>> TryGetLongitudinalCenterOfGravityEnvelopeAsync()

Gets the aircraft-authored forward and aft longitudinal center-of-gravity limits as percent mean aerodynamic chord.

TryGetLongitudinalCenterOfGravityForwardFeetAsync

public Task<USIResult<Double>> TryGetLongitudinalCenterOfGravityForwardFeetAsync()

Gets current longitudinal center of gravity in feet relative to the aircraft reference point. Positive values are forward of the point.

TryGetLongitudinalCenterOfGravityPercentMeanAerodynamicChordAsync

public Task<USIResult<Double>> TryGetLongitudinalCenterOfGravityPercentMeanAerodynamicChordAsync()

Gets current longitudinal center of gravity as percent mean aerodynamic chord.

TryGetMaximumGrossWeightPoundsAsync

public Task<USIResult<Double>> TryGetMaximumGrossWeightPoundsAsync()

Gets the aircraft's configured maximum gross weight in pounds.

TryGetMaximumLandingWeightPoundsAsync

public Task<USIResult<Double>> TryGetMaximumLandingWeightPoundsAsync()

Gets the certified maximum landing weight in pounds.

TryGetMaximumTakeoffWeightPoundsAsync

public Task<USIResult<Double>> TryGetMaximumTakeoffWeightPoundsAsync()

Gets the certified maximum takeoff weight in pounds.

TryGetMaximumZeroFuelWeightPoundsAsync

public Task<USIResult<Double>> TryGetMaximumZeroFuelWeightPoundsAsync()

Gets the certified maximum zero-fuel weight in pounds.

TryGetPayloadTopologyAsync

public Task<USIResult<AircraftPayloadTopology>> TryGetPayloadTopologyAsync()

Gets normalized metadata for the loaded aircraft's payload stations. Resolve the resulting stations as named components for live telemetry.

TryGetPayloadWeightPoundsAsync

public Task<USIResult<Double>> TryGetPayloadWeightPoundsAsync()

Gets current payload weight in pounds, excluding fuel.

TryGetShiftableWeightPoundsAsync

public Task<USIResult<Double>> TryGetShiftableWeightPoundsAsync()

Gets current shiftable occupant or ballast weight in pounds.

TryGetStaticCenterOfGravityHeightAboveGroundFeetAsync

public Task<USIResult<Double>> TryGetStaticCenterOfGravityHeightAboveGroundFeetAsync()

Gets the loaded aircraft's static center-of-gravity height above the ground in feet. This is aircraft-authored geometry, not live AGL altitude.

TryGetTotalWeightPoundsAsync

public Task<USIResult<Double>> TryGetTotalWeightPoundsAsync()

Gets current total aircraft weight in pounds.

TryGetZeroFuelCenterOfGravityPositionAsync

public Task<USIResult<AircraftCenterOfGravityPosition>> TryGetZeroFuelCenterOfGravityPositionAsync()

Gets the center-of-gravity position of the aircraft excluding fuel in signed forward/rightward feet relative to the aircraft reference point. Payload remains included.

TryGetZeroFuelWeightPoundsAsync

public Task<USIResult<Double>> TryGetZeroFuelWeightPoundsAsync()

Gets current zero-fuel weight in pounds: current total aircraft weight minus current fuel weight.

TrySetLateralCenterOfGravityRightwardFeetAsync

public Task<USIResult> TrySetLateralCenterOfGravityRightwardFeetAsync(double rightwardFeet)

Sets current lateral center of gravity, positive rightward.

TrySetLongitudinalCenterOfGravityForwardFeetAsync

public Task<USIResult> TrySetLongitudinalCenterOfGravityForwardFeetAsync(double forwardFeet)

Sets current longitudinal center of gravity, positive forward.

TrySetLongitudinalCenterOfGravityPercentMeanAerodynamicChordAsync

public Task<USIResult> TrySetLongitudinalCenterOfGravityPercentMeanAerodynamicChordAsync(double percentMeanAerodynamicChord)

Sets current longitudinal center of gravity as percent mean aerodynamic chord.

TrySetPayloadWeightPoundsAsync

public Task<USIResult> TrySetPayloadWeightPoundsAsync(double weightPounds)

Sets current payload weight in pounds, excluding fuel.

TrySetShiftableWeightPoundsAsync

public Task<USIResult> TrySetShiftableWeightPoundsAsync(double weightPounds)

Sets current shiftable occupant or ballast weight in pounds.