Class: VNavSimVarPublisher
Defined in: src/sdk/autopilot/vnav/VNavEvents.ts:258
A publisher for VNAV events derived from SimVars.
Extends
Constructors
Constructor
new VNavSimVarPublisher(
bus):VNavSimVarPublisher
Defined in: src/sdk/autopilot/vnav/VNavEvents.ts:263
Creates a new instance of VNavSimVarPublisher.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus to which to publish. |
Returns
VNavSimVarPublisher
Overrides
Properties
bus
protectedreadonlybus:EventBus
Defined in: src/sdk/instruments/BasePublishers.ts:10
Inherited from
indexedSimVars
protectedreadonlyindexedSimVars:Map<"vnav_vertical_deviation"|"vnav_target_altitude"|"vnav_path_mode"|"vnav_path_available"|"vnav_state"|"vnav_altitude_capture_type"|"vnav_tod_distance"|"vnav_tod_leg_distance"|"vnav_bod_distance"|"vnav_tod_global_leg_index"|"vnav_bod_global_leg_index"|"vnav_toc_distance"|"vnav_toc_leg_distance"|"vnav_boc_distance"|"vnav_toc_global_leg_index"|"vnav_boc_global_leg_index"|"vnav_constraint_global_leg_index"|"vnav_constraint_altitude"|"vnav_next_constraint_altitude"|"vnav_fpa"|"vnav_required_vs"|"gp_approach_mode"|"gp_vertical_deviation"|"gp_distance"|"gp_fpa"|"gp_required_vs"|"gp_service_level"|"vnav_path_calculated"|"vnav_availability"|"vnav_altitude_constraint_details"|`vnav_vertical_deviation_${number}`|`vnav_target_altitude_${number}`|`vnav_path_mode_${number}`|`vnav_path_available_${number}`|`vnav_state_${number}`|`vnav_altitude_capture_type_${number}`|`vnav_tod_distance_${number}`|`vnav_tod_leg_distance_${number}`|`vnav_bod_distance_${number}`|`vnav_tod_global_leg_index_${number}`|`vnav_bod_global_leg_index_${number}`|`vnav_toc_distance_${number}`|`vnav_toc_leg_distance_${number}`|`vnav_boc_distance_${number}`|`vnav_toc_global_leg_index_${number}`|`vnav_boc_global_leg_index_${number}`|`vnav_constraint_global_leg_index_${number}`|`vnav_constraint_altitude_${number}`|`vnav_next_constraint_altitude_${number}`|`vnav_fpa_${number}`|`vnav_required_vs_${number}`|`gp_vertical_deviation_${number}`|`gp_distance_${number}`|`gp_fpa_${number}`|`gp_required_vs_${number}`|`gp_service_level_${number}`|`vnav_path_calculated_${number}`|`vnav_availability_${number}`|`vnav_altitude_constraint_details_${number}`,IndexedSimVarPublisherEntry<any>>
Defined in: src/sdk/instruments/BasePublishers.ts:153
Inherited from
SimVarPublisher.indexedSimVars
pacer
protectedreadonlypacer:undefined|PublishPacer<VNavEvents>
Defined in: src/sdk/instruments/BasePublishers.ts:13
Inherited from
publishActive
protectedpublishActive:boolean
Defined in: src/sdk/instruments/BasePublishers.ts:12
Inherited from
publisher
protectedreadonlypublisher:Publisher<VNavEvents>
Defined in: src/sdk/instruments/BasePublishers.ts:11
Inherited from
resolvedSimVars
protectedreadonlyresolvedSimVars:Map<"vnav_vertical_deviation"|"vnav_target_altitude"|"vnav_path_mode"|"vnav_path_available"|"vnav_state"|"vnav_altitude_capture_type"|"vnav_tod_distance"|"vnav_tod_leg_distance"|"vnav_bod_distance"|"vnav_tod_global_leg_index"|"vnav_bod_global_leg_index"|"vnav_toc_distance"|"vnav_toc_leg_distance"|"vnav_boc_distance"|"vnav_toc_global_leg_index"|"vnav_boc_global_leg_index"|"vnav_constraint_global_leg_index"|"vnav_constraint_altitude"|"vnav_next_constraint_altitude"|"vnav_fpa"|"vnav_required_vs"|"gp_approach_mode"|"gp_vertical_deviation"|"gp_distance"|"gp_fpa"|"gp_required_vs"|"gp_service_level"|"vnav_path_calculated"|"vnav_availability"|"vnav_altitude_constraint_details"|`vnav_vertical_deviation_${number}`|`vnav_target_altitude_${number}`|`vnav_path_mode_${number}`|`vnav_path_available_${number}`|`vnav_state_${number}`|`vnav_altitude_capture_type_${number}`|`vnav_tod_distance_${number}`|`vnav_tod_leg_distance_${number}`|`vnav_bod_distance_${number}`|`vnav_tod_global_leg_index_${number}`|`vnav_bod_global_leg_index_${number}`|`vnav_toc_distance_${number}`|`vnav_toc_leg_distance_${number}`|`vnav_boc_distance_${number}`|`vnav_toc_global_leg_index_${number}`|`vnav_boc_global_leg_index_${number}`|`vnav_constraint_global_leg_index_${number}`|`vnav_constraint_altitude_${number}`|`vnav_next_constraint_altitude_${number}`|`vnav_fpa_${number}`|`vnav_required_vs_${number}`|`gp_vertical_deviation_${number}`|`gp_distance_${number}`|`gp_fpa_${number}`|`gp_required_vs_${number}`|`gp_service_level_${number}`|`vnav_path_calculated_${number}`|`vnav_availability_${number}`|`vnav_altitude_constraint_details_${number}`,ResolvedSimVarPublisherEntry<any>>
Defined in: src/sdk/instruments/BasePublishers.ts:151
Inherited from
SimVarPublisher.resolvedSimVars
subscribed
protectedreadonlysubscribed:Map<"vnav_vertical_deviation"|"vnav_target_altitude"|"vnav_path_mode"|"vnav_path_available"|"vnav_state"|"vnav_altitude_capture_type"|"vnav_tod_distance"|"vnav_tod_leg_distance"|"vnav_bod_distance"|"vnav_tod_global_leg_index"|"vnav_bod_global_leg_index"|"vnav_toc_distance"|"vnav_toc_leg_distance"|"vnav_boc_distance"|"vnav_toc_global_leg_index"|"vnav_boc_global_leg_index"|"vnav_constraint_global_leg_index"|"vnav_constraint_altitude"|"vnav_next_constraint_altitude"|"vnav_fpa"|"vnav_required_vs"|"gp_approach_mode"|"gp_vertical_deviation"|"gp_distance"|"gp_fpa"|"gp_required_vs"|"gp_service_level"|"vnav_path_calculated"|"vnav_availability"|"vnav_altitude_constraint_details"|`vnav_vertical_deviation_${number}`|`vnav_target_altitude_${number}`|`vnav_path_mode_${number}`|`vnav_path_available_${number}`|`vnav_state_${number}`|`vnav_altitude_capture_type_${number}`|`vnav_tod_distance_${number}`|`vnav_tod_leg_distance_${number}`|`vnav_bod_distance_${number}`|`vnav_tod_global_leg_index_${number}`|`vnav_bod_global_leg_index_${number}`|`vnav_toc_distance_${number}`|`vnav_toc_leg_distance_${number}`|`vnav_boc_distance_${number}`|`vnav_toc_global_leg_index_${number}`|`vnav_boc_global_leg_index_${number}`|`vnav_constraint_global_leg_index_${number}`|`vnav_constraint_altitude_${number}`|`vnav_next_constraint_altitude_${number}`|`vnav_fpa_${number}`|`vnav_required_vs_${number}`|`gp_vertical_deviation_${number}`|`gp_distance_${number}`|`gp_fpa_${number}`|`gp_required_vs_${number}`|`gp_service_level_${number}`|`vnav_path_calculated_${number}`|`vnav_availability_${number}`|`vnav_altitude_constraint_details_${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|VNavEvents[K]
Defined in: src/sdk/instruments/BasePublishers.ts:328
Gets the current value for a topic.
Type Parameters
| Type Parameter |
|---|
K extends "vnav_vertical_deviation" | "vnav_target_altitude" | "vnav_path_mode" | "vnav_path_available" | "vnav_state" | "vnav_altitude_capture_type" | "vnav_tod_distance" | "vnav_tod_leg_distance" | "vnav_bod_distance" | "vnav_tod_global_leg_index" | "vnav_bod_global_leg_index" | "vnav_toc_distance" | "vnav_toc_leg_distance" | "vnav_boc_distance" | "vnav_toc_global_leg_index" | "vnav_boc_global_leg_index" | "vnav_constraint_global_leg_index" | "vnav_constraint_altitude" | "vnav_next_constraint_altitude" | "vnav_fpa" | "vnav_required_vs" | "gp_approach_mode" | "gp_vertical_deviation" | "gp_distance" | "gp_fpa" | "gp_required_vs" | "gp_service_level" | "vnav_path_calculated" | "vnav_availability" | "vnav_altitude_constraint_details" | `vnav_vertical_deviation_${number}` | `vnav_target_altitude_${number}` | `vnav_path_mode_${number}` | `vnav_path_available_${number}` | `vnav_state_${number}` | `vnav_altitude_capture_type_${number}` | `vnav_tod_distance_${number}` | `vnav_tod_leg_distance_${number}` | `vnav_bod_distance_${number}` | `vnav_tod_global_leg_index_${number}` | `vnav_bod_global_leg_index_${number}` | `vnav_toc_distance_${number}` | `vnav_toc_leg_distance_${number}` | `vnav_boc_distance_${number}` | `vnav_toc_global_leg_index_${number}` | `vnav_boc_global_leg_index_${number}` | `vnav_constraint_global_leg_index_${number}` | `vnav_constraint_altitude_${number}` | `vnav_next_constraint_altitude_${number}` | `vnav_fpa_${number}` | `vnav_required_vs_${number}` | `gp_vertical_deviation_${number}` | `gp_distance_${number}` | `gp_fpa_${number}` | `gp_required_vs_${number}` | `gp_service_level_${number}` | `vnav_path_calculated_${number}` | `vnav_availability_${number}` | `vnav_altitude_constraint_details_${number}` |
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | K | A topic. |
Returns
undefined | VNavEvents[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/BasePublishers.ts:197
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: 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/BasePublishers.ts:283
Responds to when one of this publisher's topics is subscribed to for the first time.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | "vnav_vertical_deviation" | "vnav_target_altitude" | "vnav_path_mode" | "vnav_path_available" | "vnav_state" | "vnav_altitude_capture_type" | "vnav_tod_distance" | "vnav_tod_leg_distance" | "vnav_bod_distance" | "vnav_tod_global_leg_index" | "vnav_bod_global_leg_index" | "vnav_toc_distance" | "vnav_toc_leg_distance" | "vnav_boc_distance" | "vnav_toc_global_leg_index" | "vnav_boc_global_leg_index" | "vnav_constraint_global_leg_index" | "vnav_constraint_altitude" | "vnav_next_constraint_altitude" | "vnav_fpa" | "vnav_required_vs" | "gp_approach_mode" | "gp_vertical_deviation" | "gp_distance" | "gp_fpa" | "gp_required_vs" | "gp_service_level" | "vnav_path_calculated" | "vnav_availability" | "vnav_altitude_constraint_details" | `vnav_vertical_deviation_${number}` | `vnav_target_altitude_${number}` | `vnav_path_mode_${number}` | `vnav_path_available_${number}` | `vnav_state_${number}` | `vnav_altitude_capture_type_${number}` | `vnav_tod_distance_${number}` | `vnav_tod_leg_distance_${number}` | `vnav_bod_distance_${number}` | `vnav_tod_global_leg_index_${number}` | `vnav_bod_global_leg_index_${number}` | `vnav_toc_distance_${number}` | `vnav_toc_leg_distance_${number}` | `vnav_boc_distance_${number}` | `vnav_toc_global_leg_index_${number}` | `vnav_boc_global_leg_index_${number}` | `vnav_constraint_global_leg_index_${number}` | `vnav_constraint_altitude_${number}` | `vnav_next_constraint_altitude_${number}` | `vnav_fpa_${number}` | `vnav_required_vs_${number}` | `gp_vertical_deviation_${number}` | `gp_distance_${number}` | `gp_fpa_${number}` | `gp_required_vs_${number}` | `gp_service_level_${number}` | `vnav_path_calculated_${number}` | `vnav_availability_${number}` | `vnav_altitude_constraint_details_${number}` | The topic that was subscribed to. |
Returns
void
Inherited from
SimVarPublisher.onTopicSubscribed
onUpdate()
onUpdate():
void
Defined in: src/sdk/instruments/BasePublishers.ts:300
Publish all subscribed data points to the bus.
Returns
void
Inherited from
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 VNavEvents |
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | VNavEvents[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 | "vnav_vertical_deviation" | "vnav_target_altitude" | "vnav_path_mode" | "vnav_path_available" | "vnav_state" | "vnav_altitude_capture_type" | "vnav_tod_distance" | "vnav_tod_leg_distance" | "vnav_bod_distance" | "vnav_tod_global_leg_index" | "vnav_bod_global_leg_index" | "vnav_toc_distance" | "vnav_toc_leg_distance" | "vnav_boc_distance" | "vnav_toc_global_leg_index" | "vnav_boc_global_leg_index" | "vnav_constraint_global_leg_index" | "vnav_constraint_altitude" | "vnav_next_constraint_altitude" | "vnav_fpa" | "vnav_required_vs" | "gp_approach_mode" | "gp_vertical_deviation" | "gp_distance" | "gp_fpa" | "gp_required_vs" | "gp_service_level" | "vnav_path_calculated" | "vnav_availability" | "vnav_altitude_constraint_details" | `vnav_vertical_deviation_${number}` | `vnav_target_altitude_${number}` | `vnav_path_mode_${number}` | `vnav_path_available_${number}` | `vnav_state_${number}` | `vnav_altitude_capture_type_${number}` | `vnav_tod_distance_${number}` | `vnav_tod_leg_distance_${number}` | `vnav_bod_distance_${number}` | `vnav_tod_global_leg_index_${number}` | `vnav_bod_global_leg_index_${number}` | `vnav_toc_distance_${number}` | `vnav_toc_leg_distance_${number}` | `vnav_boc_distance_${number}` | `vnav_toc_global_leg_index_${number}` | `vnav_boc_global_leg_index_${number}` | `vnav_constraint_global_leg_index_${number}` | `vnav_constraint_altitude_${number}` | `vnav_next_constraint_altitude_${number}` | `vnav_fpa_${number}` | `vnav_required_vs_${number}` | `gp_vertical_deviation_${number}` | `gp_distance_${number}` | `gp_fpa_${number}` | `gp_required_vs_${number}` | `gp_service_level_${number}` | `vnav_path_calculated_${number}` | `vnav_availability_${number}` | `vnav_altitude_constraint_details_${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 | "vnav_vertical_deviation" | "vnav_target_altitude" | "vnav_path_mode" | "vnav_path_available" | "vnav_state" | "vnav_altitude_capture_type" | "vnav_tod_distance" | "vnav_tod_leg_distance" | "vnav_bod_distance" | "vnav_tod_global_leg_index" | "vnav_bod_global_leg_index" | "vnav_toc_distance" | "vnav_toc_leg_distance" | "vnav_boc_distance" | "vnav_toc_global_leg_index" | "vnav_boc_global_leg_index" | "vnav_constraint_global_leg_index" | "vnav_constraint_altitude" | "vnav_next_constraint_altitude" | "vnav_fpa" | "vnav_required_vs" | "gp_approach_mode" | "gp_vertical_deviation" | "gp_distance" | "gp_fpa" | "gp_required_vs" | "gp_service_level" | "vnav_path_calculated" | "vnav_availability" | "vnav_altitude_constraint_details" | `vnav_vertical_deviation_${number}` | `vnav_target_altitude_${number}` | `vnav_path_mode_${number}` | `vnav_path_available_${number}` | `vnav_state_${number}` | `vnav_altitude_capture_type_${number}` | `vnav_tod_distance_${number}` | `vnav_tod_leg_distance_${number}` | `vnav_bod_distance_${number}` | `vnav_tod_global_leg_index_${number}` | `vnav_bod_global_leg_index_${number}` | `vnav_toc_distance_${number}` | `vnav_toc_leg_distance_${number}` | `vnav_boc_distance_${number}` | `vnav_toc_global_leg_index_${number}` | `vnav_boc_global_leg_index_${number}` | `vnav_constraint_global_leg_index_${number}` | `vnav_constraint_altitude_${number}` | `vnav_next_constraint_altitude_${number}` | `vnav_fpa_${number}` | `vnav_required_vs_${number}` | `gp_vertical_deviation_${number}` | `gp_distance_${number}` | `gp_fpa_${number}` | `gp_required_vs_${number}` | `gp_service_level_${number}` | `vnav_path_calculated_${number}` | `vnav_availability_${number}` | `vnav_altitude_constraint_details_${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