Class: FlightTimerPublisher<ID>
A publisher for flight timer information.
Type parameters
Name | Type |
---|---|
ID | extends string = any |
Hierarchy
SimVarPublisher
<FlightTimerEventsForId
<ID
>,BaseFlightTimerEventsForId
<ID
>>↳
FlightTimerPublisher
Constructors
constructor
• new FlightTimerPublisher<ID
>(bus
, options?
, pacer?
): FlightTimerPublisher
<ID
>
Creates a new instance of FlightTimerPublisher.
Type parameters
Name | Type |
---|---|
ID | extends string = any |
Parameters
Name | Type | Description |
---|---|---|
bus | EventBus | The event bus. |
options? | Readonly <FlightTimerPublisherOptions > | Options with which to configure the publisher. |
pacer? | PublishPacer <FlightTimerEventsForId <ID >> | An optional pacer to use to control the rate of publishing. |
Returns
Overrides
Defined in
src/sdk/instruments/FlightTimer.ts:253
• new FlightTimerPublisher<ID
>(bus
, timerCount
, pacer?
): FlightTimerPublisher
<ID
>
Creates a new instance of FlightTimerPublisher that publishes data for timers with the empty ID (''
).
Type parameters
Name | Type |
---|---|
ID | extends string = any |
Parameters
Name | Type | Description |
---|---|---|
bus | EventBus | The event bus. |
timerCount | number | This argument is ignored. |
pacer? | PublishPacer <FlightTimerEventsForId <ID >> | An optional pacer to use to control the rate of publishing. |
Returns
Deprecated
Please use the overload of the constructor that accepts an options object.
Overrides
SimVarPublisher\<FlightTimerEventsForId\<ID\>, BaseFlightTimerEventsForId\<ID\>\>.constructor
Defined in
src/sdk/instruments/FlightTimer.ts:261
Properties
bus
• Protected
Readonly
bus: EventBus
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:10
indexedSimVars
• Protected
Readonly
indexedSimVars: Map
<`timer_mode${FlightTimerEventSuffix<ID>}` | `timer_is_running${FlightTimerEventSuffix<ID>}` | `timer_initial_value_ms${FlightTimerEventSuffix<ID>}` | `timer_value_ms${FlightTimerEventSuffix<ID>}`, IndexedSimVarPublisherEntry
<any
>>
Inherited from
SimVarPublisher.indexedSimVars
Defined in
src/sdk/instruments/BasePublishers.ts:149
pacer
• Protected
Readonly
pacer: undefined
| PublishPacer
<FlightTimerEventsForId
<ID
>>
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
<FlightTimerEventsForId
<ID
>>
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:11
resolvedSimVars
• Protected
Readonly
resolvedSimVars: Map
<`timer_mode${FlightTimerEventSuffix<ID>}_${number}` | `timer_is_running${FlightTimerEventSuffix<ID>}_${number}` | `timer_initial_value_ms${FlightTimerEventSuffix<ID>}_${number}` | `timer_value_ms${FlightTimerEventSuffix<ID>}_${number}`, ResolvedSimVarPublisherEntry
<any
>>
Inherited from
SimVarPublisher.resolvedSimVars
Defined in
src/sdk/instruments/BasePublishers.ts:147
subscribed
• Protected
Readonly
subscribed: Set
<`timer_mode${FlightTimerEventSuffix<ID>}_${number}` | `timer_is_running${FlightTimerEventSuffix<ID>}_${number}` | `timer_initial_value_ms${FlightTimerEventSuffix<ID>}_${number}` | `timer_value_ms${FlightTimerEventSuffix<ID>}_${number}`>
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
| FlightTimerEventsForId
<ID
>[K
]
Gets the current value for a topic.
Type parameters
Name | Type |
---|---|
K | extends `timer_mode_${string}_${number}` | `timer_is_running_${string}_${number}` | `timer_initial_value_ms_${string}_${number}` | `timer_value_ms_${string}_${number}` |
Parameters
Name | Type | Description |
---|---|---|
topic | K | A topic. |
Returns
undefined
| FlightTimerEventsForId
<ID
>[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 | `timer_mode${FlightTimerEventSuffix<ID>}_${number}` | `timer_is_running${FlightTimerEventSuffix<ID>}_${number}` | `timer_initial_value_ms${FlightTimerEventSuffix<ID>}_${number}` | `timer_value_ms${FlightTimerEventSuffix<ID>}_${number}` | 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 `timer_mode_${string}_${number}` | `timer_is_running_${string}_${number}` | `timer_initial_value_ms_${string}_${number}` | `timer_value_ms_${string}_${number}` |
Parameters
Name | Type | Default value | Description |
---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | FlightTimerEventsForId <ID >[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 | `timer_mode${FlightTimerEventSuffix<ID>}_${number}` | `timer_is_running${FlightTimerEventSuffix<ID>}_${number}` | `timer_initial_value_ms${FlightTimerEventSuffix<ID>}_${number}` | `timer_value_ms${FlightTimerEventSuffix<ID>}_${number}` | 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 | `timer_mode${FlightTimerEventSuffix<ID>}` | `timer_is_running${FlightTimerEventSuffix<ID>}` | `timer_initial_value_ms${FlightTimerEventSuffix<ID>}` | `timer_value_ms${FlightTimerEventSuffix<ID>}` | 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 | `timer_mode${FlightTimerEventSuffix<ID>}_${number}` | `timer_is_running${FlightTimerEventSuffix<ID>}_${number}` | `timer_initial_value_ms${FlightTimerEventSuffix<ID>}_${number}` | `timer_value_ms${FlightTimerEventSuffix<ID>}_${number}` | 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 | `timer_mode${FlightTimerEventSuffix<ID>}_${number}` | `timer_is_running${FlightTimerEventSuffix<ID>}_${number}` | `timer_initial_value_ms${FlightTimerEventSuffix<ID>}_${number}` | `timer_value_ms${FlightTimerEventSuffix<ID>}_${number}` | Key of the event type in the simVarMap |
Returns
void
Deprecated
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:308