Class

USI

USI.Core

Public SDK type.

public class USI : IDisposable

Constructors

USI

public USI()

USI

public USI(USIOptions options)

USI

public USI(SimulatorProviderRegistry providers)

USI

public USI(SimulatorProviderRegistry providers, USIOptions options)

Properties

Aircraft

public IAircraft Aircraft { get; }

Automation

public IUSIAutomationGateway Automation { get; }

Simulator-neutral operation catalog for automation and integration hosts. Ordinary applications should continue to prefer the strongly typed Simulator and Aircraft object model.

Capabilities

public ICapabilityDiscovery Capabilities { get; }

FlightPlanning

public IUSIFlightPlanningService FlightPlanning { get; }

Operational flight planning, including normalized SimBrief plans, current route weather, and explicit import into the active aircraft.

Preferences

public USIPreferences Preferences { get; }

Providers

public SimulatorProviderRegistry Providers { get; }

Simulator

public ISimulator Simulator { get; }

Weather

public IUSIWeatherService Weather { get; }

Unified access to simulator weather and normalized real-world aviation weather products.

Events

AutomationLevelDowngraded

public event EventHandler AutomationLevelDowngraded

Raised when the simulator explicitly reports an uncommanded reduction in the aircraft's automation capability or landing capability.

Connected

public event EventHandler Connected

Raised after the provider is connected and the initial loaded-aircraft component graph is ready for use.

DiagnosticRaised

public event EventHandler<USIDiagnosticEventArgs> DiagnosticRaised

Disconnected

public event EventHandler Disconnected

Raised when the active provider disconnects.

ErrorOccurred

public event EventHandler<ErrorEventArgs> ErrorOccurred

Raised when the provider reports a connection or runtime error.

FlightPlanChanged

public event EventHandler<FlightPlanChangedEventArgs> FlightPlanChanged

LoadedAircraftChanged

public event EventHandler<LoadedAircraftChangedEventArgs> LoadedAircraftChanged

Methods

Detect

public SimulatorProviderId? Detect()

Returns the first detected simulator in provider registration order, or when none is running. Use when more than one simulator may be running.

DetectAll

public IReadOnlyList<DetectedSimulator> DetectAll()

Returns every registered simulator that is currently running, in provider registration order. Detection failures are isolated to the affected provider and surfaced through .

Disconnect

public void Disconnect()

Dispose

public void Dispose()

IsDetected

public bool IsDetected(SimulatorProviderId providerId)

TryConnectAsync

public Task<USIResult> TryConnectAsync(SimulatorConnectionTarget connectionTarget = Simulator, TimeSpan? timeout = null, CancellationToken cancellationToken = null)

Connects to a simulator and completes only after USI has constructed the initial loaded-aircraft component graph.

TryConnectAsync

public Task<USIResult> TryConnectAsync(SimulatorProviderId providerId, SimulatorConnectionTarget connectionTarget = Simulator, TimeSpan? timeout = null, CancellationToken cancellationToken = null)

Connects to a simulator and completes only after USI has constructed the initial loaded-aircraft component graph.