Class: WeatherRadarAvionicsSystem

Defined in: src/garminsdk/system/WeatherRadarAvionicsSystem.ts:17

A Garmin weather radar avionics system.

Extends

• BasicAvionicsSystem<WeatherRadarAvionicsSystemEvents>

Constructors

Constructor

new WeatherRadarAvionicsSystem(bus, powerSource?, activePowerSource?, isRadarScanActive?, initializationTime?): WeatherRadarAvionicsSystem

Defined in: src/garminsdk/system/WeatherRadarAvionicsSystem.ts:35

Creates an instance of a weather radar avionics system.

Parameters

Parameter	Type	Default value	Description
bus	EventBus	undefined	An instance of the event bus.
powerSource?	CompositeLogicXMLElement | 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}`	undefined	The AvionicsSystemPowerEvents topic or electricity logic element to which to connect the system's power.
activePowerSource?	CompositeLogicXMLElement | 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}`	undefined	The AvionicsSystemPowerEvents topic or electricity logic element to which to connect the system's power when radar is actively scanning. If defined, then the system will enter the failed state if the radar is actively scanning and the active radar power source is unpowered.
isRadarScanActive?	Subscribable<boolean>	undefined	Whether the weather radar is actively scanning. Ignored if activePowerSource is not defined.
initializationTime?	number	0	The time required for the system to initialize, in milliseconds. Defaults to 0.

Returns

WeatherRadarAvionicsSystem

Overrides

BasicAvionicsSystem<WeatherRadarAvionicsSystemEvents>.constructor

Properties

_state

protected _state: undefined | AvionicsSystemState

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

Inherited from

BasicAvionicsSystem._state

---

bus

protected readonly bus: EventBus

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

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

Inherited from

BasicAvionicsSystem.bus

---

electricalActivePowerLogic?

protected optional electricalActivePowerLogic: CompositeLogicXMLElement

Defined in: src/garminsdk/system/WeatherRadarAvionicsSystem.ts:21

---

electricalActivePowerSub?

protected optional electricalActivePowerSub: Subscription

Defined in: src/garminsdk/system/WeatherRadarAvionicsSystem.ts:20

---

electricalPowerLogic?

protected optional electricalPowerLogic: CompositeLogicXMLElement

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

Inherited from

BasicAvionicsSystem.electricalPowerLogic

---

electricalPowerSub?

protected optional electricalPowerSub: Subscription

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

Inherited from

BasicAvionicsSystem.electricalPowerSub

---

index

readonly index: number

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

The index of the system.

Inherited from

BasicAvionicsSystem.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.

Inherited from

BasicAvionicsSystem.initializationTime

---

initializationTimer

protected readonly initializationTimer: DebounceTimer

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

A timeout after which initialization will be complete.

Inherited from

BasicAvionicsSystem.initializationTimer

---

isActivePowered

protected isActivePowered: undefined | boolean

Defined in: src/garminsdk/system/WeatherRadarAvionicsSystem.ts:18

---

isPowered

protected isPowered: undefined | boolean

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

Whether or not the system is powered.

Inherited from

BasicAvionicsSystem.isPowered

---

isPowerValid

protected isPowerValid: boolean = false

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

Whether power data consumed by this system is valid.

Inherited from

BasicAvionicsSystem.isPowerValid

---

isRadarScanActive?

protected readonly optional isRadarScanActive: Subscribable<boolean>

Defined in: src/garminsdk/system/WeatherRadarAvionicsSystem.ts:39

Whether the weather radar is actively scanning. Ignored if activePowerSource is not defined.

---

publisher

protected readonly publisher: Publisher<WeatherRadarAvionicsSystemEvents>

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

Inherited from

BasicAvionicsSystem.publisher

---

stateEvent

protected readonly stateEvent: "wx_radar_state"

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

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

Inherited from

BasicAvionicsSystem.stateEvent

Accessors

state

Get Signature

get state(): undefined | AvionicsSystemState

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

Inherit Doc

Returns

undefined | AvionicsSystemState

Inherited from

BasicAvionicsSystem.state

Methods

connectToActivePower()

protected connectToActivePower(source): void

Defined in: src/garminsdk/system/WeatherRadarAvionicsSystem.ts:68

Connects this system's active radar power state to an AvionicsSystemPowerEvents topic or electricity logic element.

Parameters

Parameter	Type	Description
source	CompositeLogicXMLElement | 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 active radar power state.

Returns

void

---

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

Parameter	Type	Description
source	CompositeLogicXMLElement | 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

Inherited from

BasicAvionicsSystem.connectToPower

---

onActivePowerChanged()

protected onActivePowerChanged(isPowered): void

Defined in: src/garminsdk/system/WeatherRadarAvionicsSystem.ts:112

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

Parameters

Parameter	Type	Description
isPowered	boolean	Whether or not the system is powered.

Returns

void

---

onPowerChanged()

protected onPowerChanged(isPowered): void

Defined in: src/garminsdk/system/WeatherRadarAvionicsSystem.ts:85

Parameters

Parameter	Type
isPowered	boolean

Returns

void

Inherit Doc

Overrides

BasicAvionicsSystem.onPowerChanged

---

onPowerValid()

protected onPowerValid(): void

Defined in: src/garminsdk/system/WeatherRadarAvionicsSystem.ts:56

Returns

void

Inherit Doc

Overrides

BasicAvionicsSystem.onPowerValid

---

onRadarScanActiveChanged()

protected onRadarScanActiveChanged(): void

Defined in: src/garminsdk/system/WeatherRadarAvionicsSystem.ts:122

Responds to when whether the radar is actively scanning changes.

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

Parameter	Type	Description
previousState	undefined | AvionicsSystemState	The previous state.
currentState	AvionicsSystemState	The current state.

Returns

void

Inherited from

BasicAvionicsSystem.onStateChanged

---

onUpdate()

onUpdate(): void

Defined in: src/garminsdk/system/WeatherRadarAvionicsSystem.ts:140

Returns

void

Inherit Doc

Overrides

BasicAvionicsSystem.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

Parameter	Type	Description
state	AvionicsSystemState	The new state to change to.

Returns

void

Inherited from

BasicAvionicsSystem.setState

---

updateActivePowerFromLogic()

protected updateActivePowerFromLogic(): void

Defined in: src/garminsdk/system/WeatherRadarAvionicsSystem.ts:149

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

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

Inherited from

BasicAvionicsSystem.updatePowerFromLogic

---

updateStateFromActivePower()

protected updateStateFromActivePower(): void

Defined in: src/garminsdk/system/WeatherRadarAvionicsSystem.ts:131

Updates this system's state from its active radar power state and whether the radar is actively scanning.

Returns

void