Class: AdcPublisher
Defined in: src/sdk/instruments/Adc.ts:205
A publisher for air data computer information.
Extends
Constructors
Constructor
new AdcPublisher(
bus,pacer?):AdcPublisher
Defined in: src/sdk/instruments/Adc.ts:249
Creates an AdcPublisher.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus to which to publish. |
pacer? | PublishPacer<AdcEvents> | An optional pacer to use to control the rate of publishing. |
Returns
AdcPublisher
Overrides
Properties
bus
protectedreadonlybus:EventBus
Defined in: src/sdk/instruments/BasePublishers.ts:10
Inherited from
indexedSimVars
protectedreadonlyindexedSimVars:Map<"ias"|"tas"|"indicated_tas"|"indicated_mach_number"|"mach_to_kias_factor"|"tas_to_ias_factor"|"indicated_mach_to_kias_factor"|"indicated_tas_to_ias_factor"|"indicated_alt"|"altimeter_baro_setting_inhg"|"altimeter_baro_setting_mb"|"altimeter_baro_preselect_inhg"|"altimeter_baro_preselect_mb"|"altimeter_baro_preselect_raw"|"altimeter_baro_is_std"|"pressure_alt"|"vertical_speed"|"radio_alt"|"ambient_density"|"ambient_temp_c"|"ambient_pressure_inhg"|"isa_temp_c"|"ram_air_temp_c"|"ambient_wind_velocity"|"ambient_wind_direction"|"on_ground"|"aoa"|"sideslip_angle"|"stall_aoa"|"zero_lift_aoa"|"mach_number"|"density_alt"|"dynamic_pressure_inhg"|`ias_${number}`|`tas_${number}`|`indicated_tas_${number}`|`indicated_mach_number_${number}`|`mach_to_kias_factor_${number}`|`tas_to_ias_factor_${number}`|`indicated_mach_to_kias_factor_${number}`|`indicated_tas_to_ias_factor_${number}`|`indicated_alt_${number}`|`altimeter_baro_setting_inhg_${number}`|`altimeter_baro_setting_mb_${number}`|`altimeter_baro_preselect_inhg_${number}`|`altimeter_baro_preselect_mb_${number}`|`altimeter_baro_preselect_raw_${number}`|`altimeter_baro_is_std_${number}`,IndexedSimVarPublisherEntry<any>>
Defined in: src/sdk/instruments/BasePublishers.ts:153
Inherited from
SimVarPublisher.indexedSimVars
pacer
protectedreadonlypacer:undefined|PublishPacer<AdcEvents>
Defined in: src/sdk/instruments/BasePublishers.ts:13
Inherited from
publishActive
protectedpublishActive:boolean
Defined in: src/sdk/instruments/BasePublishers.ts:12
Inherited from
publisher
Defined in: src/sdk/instruments/BasePublishers.ts:11
Inherited from
resolvedSimVars
protectedreadonlyresolvedSimVars:Map<"ias"|"tas"|"indicated_tas"|"indicated_mach_number"|"mach_to_kias_factor"|"tas_to_ias_factor"|"indicated_mach_to_kias_factor"|"indicated_tas_to_ias_factor"|"indicated_alt"|"altimeter_baro_setting_inhg"|"altimeter_baro_setting_mb"|"altimeter_baro_preselect_inhg"|"altimeter_baro_preselect_mb"|"altimeter_baro_preselect_raw"|"altimeter_baro_is_std"|"pressure_alt"|"vertical_speed"|"radio_alt"|"ambient_density"|"ambient_temp_c"|"ambient_pressure_inhg"|"isa_temp_c"|"ram_air_temp_c"|"ambient_wind_velocity"|"ambient_wind_direction"|"on_ground"|"aoa"|"sideslip_angle"|"stall_aoa"|"zero_lift_aoa"|"mach_number"|"density_alt"|"dynamic_pressure_inhg"|`ias_${number}`|`tas_${number}`|`indicated_tas_${number}`|`indicated_mach_number_${number}`|`mach_to_kias_factor_${number}`|`tas_to_ias_factor_${number}`|`indicated_mach_to_kias_factor_${number}`|`indicated_tas_to_ias_factor_${number}`|`indicated_alt_${number}`|`altimeter_baro_setting_inhg_${number}`|`altimeter_baro_setting_mb_${number}`|`altimeter_baro_preselect_inhg_${number}`|`altimeter_baro_preselect_mb_${number}`|`altimeter_baro_preselect_raw_${number}`|`altimeter_baro_is_std_${number}`,ResolvedSimVarPublisherEntry<any>>
Defined in: src/sdk/instruments/BasePublishers.ts:151
Inherited from
SimVarPublisher.resolvedSimVars
subscribed
protectedreadonlysubscribed:Map<"ias"|"tas"|"indicated_tas"|"indicated_mach_number"|"mach_to_kias_factor"|"tas_to_ias_factor"|"indicated_mach_to_kias_factor"|"indicated_tas_to_ias_factor"|"indicated_alt"|"altimeter_baro_setting_inhg"|"altimeter_baro_setting_mb"|"altimeter_baro_preselect_inhg"|"altimeter_baro_preselect_mb"|"altimeter_baro_preselect_raw"|"altimeter_baro_is_std"|"pressure_alt"|"vertical_speed"|"radio_alt"|"ambient_density"|"ambient_temp_c"|"ambient_pressure_inhg"|"isa_temp_c"|"ram_air_temp_c"|"ambient_wind_velocity"|"ambient_wind_direction"|"on_ground"|"aoa"|"sideslip_angle"|"stall_aoa"|"zero_lift_aoa"|"mach_number"|"density_alt"|"dynamic_pressure_inhg"|`ias_${number}`|`tas_${number}`|`indicated_tas_${number}`|`indicated_mach_number_${number}`|`mach_to_kias_factor_${number}`|`tas_to_ias_factor_${number}`|`indicated_mach_to_kias_factor_${number}`|`indicated_tas_to_ias_factor_${number}`|`indicated_alt_${number}`|`altimeter_baro_setting_inhg_${number}`|`altimeter_baro_setting_mb_${number}`|`altimeter_baro_preselect_inhg_${number}`|`altimeter_baro_preselect_mb_${number}`|`altimeter_baro_preselect_raw_${number}`|`altimeter_baro_is_std_${number}`,ResolvedSimVarPublisherEntry<any>>
Defined in: src/sdk/instruments/BasePublishers.ts:155
Inherited from
INDEXED_REGEX
protectedreadonlystaticINDEXED_REGEX:RegExp
Defined in: src/sdk/instruments/BasePublishers.ts:149
Inherited from
Methods
getValue()
protectedgetValue<K>(topic):undefined|AdcEvents[K]
Defined in: src/sdk/instruments/BasePublishers.ts:328
Gets the current value for a topic.
Type Parameters
| Type Parameter |
|---|
K extends "ias" | "tas" | "indicated_tas" | "indicated_mach_number" | "mach_to_kias_factor" | "tas_to_ias_factor" | "indicated_mach_to_kias_factor" | "indicated_tas_to_ias_factor" | "indicated_alt" | "altimeter_baro_setting_inhg" | "altimeter_baro_setting_mb" | "altimeter_baro_preselect_inhg" | "altimeter_baro_preselect_mb" | "altimeter_baro_preselect_raw" | "altimeter_baro_is_std" | "pressure_alt" | "vertical_speed" | "radio_alt" | "ambient_density" | "ambient_temp_c" | "ambient_pressure_inhg" | "isa_temp_c" | "ram_air_temp_c" | "ambient_wind_velocity" | "ambient_wind_direction" | "on_ground" | "aoa" | "sideslip_angle" | "stall_aoa" | "zero_lift_aoa" | "mach_number" | "density_alt" | "dynamic_pressure_inhg" | `ias_${number}` | `tas_${number}` | `indicated_tas_${number}` | `indicated_mach_number_${number}` | `mach_to_kias_factor_${number}` | `tas_to_ias_factor_${number}` | `indicated_mach_to_kias_factor_${number}` | `indicated_tas_to_ias_factor_${number}` | `indicated_alt_${number}` | `altimeter_baro_setting_inhg_${number}` | `altimeter_baro_setting_mb_${number}` | `altimeter_baro_preselect_inhg_${number}` | `altimeter_baro_preselect_mb_${number}` | `altimeter_baro_preselect_raw_${number}` | `altimeter_baro_is_std_${number}` |
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | K | A topic. |
Returns
undefined | AdcEvents[K]
The current value for the specified topic.
Inherited from
getValueFromEntry()
protectedgetValueFromEntry<T>(entry):T
Defined in: src/sdk/instruments/BasePublishers.ts:342
Gets the current value for a resolved topic entry.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type | Description |
|---|---|---|
entry | ResolvedSimVarPublisherEntry<T> | An entry for a resolved topic. |
Returns
T
The current value for the specified entry.
Inherited from
SimVarPublisher.getValueFromEntry
handleSubscribedTopic()
protectedhandleSubscribedTopic(topic):void
Defined in: src/sdk/instruments/Adc.ts:295
Handles when an event bus topic is subscribed to for the first time.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | string | The subscribed topic. |
Returns
void
Overrides
SimVarPublisher.handleSubscribedTopic
isPublishing()
isPublishing():
boolean
Defined in: src/sdk/instruments/BasePublishers.ts:45
Tells whether or not the publisher is currently active.
Returns
boolean
True if the publisher is active, false otherwise.
Inherited from
onTopicSubscribed()
protectedonTopicSubscribed(topic):void
Defined in: src/sdk/instruments/Adc.ts:324
Responds to when one of this publisher's topics is subscribed to for the first time.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | keyof AdcEvents | The topic that was subscribed to. |
Returns
void
Overrides
SimVarPublisher.onTopicSubscribed
onUpdate()
onUpdate():
void
Defined in: src/sdk/instruments/Adc.ts:494
Publish all subscribed data points to the bus.
Returns
void
Overrides
publish()
protectedpublish<K>(topic,data,sync,isCached):void
Defined in: src/sdk/instruments/BasePublishers.ts:63
Publish a message if publishing is acpive
Type Parameters
| Type Parameter |
|---|
K extends keyof AdcEvents |
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | AdcEvents[K] | undefined | The data type for chosen topic. |
sync | boolean | false | Whether or not the event should be synced to other instruments. Defaults to false. |
isCached | boolean | true | Whether or not the event should be cached. Defaults to true. |
Returns
void
Inherited from
publishTopic()
protectedpublishTopic(topic,entry):void
Defined in: src/sdk/instruments/BasePublishers.ts:311
Publishes data to the event bus for a topic.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | "ias" | "tas" | "indicated_tas" | "indicated_mach_number" | "mach_to_kias_factor" | "tas_to_ias_factor" | "indicated_mach_to_kias_factor" | "indicated_tas_to_ias_factor" | "indicated_alt" | "altimeter_baro_setting_inhg" | "altimeter_baro_setting_mb" | "altimeter_baro_preselect_inhg" | "altimeter_baro_preselect_mb" | "altimeter_baro_preselect_raw" | "altimeter_baro_is_std" | "pressure_alt" | "vertical_speed" | "radio_alt" | "ambient_density" | "ambient_temp_c" | "ambient_pressure_inhg" | "isa_temp_c" | "ram_air_temp_c" | "ambient_wind_velocity" | "ambient_wind_direction" | "on_ground" | "aoa" | "sideslip_angle" | "stall_aoa" | "zero_lift_aoa" | "mach_number" | "density_alt" | "dynamic_pressure_inhg" | `ias_${number}` | `tas_${number}` | `indicated_tas_${number}` | `indicated_mach_number_${number}` | `mach_to_kias_factor_${number}` | `tas_to_ias_factor_${number}` | `indicated_mach_to_kias_factor_${number}` | `indicated_tas_to_ias_factor_${number}` | `indicated_alt_${number}` | `altimeter_baro_setting_inhg_${number}` | `altimeter_baro_setting_mb_${number}` | `altimeter_baro_preselect_inhg_${number}` | `altimeter_baro_preselect_mb_${number}` | `altimeter_baro_preselect_raw_${number}` | `altimeter_baro_is_std_${number}` | The topic to publish. |
entry | undefined | ResolvedSimVarPublisherEntry<any> | The entry corresponding to the topic |
Returns
void
Inherited from
resolveIndexedSimVar()
protectedresolveIndexedSimVar(topic,entry,index):undefined|string
Defined in: src/sdk/instruments/BasePublishers.ts:254
Attempts to resolve an indexed topic with an index, generating a version of the topic which is mapped to an indexed simvar. The resolved indexed topic can then be published.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | "ias" | "tas" | "indicated_tas" | "indicated_mach_number" | "mach_to_kias_factor" | "tas_to_ias_factor" | "indicated_mach_to_kias_factor" | "indicated_tas_to_ias_factor" | "indicated_alt" | "altimeter_baro_setting_inhg" | "altimeter_baro_setting_mb" | "altimeter_baro_preselect_inhg" | "altimeter_baro_preselect_mb" | "altimeter_baro_preselect_raw" | "altimeter_baro_is_std" | "pressure_alt" | "vertical_speed" | "radio_alt" | "ambient_density" | "ambient_temp_c" | "ambient_pressure_inhg" | "isa_temp_c" | "ram_air_temp_c" | "ambient_wind_velocity" | "ambient_wind_direction" | "on_ground" | "aoa" | "sideslip_angle" | "stall_aoa" | "zero_lift_aoa" | "mach_number" | "density_alt" | "dynamic_pressure_inhg" | `ias_${number}` | `tas_${number}` | `indicated_tas_${number}` | `indicated_mach_number_${number}` | `mach_to_kias_factor_${number}` | `tas_to_ias_factor_${number}` | `indicated_mach_to_kias_factor_${number}` | `indicated_tas_to_ias_factor_${number}` | `indicated_alt_${number}` | `altimeter_baro_setting_inhg_${number}` | `altimeter_baro_setting_mb_${number}` | `altimeter_baro_preselect_inhg_${number}` | `altimeter_baro_preselect_mb_${number}` | `altimeter_baro_preselect_raw_${number}` | `altimeter_baro_is_std_${number}` | The topic to resolve. |
entry | IndexedSimVarPublisherEntry<any> | The entry of the topic to resolve. |
index | number | The index with which to resolve the topic. If not defined, the topic will resolve to itself (without a suffix) and will be mapped the index-1 version of its simvar. |
Returns
undefined | string
The resolved indexed topic, or undefined if the topic could not be resolved with the specified index.
Inherited from
SimVarPublisher.resolveIndexedSimVar
startPublish()
startPublish():
void
Defined in: src/sdk/instruments/BasePublishers.ts:30
Start publishing.
Returns
void
Inherited from
stopPublish()
stopPublish():
void
Defined in: src/sdk/instruments/BasePublishers.ts:37
Stop publishing.
Returns
void
Inherited from
tryMatchIndexedSubscribedTopic()
protectedtryMatchIndexedSubscribedTopic(topic):void
Defined in: src/sdk/instruments/BasePublishers.ts:212
Checks if a subscribed topic matches one of this publisher's indexed topics, and if so resolves and starts publishing the indexed topic.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | string | The subscribed topic to check. |
Returns
void