Class: WT21LNavDataSimVarPublisher
Defined in: workingtitle-instruments-wt21/shared/Systems/Autopilot/WT21LNavDataEvents.ts:66
A publisher for WT21 LNAV-related data sim var events.
Extends
SimVarPublisher<WT21LNavDataSimVarEvents>
Constructors
Constructor
new WT21LNavDataSimVarPublisher(
bus):WT21LNavDataSimVarPublisher
Defined in: workingtitle-instruments-wt21/shared/Systems/Autopilot/WT21LNavDataEvents.ts:87
Constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus to which to publish. |
Returns
WT21LNavDataSimVarPublisher
Overrides
SimVarPublisher<WT21LNavDataSimVarEvents>.constructor
Properties
bus
protectedreadonlybus:EventBus
Defined in: sdk/instruments/BasePublishers.ts:10
Inherited from
SimVarPublisher.bus
indexedSimVars
protectedreadonlyindexedSimVars:Map<"lnavdata_dtk_true"|"lnavdata_dtk_mag"|"lnavdata_xtk"|"lnavdata_cdi_scale"|"lnavdata_waypoint_bearing_true"|"lnavdata_waypoint_bearing_mag"|"lnavdata_waypoint_distance"|"lnavdata_destination_distance"|`lnavdata_dtk_true_${number}`|`lnavdata_dtk_mag_${number}`|`lnavdata_xtk_${number}`|`lnavdata_cdi_scale_${number}`|`lnavdata_waypoint_bearing_true_${number}`|`lnavdata_waypoint_bearing_mag_${number}`|`lnavdata_waypoint_distance_${number}`|`lnavdata_destination_distance_${number}`|"lnavdata_nominal_leg_index"|"lnavdata_cdi_scale_label"|"lnavdata_tracked_leg_end_distance"|"lnavdata_destination_distance_direct"|"lnavdata_distance_to_faf",IndexedSimVarPublisherEntry<any>>
Defined in: sdk/instruments/BasePublishers.ts:149
Inherited from
SimVarPublisher.indexedSimVars
pacer
protectedreadonlypacer:undefined|PublishPacer<WT21LNavDataSimVarEvents>
Defined in: sdk/instruments/BasePublishers.ts:13
Inherited from
SimVarPublisher.pacer
publishActive
protectedpublishActive:boolean
Defined in: sdk/instruments/BasePublishers.ts:12
Inherited from
SimVarPublisher.publishActive
publisher
protectedreadonlypublisher:Publisher<WT21LNavDataSimVarEvents>
Defined in: sdk/instruments/BasePublishers.ts:11
Inherited from
SimVarPublisher.publisher
resolvedSimVars
protectedreadonlyresolvedSimVars:Map<"lnavdata_dtk_true"|"lnavdata_dtk_mag"|"lnavdata_xtk"|"lnavdata_cdi_scale"|"lnavdata_waypoint_bearing_true"|"lnavdata_waypoint_bearing_mag"|"lnavdata_waypoint_distance"|"lnavdata_destination_distance"|`lnavdata_dtk_true_${number}`|`lnavdata_dtk_mag_${number}`|`lnavdata_xtk_${number}`|`lnavdata_cdi_scale_${number}`|`lnavdata_waypoint_bearing_true_${number}`|`lnavdata_waypoint_bearing_mag_${number}`|`lnavdata_waypoint_distance_${number}`|`lnavdata_destination_distance_${number}`|"lnavdata_nominal_leg_index"|"lnavdata_cdi_scale_label"|"lnavdata_tracked_leg_end_distance"|"lnavdata_destination_distance_direct"|"lnavdata_distance_to_faf",ResolvedSimVarPublisherEntry<any>>
Defined in: sdk/instruments/BasePublishers.ts:147
Inherited from
SimVarPublisher.resolvedSimVars
subscribed
protectedreadonlysubscribed:Set<"lnavdata_dtk_true"|"lnavdata_dtk_mag"|"lnavdata_xtk"|"lnavdata_cdi_scale"|"lnavdata_waypoint_bearing_true"|"lnavdata_waypoint_bearing_mag"|"lnavdata_waypoint_distance"|"lnavdata_destination_distance"|`lnavdata_dtk_true_${number}`|`lnavdata_dtk_mag_${number}`|`lnavdata_xtk_${number}`|`lnavdata_cdi_scale_${number}`|`lnavdata_waypoint_bearing_true_${number}`|`lnavdata_waypoint_bearing_mag_${number}`|`lnavdata_waypoint_distance_${number}`|`lnavdata_destination_distance_${number}`|"lnavdata_nominal_leg_index"|"lnavdata_cdi_scale_label"|"lnavdata_tracked_leg_end_distance"|"lnavdata_destination_distance_direct"|"lnavdata_distance_to_faf">
Defined in: sdk/instruments/BasePublishers.ts:151
Inherited from
SimVarPublisher.subscribed
INDEXED_REGEX
protectedreadonlystaticINDEXED_REGEX:RegExp
Defined in: sdk/instruments/BasePublishers.ts:145
Inherited from
SimVarPublisher.INDEXED_REGEX
Methods
getValue()
protectedgetValue<K>(topic):undefined|WT21LNavDataSimVarEvents[K]
Defined in: sdk/instruments/BasePublishers.ts:343
Gets the current value for a topic.
Type Parameters
| Type Parameter |
|---|
K extends "lnavdata_dtk_true" | "lnavdata_dtk_mag" | "lnavdata_xtk" | "lnavdata_cdi_scale" | "lnavdata_waypoint_bearing_true" | "lnavdata_waypoint_bearing_mag" | "lnavdata_waypoint_distance" | "lnavdata_destination_distance" | `lnavdata_dtk_true_${number}` | `lnavdata_dtk_mag_${number}` | `lnavdata_xtk_${number}` | `lnavdata_cdi_scale_${number}` | `lnavdata_waypoint_bearing_true_${number}` | `lnavdata_waypoint_bearing_mag_${number}` | `lnavdata_waypoint_distance_${number}` | `lnavdata_destination_distance_${number}` | "lnavdata_nominal_leg_index" | "lnavdata_cdi_scale_label" | "lnavdata_tracked_leg_end_distance" | "lnavdata_destination_distance_direct" | "lnavdata_distance_to_faf" |
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | K | A topic. |
Returns
undefined | WT21LNavDataSimVarEvents[K]
The current value for the specified topic.
Inherited from
SimVarPublisher.getValue
getValueFromEntry()
protectedgetValueFromEntry<T>(entry):T
Defined in: sdk/instruments/BasePublishers.ts:357
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: sdk/instruments/BasePublishers.ts:193
Handles when an event bus topic is subscribed to for the first time.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | string | The subscribed topic. |
Returns
void
Inherited from
SimVarPublisher.handleSubscribedTopic
isPublishing()
isPublishing():
boolean
Defined in: 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
SimVarPublisher.isPublishing
onTopicSubscribed()
protectedonTopicSubscribed(topic):void
Defined in: sdk/instruments/BasePublishers.ts:279
Responds to when one of this publisher's topics is subscribed to for the first time.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | "lnavdata_dtk_true" | "lnavdata_dtk_mag" | "lnavdata_xtk" | "lnavdata_cdi_scale" | "lnavdata_waypoint_bearing_true" | "lnavdata_waypoint_bearing_mag" | "lnavdata_waypoint_distance" | "lnavdata_destination_distance" | `lnavdata_dtk_true_${number}` | `lnavdata_dtk_mag_${number}` | `lnavdata_xtk_${number}` | `lnavdata_cdi_scale_${number}` | `lnavdata_waypoint_bearing_true_${number}` | `lnavdata_waypoint_bearing_mag_${number}` | `lnavdata_waypoint_distance_${number}` | `lnavdata_destination_distance_${number}` | "lnavdata_nominal_leg_index" | "lnavdata_cdi_scale_label" | "lnavdata_tracked_leg_end_distance" | "lnavdata_destination_distance_direct" | "lnavdata_distance_to_faf" | The topic that was subscribed to. |
Returns
void
Inherited from
SimVarPublisher.onTopicSubscribed
onUpdate()
onUpdate():
void
Defined in: sdk/instruments/BasePublishers.ts:315
Publish all subscribed data points to the bus.
Returns
void
Inherited from
SimVarPublisher.onUpdate
publish()
protectedpublish<K>(topic,data,sync,isCached):void
Defined in: sdk/instruments/BasePublishers.ts:63
Publish a message if publishing is acpive
Type Parameters
| Type Parameter |
|---|
K extends keyof WT21LNavDataSimVarEvents |
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | WT21LNavDataSimVarEvents[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
SimVarPublisher.publish
publishTopic()
protectedpublishTopic(topic):void
Defined in: sdk/instruments/BasePublishers.ts:325
Publishes data to the event bus for a topic.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | "lnavdata_dtk_true" | "lnavdata_dtk_mag" | "lnavdata_xtk" | "lnavdata_cdi_scale" | "lnavdata_waypoint_bearing_true" | "lnavdata_waypoint_bearing_mag" | "lnavdata_waypoint_distance" | "lnavdata_destination_distance" | `lnavdata_dtk_true_${number}` | `lnavdata_dtk_mag_${number}` | `lnavdata_xtk_${number}` | `lnavdata_cdi_scale_${number}` | `lnavdata_waypoint_bearing_true_${number}` | `lnavdata_waypoint_bearing_mag_${number}` | `lnavdata_waypoint_distance_${number}` | `lnavdata_destination_distance_${number}` | "lnavdata_nominal_leg_index" | "lnavdata_cdi_scale_label" | "lnavdata_tracked_leg_end_distance" | "lnavdata_destination_distance_direct" | "lnavdata_distance_to_faf" | The topic to publish. |
Returns
void
Inherited from
SimVarPublisher.publishTopic
resolveIndexedSimVar()
protectedresolveIndexedSimVar(topic,entry,index):undefined|string
Defined in: sdk/instruments/BasePublishers.ts:250
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 | "lnavdata_dtk_true" | "lnavdata_dtk_mag" | "lnavdata_xtk" | "lnavdata_cdi_scale" | "lnavdata_waypoint_bearing_true" | "lnavdata_waypoint_bearing_mag" | "lnavdata_waypoint_distance" | "lnavdata_destination_distance" | `lnavdata_dtk_true_${number}` | `lnavdata_dtk_mag_${number}` | `lnavdata_xtk_${number}` | `lnavdata_cdi_scale_${number}` | `lnavdata_waypoint_bearing_true_${number}` | `lnavdata_waypoint_bearing_mag_${number}` | `lnavdata_waypoint_distance_${number}` | `lnavdata_destination_distance_${number}` | "lnavdata_nominal_leg_index" | "lnavdata_cdi_scale_label" | "lnavdata_tracked_leg_end_distance" | "lnavdata_destination_distance_direct" | "lnavdata_distance_to_faf" | 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: sdk/instruments/BasePublishers.ts:30
Start publishing.
Returns
void
Inherited from
SimVarPublisher.startPublish
stopPublish()
stopPublish():
void
Defined in: sdk/instruments/BasePublishers.ts:37
Stop publishing.
Returns
void
Inherited from
SimVarPublisher.stopPublish
subscribe()
subscribe(
data):void
Defined in: sdk/instruments/BasePublishers.ts:298
NOOP - For backwards compatibility.
Parameters
| Parameter | Type | Description |
|---|---|---|
data | keyof WT21LNavDataSimVarEvents | Key of the event type in the simVarMap |
Returns
void
Deprecated
Inherited from
SimVarPublisher.subscribe
tryMatchIndexedSubscribedTopic()
protectedtryMatchIndexedSubscribedTopic(topic):void
Defined in: sdk/instruments/BasePublishers.ts:208
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
Inherited from
SimVarPublisher.tryMatchIndexedSubscribedTopic
unsubscribe()
unsubscribe(
data):void
Defined in: sdk/instruments/BasePublishers.ts:308
NOOP - For backwards compatibility.
Parameters
| Parameter | Type | Description |
|---|---|---|
data | keyof WT21LNavDataSimVarEvents | Key of the event type in the simVarMap |
Returns
void
Deprecated
Inherited from
SimVarPublisher.unsubscribe