Skip to main content

Class: WT21LNavDataSimVarPublisher

A publisher for WT21 LNAV-related data sim var events.

Hierarchy​

Constructors​

constructor​

• new WT21LNavDataSimVarPublisher(bus): WT21LNavDataSimVarPublisher

Constructor.

Parameters​

NameTypeDescription
busEventBusThe event bus to which to publish.

Returns​

WT21LNavDataSimVarPublisher

Overrides​

SimVarPublisher\<WT21LNavDataSimVarEvents\>.constructor

Defined in​

workingtitle-instruments-wt21/shared/Systems/Autopilot/WT21LNavDataEvents.ts:87

Properties​

bus​

• Protected Readonly bus: EventBus

Inherited from​

SimVarPublisher.bus

Defined in​

sdk/instruments/BasePublishers.ts:10

indexedSimVars​

• Protected Readonly indexedSimVars: 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>>

Inherited from​

SimVarPublisher.indexedSimVars

Defined in​

sdk/instruments/BasePublishers.ts:149

pacer​

• Protected Readonly pacer: undefined | PublishPacer<WT21LNavDataSimVarEvents>

Inherited from​

SimVarPublisher.pacer

Defined in​

sdk/instruments/BasePublishers.ts:13

publishActive​

• Protected publishActive: boolean

Inherited from​

SimVarPublisher.publishActive

Defined in​

sdk/instruments/BasePublishers.ts:12

publisher​

• Protected Readonly publisher: Publisher<WT21LNavDataSimVarEvents>

Inherited from​

SimVarPublisher.publisher

Defined in​

sdk/instruments/BasePublishers.ts:11

resolvedSimVars​

• Protected Readonly resolvedSimVars: 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>>

Inherited from​

SimVarPublisher.resolvedSimVars

Defined in​

sdk/instruments/BasePublishers.ts:147

subscribed​

• Protected Readonly subscribed: 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">

Inherited from​

SimVarPublisher.subscribed

Defined in​

sdk/instruments/BasePublishers.ts:151

INDEXED_REGEX​

▪ Static Protected Readonly INDEXED_REGEX: RegExp

Inherited from​

SimVarPublisher.INDEXED_REGEX

Defined in​

sdk/instruments/BasePublishers.ts:145

Methods​

getValue​

▸ getValue<K>(topic): undefined | WT21LNavDataSimVarEvents[K]

Gets the current value for a topic.

Type parameters​

NameType
Kextends "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​

NameTypeDescription
topicKA topic.

Returns​

undefined | WT21LNavDataSimVarEvents[K]

The current value for the specified topic.

Inherited from​

SimVarPublisher.getValue

Defined in​

sdk/instruments/BasePublishers.ts:343

getValueFromEntry​

▸ getValueFromEntry<T>(entry): T

Gets the current value for a resolved topic entry.

Type parameters​

Name
T

Parameters​

NameTypeDescription
entryResolvedSimVarPublisherEntry<T>An entry for a resolved topic.

Returns​

T

The current value for the specified entry.

Inherited from​

SimVarPublisher.getValueFromEntry

Defined in​

sdk/instruments/BasePublishers.ts:357

handleSubscribedTopic​

▸ handleSubscribedTopic(topic): void

Handles when an event bus topic is subscribed to for the first time.

Parameters​

NameTypeDescription
topicstringThe subscribed topic.

Returns​

void

Inherited from​

SimVarPublisher.handleSubscribedTopic

Defined in​

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​

SimVarPublisher.isPublishing

Defined in​

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​

NameTypeDescription
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

Defined in​

sdk/instruments/BasePublishers.ts:279

onUpdate​

▸ onUpdate(): void

Publish all subscribed data points to the bus.

Returns​

void

Inherited from​

SimVarPublisher.onUpdate

Defined in​

sdk/instruments/BasePublishers.ts:315

publish​

▸ publish<K>(topic, data, sync?, isCached?): void

Publish a message if publishing is acpive

Type parameters​

NameType
Kextends keyof WT21LNavDataSimVarEvents

Parameters​

NameTypeDefault valueDescription
topicKundefinedThe topic key to publish to.
dataWT21LNavDataSimVarEvents[K]undefinedThe data type for chosen topic.
syncbooleanfalseWhether or not the event should be synced to other instruments. Defaults to false.
isCachedbooleantrueWhether or not the event should be cached. Defaults to true.

Returns​

void

Inherited from​

SimVarPublisher.publish

Defined in​

sdk/instruments/BasePublishers.ts:63

publishTopic​

▸ publishTopic(topic): void

Publishes data to the event bus for a topic.

Parameters​

NameTypeDescription
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

Defined in​

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​

NameTypeDescription
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.
entryIndexedSimVarPublisherEntry<any>The entry of the topic to resolve.
indexnumberThe 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​

sdk/instruments/BasePublishers.ts:250

startPublish​

▸ startPublish(): void

Start publishing.

Returns​

void

Inherited from​

SimVarPublisher.startPublish

Defined in​

sdk/instruments/BasePublishers.ts:30

stopPublish​

▸ stopPublish(): void

Stop publishing.

Returns​

void

Inherited from​

SimVarPublisher.stopPublish

Defined in​

sdk/instruments/BasePublishers.ts:37

subscribe​

▸ subscribe(data): void

NOOP - For backwards compatibility.

Parameters​

NameTypeDescription
datakeyof WT21LNavDataSimVarEventsKey of the event type in the simVarMap

Returns​

void

Deprecated

Inherited from​

SimVarPublisher.subscribe

Defined in​

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​

NameTypeDescription
topicstringThe subscribed topic to check.

Returns​

void

Inherited from​

SimVarPublisher.tryMatchIndexedSubscribedTopic

Defined in​

sdk/instruments/BasePublishers.ts:208

unsubscribe​

▸ unsubscribe(data): void

NOOP - For backwards compatibility.

Parameters​

NameTypeDescription
datakeyof WT21LNavDataSimVarEventsKey of the event type in the simVarMap

Returns​

void

Deprecated

Inherited from​

SimVarPublisher.unsubscribe

Defined in​

sdk/instruments/BasePublishers.ts:308