Skip to main content

Class: BasicAvionicsSystem<T>

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

Type parameters

NameType
Textends Record<string, any>

Implements

Constructors

constructor

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

Creates an instance of a BasicAvionicsSystem.

Type parameters

NameType
Textends Record<string, any>

Parameters

NameTypeDescription
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>

Defined in

src/sdk/system/BasicAvionicsSystem.ts:61

Properties

_state

Protected _state: undefined | AvionicsSystemState

Defined in

src/sdk/system/BasicAvionicsSystem.ts:32


bus

Protected Readonly bus: EventBus

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

Defined in

src/sdk/system/BasicAvionicsSystem.ts:63


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

The index of the system.

Implementation of

AvionicsSystem.index

Defined in

src/sdk/system/BasicAvionicsSystem.ts:62


initializationTime

Protected initializationTime: number = 0

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

Defined in

src/sdk/system/BasicAvionicsSystem.ts:39


initializationTimer

Protected Readonly initializationTimer: DebounceTimer

A timeout after which initialization will be complete.

Defined in

src/sdk/system/BasicAvionicsSystem.ts:42


isPowerValid

Protected isPowerValid: boolean = false

Whether power data consumed by this system is valid.

Defined in

src/sdk/system/BasicAvionicsSystem.ts:53


isPowered

Protected isPowered: undefined | boolean

Whether or not the system is powered.

Defined in

src/sdk/system/BasicAvionicsSystem.ts:45


publisher

Protected Readonly publisher: Publisher<T>

Defined in

src/sdk/system/BasicAvionicsSystem.ts:50


stateEvent

Protected Readonly stateEvent: keyof StateEventsOnly<T> & string

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

Defined in

src/sdk/system/BasicAvionicsSystem.ts:64

Accessors

state

get state(): undefined | AvionicsSystemState

The state of the avionics system.

Returns

undefined | AvionicsSystemState

Implementation of

AvionicsSystem.state

Defined in

src/sdk/system/BasicAvionicsSystem.ts:34

Methods

connectToPower

connectToPower(source): void

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

Parameters

NameTypeDescription
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}`The source to which to connect this system's power state.

Returns

void

Defined in

src/sdk/system/BasicAvionicsSystem.ts:95


onPowerChanged

onPowerChanged(isPowered): void

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

Parameters

NameTypeDescription
isPoweredbooleanWhether or not the system is powered.

Returns

void

Defined in

src/sdk/system/BasicAvionicsSystem.ts:140


onPowerValid

onPowerValid(): void

Responds to when power data becomes valid.

Returns

void

Defined in

src/sdk/system/BasicAvionicsSystem.ts:86


onStateChanged

onStateChanged(previousState, currentState): void

Responds to changes in this system's state.

Parameters

NameTypeDescription
previousStateundefined | AvionicsSystemStateThe previous state.
currentStateAvionicsSystemStateThe current state.

Returns

void

Defined in

src/sdk/system/BasicAvionicsSystem.ts:132


onUpdate

onUpdate(): void

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

Returns

void

Implementation of

AvionicsSystem.onUpdate

Defined in

src/sdk/system/BasicAvionicsSystem.ts:164


setState

setState(state): void

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

Parameters

NameTypeDescription
stateAvionicsSystemStateThe new state to change to.

Returns

void

Defined in

src/sdk/system/BasicAvionicsSystem.ts:117


updatePowerFromLogic

updatePowerFromLogic(): void

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

Returns

void

Defined in

src/sdk/system/BasicAvionicsSystem.ts:171