Class: GarminNavSimVarPublisher
Defined in: src/garminsdk/navigation/GarminNavEvents.ts:38
A publisher for Garmin navigation sim var events.
Extends
SimVarPublisher
<GarminNavEvents
>
Constructors
Constructor
new GarminNavSimVarPublisher(
bus
):GarminNavSimVarPublisher
Defined in: src/garminsdk/navigation/GarminNavEvents.ts:48
Constructor.
Parameters
Parameter | Type | Description |
---|---|---|
bus | EventBus | The event bus to which to publish. |
Returns
GarminNavSimVarPublisher
Overrides
SimVarPublisher<GarminNavEvents>.constructor
Properties
bus
protected
readonly
bus:EventBus
Defined in: src/sdk/instruments/BasePublishers.ts:10
Inherited from
SimVarPublisher.bus
indexedSimVars
protected
readonly
indexedSimVars:Map
<"active_nav_source_1"
|"active_nav_source_2"
,IndexedSimVarPublisherEntry
<any
>>
Defined in: src/sdk/instruments/BasePublishers.ts:149
Inherited from
SimVarPublisher.indexedSimVars
pacer
protected
readonly
pacer:undefined
|PublishPacer
<GarminNavEvents
>
Defined in: src/sdk/instruments/BasePublishers.ts:13
Inherited from
SimVarPublisher.pacer
publishActive
protected
publishActive:boolean
Defined in: src/sdk/instruments/BasePublishers.ts:12
Inherited from
SimVarPublisher.publishActive
publisher
protected
readonly
publisher:Publisher
<GarminNavEvents
>
Defined in: src/sdk/instruments/BasePublishers.ts:11
Inherited from
SimVarPublisher.publisher
resolvedSimVars
protected
readonly
resolvedSimVars:Map
<"active_nav_source_1"
|"active_nav_source_2"
,ResolvedSimVarPublisherEntry
<any
>>
Defined in: src/sdk/instruments/BasePublishers.ts:147
Inherited from
SimVarPublisher.resolvedSimVars
subscribed
protected
readonly
subscribed:Set
<"active_nav_source_1"
|"active_nav_source_2"
>
Defined in: src/sdk/instruments/BasePublishers.ts:151
Inherited from
SimVarPublisher.subscribed
INDEXED_REGEX
protected
readonly
static
INDEXED_REGEX:RegExp
Defined in: src/sdk/instruments/BasePublishers.ts:145
Inherited from
SimVarPublisher.INDEXED_REGEX
Methods
getValue()
protected
getValue<K
>(topic
):undefined
|GarminNavEvents
[K
]
Defined in: src/sdk/instruments/BasePublishers.ts:343
Gets the current value for a topic.
Type Parameters
Type Parameter |
---|
K extends "active_nav_source_1" | "active_nav_source_2" |
Parameters
Parameter | Type | Description |
---|---|---|
topic | K | A topic. |
Returns
undefined
| GarminNavEvents
[K
]
The current value for the specified topic.
Inherited from
SimVarPublisher.getValue
getValueFromEntry()
protected
getValueFromEntry<T
>(entry
):T
Defined in: src/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()
protected
handleSubscribedTopic(topic
):void
Defined in: src/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: 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
SimVarPublisher.isPublishing
onTopicSubscribed()
protected
onTopicSubscribed(topic
):void
Defined in: src/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 | "active_nav_source_1" | "active_nav_source_2" | The topic that was subscribed to. |
Returns
void
Inherited from
SimVarPublisher.onTopicSubscribed
onUpdate()
onUpdate():
void
Defined in: src/sdk/instruments/BasePublishers.ts:315
Publish all subscribed data points to the bus.
Returns
void
Inherited from
SimVarPublisher.onUpdate
publish()
protected
publish<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 GarminNavEvents |
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | GarminNavEvents [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()
protected
publishTopic(topic
):void
Defined in: src/sdk/instruments/BasePublishers.ts:325
Publishes data to the event bus for a topic.
Parameters
Parameter | Type | Description |
---|---|---|
topic | "active_nav_source_1" | "active_nav_source_2" | The topic to publish. |
Returns
void
Inherited from
SimVarPublisher.publishTopic
resolveIndexedSimVar()
protected
resolveIndexedSimVar(topic
,entry
,index
):undefined
|string
Defined in: src/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 | "active_nav_source_1" | "active_nav_source_2" | 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
SimVarPublisher.startPublish
stopPublish()
stopPublish():
void
Defined in: src/sdk/instruments/BasePublishers.ts:37
Stop publishing.
Returns
void
Inherited from
SimVarPublisher.stopPublish
subscribe()
subscribe(
data
):void
Defined in: src/sdk/instruments/BasePublishers.ts:298
NOOP - For backwards compatibility.
Parameters
Parameter | Type | Description |
---|---|---|
data | keyof GarminNavEvents | Key of the event type in the simVarMap |
Returns
void
Deprecated
Inherited from
SimVarPublisher.subscribe
tryMatchIndexedSubscribedTopic()
protected
tryMatchIndexedSubscribedTopic(topic
):void
Defined in: src/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: src/sdk/instruments/BasePublishers.ts:308
NOOP - For backwards compatibility.
Parameters
Parameter | Type | Description |
---|---|---|
data | keyof GarminNavEvents | Key of the event type in the simVarMap |
Returns
void
Deprecated
Inherited from
SimVarPublisher.unsubscribe