Skip to main content

Abstract Class: BasicAvionicsSystem<T>

Defined in: src/sdk/system/BasicAvionicsSystem.ts:30

A basic avionics system with a fixed initialization time and logic.

Type Parameters

Type Parameter
T extends Record<string, any>

Implements

Constructors

Constructor

new BasicAvionicsSystem<T>(index, bus, stateEvent): BasicAvionicsSystem<T>

Defined in: src/sdk/system/BasicAvionicsSystem.ts:61

Creates an instance of a BasicAvionicsSystem.

Parameters

ParameterTypeDescription
indexnumberThe index of the system.
busEventBusThe instance of the event bus for the system to use.
stateEventkeyof StateEventsOnly<T> & stringThe key of the state update event to send on state update.

Returns

BasicAvionicsSystem<T>

Properties

_state

protected _state: undefined | AvionicsSystemState

Defined in: src/sdk/system/BasicAvionicsSystem.ts:32


bus

protected readonly bus: EventBus

Defined in: src/sdk/system/BasicAvionicsSystem.ts:63

The instance of the event bus for the system to use.


electricalPowerLogic?

protected optional electricalPowerLogic: CompositeLogicXMLElement

Defined in: src/sdk/system/BasicAvionicsSystem.ts:48


electricalPowerSub?

protected optional electricalPowerSub: Subscription

Defined in: src/sdk/system/BasicAvionicsSystem.ts:47


index

readonly index: number

Defined in: src/sdk/system/BasicAvionicsSystem.ts:62

The index of the system.

Implementation of

AvionicsSystem.index


initializationTime

protected initializationTime: number = 0

Defined in: src/sdk/system/BasicAvionicsSystem.ts:39

The time it takes in milliseconds for the system to initialize.


initializationTimer

protected readonly initializationTimer: DebounceTimer

Defined in: src/sdk/system/BasicAvionicsSystem.ts:42

A timeout after which initialization will be complete.


isPowered

protected isPowered: undefined | boolean

Defined in: src/sdk/system/BasicAvionicsSystem.ts:45

Whether or not the system is powered.


isPowerValid

protected isPowerValid: boolean = false

Defined in: src/sdk/system/BasicAvionicsSystem.ts:53

Whether power data consumed by this system is valid.


publisher

protected readonly publisher: Publisher<T>

Defined in: src/sdk/system/BasicAvionicsSystem.ts:50


stateEvent

protected readonly stateEvent: keyof StateEventsOnly<T> & string

Defined in: src/sdk/system/BasicAvionicsSystem.ts:64

The key of the state update event to send on state update.

Accessors

state

Get Signature

get state(): undefined | AvionicsSystemState

Defined in: src/sdk/system/BasicAvionicsSystem.ts:34

The state of the avionics system.

Returns

undefined | AvionicsSystemState

The state of the avionics system.

Implementation of

AvionicsSystem.state

Methods

connectToPower()

protected connectToPower(source): void

Defined in: src/sdk/system/BasicAvionicsSystem.ts:95

Connects this system's power state to an ElectricalEvents topic, electricity logic element, or Subscribable.

Parameters

ParameterTypeDescription
sourceCompositeLogicXMLElement | Subscribable<boolean> | keyof BaseElectricalEvents | `elec_bus_main_v_${number}` | `elec_bus_main_a_${number}` | `elec_master_battery_${number}` | `elec_circuit_avionics_on_${number}` | `elec_bat_v_${number}` | `elec_bat_a_${number}` | `elec_ext_power_available_${number}` | `elec_ext_power_on_${number}` | `elec_apu_gen_active_${number}` | `elec_apu_gen_switch_${number}` | `elec_eng_gen_switch_${number}` | `elec_circuit_on_${number}` | `elec_circuit_switch_on_${number}` | `elec_circuit_com_on_${number}` | `elec_circuit_nav_on_${number}`The source to which to connect this system's power state.

Returns

void


onPowerChanged()

protected onPowerChanged(isPowered): void

Defined in: src/sdk/system/BasicAvionicsSystem.ts:140

A callback called when the connected power state of the avionics system changes.

Parameters

ParameterTypeDescription
isPoweredbooleanWhether or not the system is powered.

Returns

void


onPowerValid()

protected onPowerValid(): void

Defined in: src/sdk/system/BasicAvionicsSystem.ts:86

Responds to when power data becomes valid.

Returns

void


onStateChanged()

protected onStateChanged(previousState, currentState): void

Defined in: src/sdk/system/BasicAvionicsSystem.ts:132

Responds to changes in this system's state.

Parameters

ParameterTypeDescription
previousStateundefined | AvionicsSystemStateThe previous state.
currentStateAvionicsSystemStateThe current state.

Returns

void


onUpdate()

onUpdate(): void

Defined in: src/sdk/system/BasicAvionicsSystem.ts:164

A callback to call to update the state of the avionics system.

Returns

void

Implementation of

AvionicsSystem.onUpdate


setState()

protected setState(state): void

Defined in: src/sdk/system/BasicAvionicsSystem.ts:117

Sets the state of the avionics system and publishes the change.

Parameters

ParameterTypeDescription
stateAvionicsSystemStateThe new state to change to.

Returns

void


updatePowerFromLogic()

protected updatePowerFromLogic(): void

Defined in: src/sdk/system/BasicAvionicsSystem.ts:171

Updates this system's power state from an electricity logic element.

Returns

void