Class: NavComSimVarPublisher
A publisher of NAV, COM, ADF radio and marker beacon tuning-related sim var events.
Hierarchy
SimVarPublisher
<NavComEvents
,NavComIndexedEventRoots
>↳
NavComSimVarPublisher
Constructors
constructor
• new NavComSimVarPublisher(bus
, pacer?
): NavComSimVarPublisher
Creates a new instance of NavComSimVarPublisher.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
bus | EventBus | undefined | The event bus to which to publish. |
pacer | undefined | PublishPacer <NavComEvents > | undefined | An optional pacer to use to control the pace of publishing |
Returns
Overrides
Defined in
src/sdk/instruments/NavCom.ts:302
Properties
bus
• Protected
Readonly
bus: EventBus
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:10
indexedSimVars
• Protected
Readonly
indexedSimVars: Map
<"nav_active_frequency"
| "nav_standby_frequency"
| "nav_ident"
| "nav_signal"
| "nav_sound"
| "nav_volume"
| "nav_obs"
| "nav_has_dme"
| "nav_has_nav"
| "nav_cdi"
| "nav_dme"
| "nav_radial"
| "nav_radial_error"
| "nav_to_from"
| "nav_localizer"
| "nav_localizer_crs"
| "nav_loc_airport_ident"
| "nav_loc_runway_number"
| "nav_loc_runway_designator"
| "nav_glideslope"
| "nav_raw_gs"
| "nav_gs_error"
| "nav_lla"
| "nav_dme_lla"
| "nav_gs_lla"
| "nav_magvar"
| "com_active_frequency"
| "com_standby_frequency"
| "com_active_facility_name"
| "com_active_facility_type"
| "com_active_facility_ident"
| "com_receive"
| "com_status"
| "com_transmit"
| "com_spacing_mode"
| "com_volume"
| "adf_active_frequency"
| "adf_standby_frequency"
| "adf_sound"
| "adf_volume"
| "adf_ident"
| "adf_signal"
| "adf_bearing"
| "adf_lla"
| "marker_beacon_hisense_on"
| "marker_beacon_sound"
| "marker_beacon_state"
| "mkr_bcn_state_simvar"
| "gps_dtk"
| "gps_xtk"
| "gps_wp"
| "gps_wp_bearing"
| "gps_wp_distance"
| "gps_obs_active_simvar"
| "gps_obs_value_simvar"
, IndexedSimVarPublisherEntry
<any
>>
Inherited from
SimVarPublisher.indexedSimVars
Defined in
src/sdk/instruments/BasePublishers.ts:149
pacer
• Protected
Readonly
pacer: undefined
| PublishPacer
<NavComEvents
>
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:13
publishActive
• Protected
publishActive: boolean
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:12
publisher
• Protected
Readonly
publisher: Publisher
<NavComEvents
>
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:11
resolvedSimVars
• Protected
Readonly
resolvedSimVars: Map
<"nav_active_frequency_1"
| "nav_standby_frequency_1"
| "nav_ident_1"
| "nav_signal_1"
| "nav_sound_1"
| "nav_volume_1"
| "nav_obs_1"
| "nav_has_dme_1"
| "nav_has_nav_1"
| "nav_cdi_1"
| "nav_dme_1"
| "nav_radial_1"
| "nav_radial_error_1"
| "nav_to_from_1"
| "nav_localizer_1"
| "nav_localizer_crs_1"
| "nav_loc_airport_ident_1"
| "nav_loc_runway_number_1"
| "nav_loc_runway_designator_1"
| "nav_glideslope_1"
| "nav_raw_gs_1"
| "nav_gs_error_1"
| "nav_lla_1"
| "nav_dme_lla_1"
| "nav_gs_lla_1"
| "nav_magvar_1"
| "nav_active_frequency_2"
| "nav_standby_frequency_2"
| "nav_ident_2"
| "nav_signal_2"
| "nav_sound_2"
| "nav_volume_2"
| "nav_obs_2"
| "nav_has_dme_2"
| "nav_has_nav_2"
| "nav_cdi_2"
| "nav_dme_2"
| "nav_radial_2"
| "nav_radial_error_2"
| "nav_to_from_2"
| "nav_localizer_2"
| "nav_localizer_crs_2"
| "nav_loc_airport_ident_2"
| "nav_loc_runway_number_2"
| "nav_loc_runway_designator_2"
| "nav_glideslope_2"
| "nav_raw_gs_2"
| "nav_gs_error_2"
| "nav_lla_2"
| "nav_dme_lla_2"
| "nav_gs_lla_2"
| "nav_magvar_2"
| "nav_active_frequency_3"
| "nav_standby_frequency_3"
| "nav_ident_3"
| "nav_signal_3"
| "nav_sound_3"
| "nav_volume_3"
| "nav_obs_3"
| "nav_has_dme_3"
| "nav_has_nav_3"
| "nav_cdi_3"
| "nav_dme_3"
| "nav_radial_3"
| "nav_radial_error_3"
| "nav_to_from_3"
| "nav_localizer_3"
| "nav_localizer_crs_3"
| "nav_loc_airport_ident_3"
| "nav_loc_runway_number_3"
| "nav_loc_runway_designator_3"
| "nav_glideslope_3"
| "nav_raw_gs_3"
| "nav_gs_error_3"
| "nav_lla_3"
| "nav_dme_lla_3"
| "nav_gs_lla_3"
| "nav_magvar_3"
| "nav_active_frequency_4"
| "nav_standby_frequency_4"
| "nav_ident_4"
| "nav_signal_4"
| "nav_sound_4"
| "nav_volume_4"
| "nav_obs_4"
| "nav_has_dme_4"
| "nav_has_nav_4"
| "nav_cdi_4"
| "nav_dme_4"
| "nav_radial_4"
| "nav_radial_error_4"
| "nav_to_from_4"
| "nav_localizer_4"
| "nav_localizer_crs_4"
| "nav_loc_airport_ident_4"
| "nav_loc_runway_number_4"
| "nav_loc_runway_designator_4"
| "nav_glideslope_4"
| "nav_raw_gs_4"
| "nav_gs_error_4"
| "nav_lla_4"
| "nav_dme_lla_4"
| "nav_gs_lla_4"
| "nav_magvar_4"
| "com_active_frequency_1"
| "com_standby_frequency_1"
| "com_active_facility_name_1"
| "com_active_facility_type_1"
| "com_active_facility_ident_1"
| "com_receive_1"
| "com_status_1"
| "com_transmit_1"
| "com_spacing_mode_1"
| "com_volume_1"
| "com_active_frequency_2"
| "com_standby_frequency_2"
| "com_active_facility_name_2"
| "com_active_facility_type_2"
| "com_active_facility_ident_2"
| "com_receive_2"
| "com_status_2"
| "com_transmit_2"
| "com_spacing_mode_2"
| "com_volume_2"
| "com_active_frequency_3"
| "com_standby_frequency_3"
| "com_active_facility_name_3"
| "com_active_facility_type_3"
| "com_active_facility_ident_3"
| "com_receive_3"
| "com_status_3"
| "com_transmit_3"
| "com_spacing_mode_3"
| "com_volume_3"
| "adf_active_frequency_1"
| "adf_standby_frequency_1"
| "adf_sound_1"
| "adf_volume_1"
| "adf_ident_1"
| "adf_signal_1"
| "adf_bearing_1"
| "adf_lla_1"
| "adf_active_frequency_2"
| "adf_standby_frequency_2"
| "adf_sound_2"
| "adf_volume_2"
| "adf_ident_2"
| "adf_signal_2"
| "adf_bearing_2"
| "adf_lla_2"
| "marker_beacon_hisense_on"
| "marker_beacon_sound"
| "marker_beacon_state"
| "mkr_bcn_state_simvar"
| "gps_dtk"
| "gps_xtk"
| "gps_wp"
| "gps_wp_bearing"
| "gps_wp_distance"
| "gps_obs_active_simvar"
| "gps_obs_value_simvar"
, ResolvedSimVarPublisherEntry
<any
>>
Inherited from
SimVarPublisher.resolvedSimVars
Defined in
src/sdk/instruments/BasePublishers.ts:147
subscribed
• Protected
Readonly
subscribed: Set
<"nav_active_frequency_1"
| "nav_standby_frequency_1"
| "nav_ident_1"
| "nav_signal_1"
| "nav_sound_1"
| "nav_volume_1"
| "nav_obs_1"
| "nav_has_dme_1"
| "nav_has_nav_1"
| "nav_cdi_1"
| "nav_dme_1"
| "nav_radial_1"
| "nav_radial_error_1"
| "nav_to_from_1"
| "nav_localizer_1"
| "nav_localizer_crs_1"
| "nav_loc_airport_ident_1"
| "nav_loc_runway_number_1"
| "nav_loc_runway_designator_1"
| "nav_glideslope_1"
| "nav_raw_gs_1"
| "nav_gs_error_1"
| "nav_lla_1"
| "nav_dme_lla_1"
| "nav_gs_lla_1"
| "nav_magvar_1"
| "nav_active_frequency_2"
| "nav_standby_frequency_2"
| "nav_ident_2"
| "nav_signal_2"
| "nav_sound_2"
| "nav_volume_2"
| "nav_obs_2"
| "nav_has_dme_2"
| "nav_has_nav_2"
| "nav_cdi_2"
| "nav_dme_2"
| "nav_radial_2"
| "nav_radial_error_2"
| "nav_to_from_2"
| "nav_localizer_2"
| "nav_localizer_crs_2"
| "nav_loc_airport_ident_2"
| "nav_loc_runway_number_2"
| "nav_loc_runway_designator_2"
| "nav_glideslope_2"
| "nav_raw_gs_2"
| "nav_gs_error_2"
| "nav_lla_2"
| "nav_dme_lla_2"
| "nav_gs_lla_2"
| "nav_magvar_2"
| "nav_active_frequency_3"
| "nav_standby_frequency_3"
| "nav_ident_3"
| "nav_signal_3"
| "nav_sound_3"
| "nav_volume_3"
| "nav_obs_3"
| "nav_has_dme_3"
| "nav_has_nav_3"
| "nav_cdi_3"
| "nav_dme_3"
| "nav_radial_3"
| "nav_radial_error_3"
| "nav_to_from_3"
| "nav_localizer_3"
| "nav_localizer_crs_3"
| "nav_loc_airport_ident_3"
| "nav_loc_runway_number_3"
| "nav_loc_runway_designator_3"
| "nav_glideslope_3"
| "nav_raw_gs_3"
| "nav_gs_error_3"
| "nav_lla_3"
| "nav_dme_lla_3"
| "nav_gs_lla_3"
| "nav_magvar_3"
| "nav_active_frequency_4"
| "nav_standby_frequency_4"
| "nav_ident_4"
| "nav_signal_4"
| "nav_sound_4"
| "nav_volume_4"
| "nav_obs_4"
| "nav_has_dme_4"
| "nav_has_nav_4"
| "nav_cdi_4"
| "nav_dme_4"
| "nav_radial_4"
| "nav_radial_error_4"
| "nav_to_from_4"
| "nav_localizer_4"
| "nav_localizer_crs_4"
| "nav_loc_airport_ident_4"
| "nav_loc_runway_number_4"
| "nav_loc_runway_designator_4"
| "nav_glideslope_4"
| "nav_raw_gs_4"
| "nav_gs_error_4"
| "nav_lla_4"
| "nav_dme_lla_4"
| "nav_gs_lla_4"
| "nav_magvar_4"
| "com_active_frequency_1"
| "com_standby_frequency_1"
| "com_active_facility_name_1"
| "com_active_facility_type_1"
| "com_active_facility_ident_1"
| "com_receive_1"
| "com_status_1"
| "com_transmit_1"
| "com_spacing_mode_1"
| "com_volume_1"
| "com_active_frequency_2"
| "com_standby_frequency_2"
| "com_active_facility_name_2"
| "com_active_facility_type_2"
| "com_active_facility_ident_2"
| "com_receive_2"
| "com_status_2"
| "com_transmit_2"
| "com_spacing_mode_2"
| "com_volume_2"
| "com_active_frequency_3"
| "com_standby_frequency_3"
| "com_active_facility_name_3"
| "com_active_facility_type_3"
| "com_active_facility_ident_3"
| "com_receive_3"
| "com_status_3"
| "com_transmit_3"
| "com_spacing_mode_3"
| "com_volume_3"
| "adf_active_frequency_1"
| "adf_standby_frequency_1"
| "adf_sound_1"
| "adf_volume_1"
| "adf_ident_1"
| "adf_signal_1"
| "adf_bearing_1"
| "adf_lla_1"
| "adf_active_frequency_2"
| "adf_standby_frequency_2"
| "adf_sound_2"
| "adf_volume_2"
| "adf_ident_2"
| "adf_signal_2"
| "adf_bearing_2"
| "adf_lla_2"
| "marker_beacon_hisense_on"
| "marker_beacon_sound"
| "marker_beacon_state"
| "mkr_bcn_state_simvar"
| "gps_dtk"
| "gps_xtk"
| "gps_wp"
| "gps_wp_bearing"
| "gps_wp_distance"
| "gps_obs_active_simvar"
| "gps_obs_value_simvar"
>
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:151
INDEXED_REGEX
▪ Static
Protected
Readonly
INDEXED_REGEX: RegExp
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:145
Methods
getValue
▸ getValue<K
>(topic
): undefined
| NavComEvents
[K
]
Gets the current value for a topic.
Type parameters
Name | Type |
---|---|
K | extends "nav_active_frequency_1" | "nav_standby_frequency_1" | "nav_ident_1" | "nav_signal_1" | "nav_sound_1" | "nav_volume_1" | "nav_obs_1" | "nav_has_dme_1" | "nav_has_nav_1" | "nav_cdi_1" | "nav_dme_1" | "nav_radial_1" | "nav_radial_error_1" | "nav_to_from_1" | "nav_localizer_1" | "nav_localizer_crs_1" | "nav_loc_airport_ident_1" | "nav_loc_runway_number_1" | "nav_loc_runway_designator_1" | "nav_glideslope_1" | "nav_raw_gs_1" | "nav_gs_error_1" | "nav_lla_1" | "nav_dme_lla_1" | "nav_gs_lla_1" | "nav_magvar_1" | "nav_active_frequency_2" | "nav_standby_frequency_2" | "nav_ident_2" | "nav_signal_2" | "nav_sound_2" | "nav_volume_2" | "nav_obs_2" | "nav_has_dme_2" | "nav_has_nav_2" | "nav_cdi_2" | "nav_dme_2" | "nav_radial_2" | "nav_radial_error_2" | "nav_to_from_2" | "nav_localizer_2" | "nav_localizer_crs_2" | "nav_loc_airport_ident_2" | "nav_loc_runway_number_2" | "nav_loc_runway_designator_2" | "nav_glideslope_2" | "nav_raw_gs_2" | "nav_gs_error_2" | "nav_lla_2" | "nav_dme_lla_2" | "nav_gs_lla_2" | "nav_magvar_2" | "nav_active_frequency_3" | "nav_standby_frequency_3" | "nav_ident_3" | "nav_signal_3" | "nav_sound_3" | "nav_volume_3" | "nav_obs_3" | "nav_has_dme_3" | "nav_has_nav_3" | "nav_cdi_3" | "nav_dme_3" | "nav_radial_3" | "nav_radial_error_3" | "nav_to_from_3" | "nav_localizer_3" | "nav_localizer_crs_3" | "nav_loc_airport_ident_3" | "nav_loc_runway_number_3" | "nav_loc_runway_designator_3" | "nav_glideslope_3" | "nav_raw_gs_3" | "nav_gs_error_3" | "nav_lla_3" | "nav_dme_lla_3" | "nav_gs_lla_3" | "nav_magvar_3" | "nav_active_frequency_4" | "nav_standby_frequency_4" | "nav_ident_4" | "nav_signal_4" | "nav_sound_4" | "nav_volume_4" | "nav_obs_4" | "nav_has_dme_4" | "nav_has_nav_4" | "nav_cdi_4" | "nav_dme_4" | "nav_radial_4" | "nav_radial_error_4" | "nav_to_from_4" | "nav_localizer_4" | "nav_localizer_crs_4" | "nav_loc_airport_ident_4" | "nav_loc_runway_number_4" | "nav_loc_runway_designator_4" | "nav_glideslope_4" | "nav_raw_gs_4" | "nav_gs_error_4" | "nav_lla_4" | "nav_dme_lla_4" | "nav_gs_lla_4" | "nav_magvar_4" | "com_active_frequency_1" | "com_standby_frequency_1" | "com_active_facility_name_1" | "com_active_facility_type_1" | "com_active_facility_ident_1" | "com_receive_1" | "com_status_1" | "com_transmit_1" | "com_spacing_mode_1" | "com_volume_1" | "com_active_frequency_2" | "com_standby_frequency_2" | "com_active_facility_name_2" | "com_active_facility_type_2" | "com_active_facility_ident_2" | "com_receive_2" | "com_status_2" | "com_transmit_2" | "com_spacing_mode_2" | "com_volume_2" | "com_active_frequency_3" | "com_standby_frequency_3" | "com_active_facility_name_3" | "com_active_facility_type_3" | "com_active_facility_ident_3" | "com_receive_3" | "com_status_3" | "com_transmit_3" | "com_spacing_mode_3" | "com_volume_3" | "adf_active_frequency_1" | "adf_standby_frequency_1" | "adf_sound_1" | "adf_volume_1" | "adf_ident_1" | "adf_signal_1" | "adf_bearing_1" | "adf_lla_1" | "adf_active_frequency_2" | "adf_standby_frequency_2" | "adf_sound_2" | "adf_volume_2" | "adf_ident_2" | "adf_signal_2" | "adf_bearing_2" | "adf_lla_2" | "marker_beacon_hisense_on" | "marker_beacon_sound" | "marker_beacon_state" | "mkr_bcn_state_simvar" | "gps_dtk" | "gps_xtk" | "gps_wp" | "gps_wp_bearing" | "gps_wp_distance" | "gps_obs_active_simvar" | "gps_obs_value_simvar" |
Parameters
Name | Type | Description |
---|---|---|
topic | K | A topic. |
Returns
undefined
| NavComEvents
[K
]
The current value for the specified topic.
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:343
getValueFromEntry
▸ getValueFromEntry<T
>(entry
): T
Gets the current value for a resolved topic entry.
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
entry | ResolvedSimVarPublisherEntry <T > | An entry for a resolved topic. |
Returns
T
The current value for the specified entry.
Inherited from
SimVarPublisher.getValueFromEntry
Defined in
src/sdk/instruments/BasePublishers.ts:357
handleSubscribedTopic
▸ handleSubscribedTopic(topic
): void
Handles when an event bus topic is subscribed to for the first time.
Parameters
Name | Type | Description |
---|---|---|
topic | string | The subscribed topic. |
Returns
void
Inherited from
SimVarPublisher.handleSubscribedTopic
Defined in
src/sdk/instruments/BasePublishers.ts:193
isPublishing
▸ isPublishing(): boolean
Tells whether or not the publisher is currently active.
Returns
boolean
True if the publisher is active, false otherwise.
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:45
onTopicSubscribed
▸ onTopicSubscribed(topic
): void
Responds to when one of this publisher's topics is subscribed to for the first time.
Parameters
Name | Type | Description |
---|---|---|
topic | "nav_active_frequency_1" | "nav_standby_frequency_1" | "nav_ident_1" | "nav_signal_1" | "nav_sound_1" | "nav_volume_1" | "nav_obs_1" | "nav_has_dme_1" | "nav_has_nav_1" | "nav_cdi_1" | "nav_dme_1" | "nav_radial_1" | "nav_radial_error_1" | "nav_to_from_1" | "nav_localizer_1" | "nav_localizer_crs_1" | "nav_loc_airport_ident_1" | "nav_loc_runway_number_1" | "nav_loc_runway_designator_1" | "nav_glideslope_1" | "nav_raw_gs_1" | "nav_gs_error_1" | "nav_lla_1" | "nav_dme_lla_1" | "nav_gs_lla_1" | "nav_magvar_1" | "nav_active_frequency_2" | "nav_standby_frequency_2" | "nav_ident_2" | "nav_signal_2" | "nav_sound_2" | "nav_volume_2" | "nav_obs_2" | "nav_has_dme_2" | "nav_has_nav_2" | "nav_cdi_2" | "nav_dme_2" | "nav_radial_2" | "nav_radial_error_2" | "nav_to_from_2" | "nav_localizer_2" | "nav_localizer_crs_2" | "nav_loc_airport_ident_2" | "nav_loc_runway_number_2" | "nav_loc_runway_designator_2" | "nav_glideslope_2" | "nav_raw_gs_2" | "nav_gs_error_2" | "nav_lla_2" | "nav_dme_lla_2" | "nav_gs_lla_2" | "nav_magvar_2" | "nav_active_frequency_3" | "nav_standby_frequency_3" | "nav_ident_3" | "nav_signal_3" | "nav_sound_3" | "nav_volume_3" | "nav_obs_3" | "nav_has_dme_3" | "nav_has_nav_3" | "nav_cdi_3" | "nav_dme_3" | "nav_radial_3" | "nav_radial_error_3" | "nav_to_from_3" | "nav_localizer_3" | "nav_localizer_crs_3" | "nav_loc_airport_ident_3" | "nav_loc_runway_number_3" | "nav_loc_runway_designator_3" | "nav_glideslope_3" | "nav_raw_gs_3" | "nav_gs_error_3" | "nav_lla_3" | "nav_dme_lla_3" | "nav_gs_lla_3" | "nav_magvar_3" | "nav_active_frequency_4" | "nav_standby_frequency_4" | "nav_ident_4" | "nav_signal_4" | "nav_sound_4" | "nav_volume_4" | "nav_obs_4" | "nav_has_dme_4" | "nav_has_nav_4" | "nav_cdi_4" | "nav_dme_4" | "nav_radial_4" | "nav_radial_error_4" | "nav_to_from_4" | "nav_localizer_4" | "nav_localizer_crs_4" | "nav_loc_airport_ident_4" | "nav_loc_runway_number_4" | "nav_loc_runway_designator_4" | "nav_glideslope_4" | "nav_raw_gs_4" | "nav_gs_error_4" | "nav_lla_4" | "nav_dme_lla_4" | "nav_gs_lla_4" | "nav_magvar_4" | "com_active_frequency_1" | "com_standby_frequency_1" | "com_active_facility_name_1" | "com_active_facility_type_1" | "com_active_facility_ident_1" | "com_receive_1" | "com_status_1" | "com_transmit_1" | "com_spacing_mode_1" | "com_volume_1" | "com_active_frequency_2" | "com_standby_frequency_2" | "com_active_facility_name_2" | "com_active_facility_type_2" | "com_active_facility_ident_2" | "com_receive_2" | "com_status_2" | "com_transmit_2" | "com_spacing_mode_2" | "com_volume_2" | "com_active_frequency_3" | "com_standby_frequency_3" | "com_active_facility_name_3" | "com_active_facility_type_3" | "com_active_facility_ident_3" | "com_receive_3" | "com_status_3" | "com_transmit_3" | "com_spacing_mode_3" | "com_volume_3" | "adf_active_frequency_1" | "adf_standby_frequency_1" | "adf_sound_1" | "adf_volume_1" | "adf_ident_1" | "adf_signal_1" | "adf_bearing_1" | "adf_lla_1" | "adf_active_frequency_2" | "adf_standby_frequency_2" | "adf_sound_2" | "adf_volume_2" | "adf_ident_2" | "adf_signal_2" | "adf_bearing_2" | "adf_lla_2" | "marker_beacon_hisense_on" | "marker_beacon_sound" | "marker_beacon_state" | "mkr_bcn_state_simvar" | "gps_dtk" | "gps_xtk" | "gps_wp" | "gps_wp_bearing" | "gps_wp_distance" | "gps_obs_active_simvar" | "gps_obs_value_simvar" | The topic that was subscribed to. |
Returns
void
Inherited from
SimVarPublisher.onTopicSubscribed
Defined in
src/sdk/instruments/BasePublishers.ts:279
onUpdate
▸ onUpdate(): void
Publish all subscribed data points to the bus.
Returns
void
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:315
publish
▸ publish<K
>(topic
, data
, sync?
, isCached?
): void
Publish a message if publishing is acpive
Type parameters
Name | Type |
---|---|
K | extends keyof NavComEvents |
Parameters
Name | Type | Default value | Description |
---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | NavComEvents [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
Defined in
src/sdk/instruments/BasePublishers.ts:63
publishTopic
▸ publishTopic(topic
): void
Publishes data to the event bus for a topic.
Parameters
Name | Type | Description |
---|---|---|
topic | "nav_active_frequency_1" | "nav_standby_frequency_1" | "nav_ident_1" | "nav_signal_1" | "nav_sound_1" | "nav_volume_1" | "nav_obs_1" | "nav_has_dme_1" | "nav_has_nav_1" | "nav_cdi_1" | "nav_dme_1" | "nav_radial_1" | "nav_radial_error_1" | "nav_to_from_1" | "nav_localizer_1" | "nav_localizer_crs_1" | "nav_loc_airport_ident_1" | "nav_loc_runway_number_1" | "nav_loc_runway_designator_1" | "nav_glideslope_1" | "nav_raw_gs_1" | "nav_gs_error_1" | "nav_lla_1" | "nav_dme_lla_1" | "nav_gs_lla_1" | "nav_magvar_1" | "nav_active_frequency_2" | "nav_standby_frequency_2" | "nav_ident_2" | "nav_signal_2" | "nav_sound_2" | "nav_volume_2" | "nav_obs_2" | "nav_has_dme_2" | "nav_has_nav_2" | "nav_cdi_2" | "nav_dme_2" | "nav_radial_2" | "nav_radial_error_2" | "nav_to_from_2" | "nav_localizer_2" | "nav_localizer_crs_2" | "nav_loc_airport_ident_2" | "nav_loc_runway_number_2" | "nav_loc_runway_designator_2" | "nav_glideslope_2" | "nav_raw_gs_2" | "nav_gs_error_2" | "nav_lla_2" | "nav_dme_lla_2" | "nav_gs_lla_2" | "nav_magvar_2" | "nav_active_frequency_3" | "nav_standby_frequency_3" | "nav_ident_3" | "nav_signal_3" | "nav_sound_3" | "nav_volume_3" | "nav_obs_3" | "nav_has_dme_3" | "nav_has_nav_3" | "nav_cdi_3" | "nav_dme_3" | "nav_radial_3" | "nav_radial_error_3" | "nav_to_from_3" | "nav_localizer_3" | "nav_localizer_crs_3" | "nav_loc_airport_ident_3" | "nav_loc_runway_number_3" | "nav_loc_runway_designator_3" | "nav_glideslope_3" | "nav_raw_gs_3" | "nav_gs_error_3" | "nav_lla_3" | "nav_dme_lla_3" | "nav_gs_lla_3" | "nav_magvar_3" | "nav_active_frequency_4" | "nav_standby_frequency_4" | "nav_ident_4" | "nav_signal_4" | "nav_sound_4" | "nav_volume_4" | "nav_obs_4" | "nav_has_dme_4" | "nav_has_nav_4" | "nav_cdi_4" | "nav_dme_4" | "nav_radial_4" | "nav_radial_error_4" | "nav_to_from_4" | "nav_localizer_4" | "nav_localizer_crs_4" | "nav_loc_airport_ident_4" | "nav_loc_runway_number_4" | "nav_loc_runway_designator_4" | "nav_glideslope_4" | "nav_raw_gs_4" | "nav_gs_error_4" | "nav_lla_4" | "nav_dme_lla_4" | "nav_gs_lla_4" | "nav_magvar_4" | "com_active_frequency_1" | "com_standby_frequency_1" | "com_active_facility_name_1" | "com_active_facility_type_1" | "com_active_facility_ident_1" | "com_receive_1" | "com_status_1" | "com_transmit_1" | "com_spacing_mode_1" | "com_volume_1" | "com_active_frequency_2" | "com_standby_frequency_2" | "com_active_facility_name_2" | "com_active_facility_type_2" | "com_active_facility_ident_2" | "com_receive_2" | "com_status_2" | "com_transmit_2" | "com_spacing_mode_2" | "com_volume_2" | "com_active_frequency_3" | "com_standby_frequency_3" | "com_active_facility_name_3" | "com_active_facility_type_3" | "com_active_facility_ident_3" | "com_receive_3" | "com_status_3" | "com_transmit_3" | "com_spacing_mode_3" | "com_volume_3" | "adf_active_frequency_1" | "adf_standby_frequency_1" | "adf_sound_1" | "adf_volume_1" | "adf_ident_1" | "adf_signal_1" | "adf_bearing_1" | "adf_lla_1" | "adf_active_frequency_2" | "adf_standby_frequency_2" | "adf_sound_2" | "adf_volume_2" | "adf_ident_2" | "adf_signal_2" | "adf_bearing_2" | "adf_lla_2" | "marker_beacon_hisense_on" | "marker_beacon_sound" | "marker_beacon_state" | "mkr_bcn_state_simvar" | "gps_dtk" | "gps_xtk" | "gps_wp" | "gps_wp_bearing" | "gps_wp_distance" | "gps_obs_active_simvar" | "gps_obs_value_simvar" | The topic to publish. |
Returns
void
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:325
resolveIndexedSimVar
▸ resolveIndexedSimVar(topic
, entry
, index
): undefined
| string
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
Name | Type | Description |
---|---|---|
topic | "nav_active_frequency" | "nav_standby_frequency" | "nav_ident" | "nav_signal" | "nav_sound" | "nav_volume" | "nav_obs" | "nav_has_dme" | "nav_has_nav" | "nav_cdi" | "nav_dme" | "nav_radial" | "nav_radial_error" | "nav_to_from" | "nav_localizer" | "nav_localizer_crs" | "nav_loc_airport_ident" | "nav_loc_runway_number" | "nav_loc_runway_designator" | "nav_glideslope" | "nav_raw_gs" | "nav_gs_error" | "nav_lla" | "nav_dme_lla" | "nav_gs_lla" | "nav_magvar" | "com_active_frequency" | "com_standby_frequency" | "com_active_facility_name" | "com_active_facility_type" | "com_active_facility_ident" | "com_receive" | "com_status" | "com_transmit" | "com_spacing_mode" | "com_volume" | "adf_active_frequency" | "adf_standby_frequency" | "adf_sound" | "adf_volume" | "adf_ident" | "adf_signal" | "adf_bearing" | "adf_lla" | "marker_beacon_hisense_on" | "marker_beacon_sound" | "marker_beacon_state" | "mkr_bcn_state_simvar" | "gps_dtk" | "gps_xtk" | "gps_wp" | "gps_wp_bearing" | "gps_wp_distance" | "gps_obs_active_simvar" | "gps_obs_value_simvar" | 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
Defined in
src/sdk/instruments/BasePublishers.ts:250
startPublish
▸ startPublish(): void
Start publishing.
Returns
void
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:30
stopPublish
▸ stopPublish(): void
Stop publishing.
Returns
void
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:37
subscribe
▸ subscribe(data
): void
NOOP - For backwards compatibility.
Parameters
Name | Type | Description |
---|---|---|
data | keyof NavComEvents | Key of the event type in the simVarMap |
Returns
void
Deprecated
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:298
tryMatchIndexedSubscribedTopic
▸ tryMatchIndexedSubscribedTopic(topic
): void
Checks if a subscribed topic matches one of this publisher's indexed topics, and if so resolves and starts publishing the indexed topic.
Parameters
Name | Type | Description |
---|---|---|
topic | string | The subscribed topic to check. |
Returns
void
Inherited from
SimVarPublisher.tryMatchIndexedSubscribedTopic
Defined in
src/sdk/instruments/BasePublishers.ts:208
unsubscribe
▸ unsubscribe(data
): void
NOOP - For backwards compatibility.
Parameters
Name | Type | Description |
---|---|---|
data | keyof NavComEvents | Key of the event type in the simVarMap |
Returns
void
Deprecated
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:308