Class: MagnetometerSystem
The GMU44 magnetometer system.
Hierarchy
BasicAvionicsSystem<MagnetometerSystemEvents>↳
MagnetometerSystem
Constructors
constructor
• new MagnetometerSystem(index, bus, powerSource?): MagnetometerSystem
Creates an instance of the MagnetometerSystem.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index of the system. |
bus | EventBus | The instance of the event bus for the system to use. |
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}` | The ElectricalEvents topic or electricity logic element to which to connect the system's power. |
Returns
Overrides
BasicAvionicsSystem\<MagnetometerSystemEvents\>.constructor
Defined in
src/garminsdk/system/MagnetometerSystem.ts:24
Properties
_state
• Protected _state: undefined | AvionicsSystemState
Inherited from
BasicAvionicsSystem._state
Defined in
src/sdk/system/BasicAvionicsSystem.ts:32
bus
• Protected Readonly bus: EventBus
The instance of the event bus for the system to use.
Inherited from
BasicAvionicsSystem.bus
Defined in
src/garminsdk/system/MagnetometerSystem.ts:26
electricalPowerLogic
• Protected Optional electricalPowerLogic: CompositeLogicXMLElement
Inherited from
BasicAvionicsSystem.electricalPowerLogic
Defined in
src/sdk/system/BasicAvionicsSystem.ts:48
electricalPowerSub
• Protected Optional electricalPowerSub: Subscription
Inherited from
BasicAvionicsSystem.electricalPowerSub
Defined in
src/sdk/system/BasicAvionicsSystem.ts:47
index
• Readonly index: number
The index of the system.
Inherited from
BasicAvionicsSystem.index
Defined in
src/garminsdk/system/MagnetometerSystem.ts:25
initializationTime
• Protected initializationTime: number = 5000
Overrides
BasicAvionicsSystem.initializationTime
Defined in
src/garminsdk/system/MagnetometerSystem.ts:15
initializationTimer
• Protected Readonly initializationTimer: DebounceTimer
A timeout after which initialization will be complete.
Inherited from
BasicAvionicsSystem.initializationTimer
Defined in
src/sdk/system/BasicAvionicsSystem.ts:42
isPowerValid
• Protected isPowerValid: boolean = false
Whether power data consumed by this system is valid.
Inherited from
BasicAvionicsSystem.isPowerValid
Defined in
src/sdk/system/BasicAvionicsSystem.ts:53
isPowered
• Protected isPowered: undefined | boolean
Whether or not the system is powered.
Inherited from
BasicAvionicsSystem.isPowered
Defined in
src/sdk/system/BasicAvionicsSystem.ts:45
publisher
• Protected Readonly publisher: Publisher<MagnetometerSystemEvents>
Inherited from
BasicAvionicsSystem.publisher
Defined in
src/sdk/system/BasicAvionicsSystem.ts:50
stateEvent
• Protected Readonly stateEvent: `magnetometer_state_${number}`
The key of the state update event to send on state update.
Inherited from
BasicAvionicsSystem.stateEvent
Defined in
src/sdk/system/BasicAvionicsSystem.ts:64
Accessors
state
• get state(): undefined | AvionicsSystemState
Returns
undefined | AvionicsSystemState
Inherit Doc
Inherited from
BasicAvionicsSystem.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
| Name | 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}` | The source to which to connect this system's power state. |
Returns
void
Inherited from
BasicAvionicsSystem.connectToPower
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
| Name | Type | Description |
|---|---|---|
isPowered | boolean | Whether or not the system is powered. |
Returns
void
Inherited from
BasicAvionicsSystem.onPowerChanged
Defined in
src/sdk/system/BasicAvionicsSystem.ts:140
onPowerValid
▸ onPowerValid(): void
Responds to when power data becomes valid.
Returns
void
Inherited from
BasicAvionicsSystem.onPowerValid
Defined in
src/sdk/system/BasicAvionicsSystem.ts:86
onStateChanged
▸ onStateChanged(previousState, currentState): void
Responds to changes in this system's state.
Parameters
| Name | Type | Description |
|---|---|---|
previousState | undefined | AvionicsSystemState | The previous state. |
currentState | AvionicsSystemState | The current state. |
Returns
void
Inherited from
BasicAvionicsSystem.onStateChanged
Defined in
src/sdk/system/BasicAvionicsSystem.ts:132
onUpdate
▸ onUpdate(): void
Returns
void
Inherit Doc
Inherited from
BasicAvionicsSystem.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
| Name | Type | Description |
|---|---|---|
state | AvionicsSystemState | The new state to change to. |
Returns
void
Inherited from
BasicAvionicsSystem.setState
Defined in
src/sdk/system/BasicAvionicsSystem.ts:117
updatePowerFromLogic
▸ updatePowerFromLogic(): void
Updates this system's power state from an electricity logic element.
Returns
void
Inherited from
BasicAvionicsSystem.updatePowerFromLogic
Defined in
src/sdk/system/BasicAvionicsSystem.ts:171