Class: TrafficAvionicsSystem<T>
Defined in: src/garminsdk/system/TrafficAvionicsSystem.ts:15
A Garmin traffic avionics system.
Extends
BasicAvionicsSystem<TrafficAvionicsSystemEvents>
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends TrafficSystem | TrafficSystem |
Constructors
Constructor
new TrafficAvionicsSystem<
T>(bus,trafficSystem,powerSource?,initializationTime?):TrafficAvionicsSystem<T>
Defined in: src/garminsdk/system/TrafficAvionicsSystem.ts:24
Creates an instance of a traffic avionics system.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
bus | EventBus | undefined | An instance of the event bus. |
trafficSystem | T | undefined | This system's traffic system. |
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 ElectricalEvents topic or electricity logic element to which to connect the system's power. |
initializationTime? | number | 0 | The time required for the system to initialize, in milliseconds. Defaults to 0. |
Returns
TrafficAvionicsSystem<T>
Overrides
BasicAvionicsSystem<TrafficAvionicsSystemEvents>.constructor
Properties
_state
protected_state:undefined|AvionicsSystemState
Defined in: src/sdk/system/BasicAvionicsSystem.ts:32
Inherited from
BasicAvionicsSystem._state
bus
protectedreadonlybus:EventBus
Defined in: src/sdk/system/BasicAvionicsSystem.ts:63
The instance of the event bus for the system to use.
Inherited from
BasicAvionicsSystem.bus
electricalPowerLogic?
protectedoptionalelectricalPowerLogic:CompositeLogicXMLElement
Defined in: src/sdk/system/BasicAvionicsSystem.ts:48
Inherited from
BasicAvionicsSystem.electricalPowerLogic
electricalPowerSub?
protectedoptionalelectricalPowerSub:Subscription
Defined in: src/sdk/system/BasicAvionicsSystem.ts:47
Inherited from
BasicAvionicsSystem.electricalPowerSub
index
readonlyindex:number
Defined in: src/sdk/system/BasicAvionicsSystem.ts:62
The index of the system.
Inherited from
BasicAvionicsSystem.index
initializationTime
protectedinitializationTime: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
protectedreadonlyinitializationTimer:DebounceTimer
Defined in: src/sdk/system/BasicAvionicsSystem.ts:42
A timeout after which initialization will be complete.
Inherited from
BasicAvionicsSystem.initializationTimer
isPowered
protectedisPowered:undefined|boolean
Defined in: src/sdk/system/BasicAvionicsSystem.ts:45
Whether or not the system is powered.
Inherited from
BasicAvionicsSystem.isPowered
isPowerValid
protectedisPowerValid:boolean=false
Defined in: src/sdk/system/BasicAvionicsSystem.ts:53
Whether power data consumed by this system is valid.
Inherited from
BasicAvionicsSystem.isPowerValid
publisher
protectedreadonlypublisher:Publisher<TrafficAvionicsSystemEvents>
Defined in: src/sdk/system/BasicAvionicsSystem.ts:50
Inherited from
BasicAvionicsSystem.publisher
stateEvent
protectedreadonlystateEvent:"traffic_avionics_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
trafficSystem
readonlytrafficSystem:T
Defined in: src/garminsdk/system/TrafficAvionicsSystem.ts:26
This system's traffic system.
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
connectToPower()
protectedconnectToPower(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
onPowerChanged()
protectedonPowerChanged(isPowered):void
Defined in: src/sdk/system/BasicAvionicsSystem.ts:140
A callback called when the connected power state of the avionics system changes.
Parameters
| Parameter | Type | Description |
|---|---|---|
isPowered | boolean | Whether or not the system is powered. |
Returns
void
Inherited from
BasicAvionicsSystem.onPowerChanged
onPowerValid()
protectedonPowerValid():void
Defined in: src/sdk/system/BasicAvionicsSystem.ts:86
Responds to when power data becomes valid.
Returns
void
Inherited from
BasicAvionicsSystem.onPowerValid
onStateChanged()
protectedonStateChanged(previousState,currentState):void
Defined in: src/garminsdk/system/TrafficAvionicsSystem.ts:40
Parameters
| Parameter | Type |
|---|---|
previousState | undefined | AvionicsSystemState |
currentState | AvionicsSystemState |
Returns
void
Inherit Doc
Overrides
BasicAvionicsSystem.onStateChanged
onUpdate()
onUpdate():
void
Defined in: src/sdk/system/BasicAvionicsSystem.ts:164
Returns
void
Inherit Doc
Inherited from
BasicAvionicsSystem.onUpdate
setState()
protectedsetState(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
updatePowerFromLogic()
protectedupdatePowerFromLogic():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