Class: HydraulicsPublisher
Defined in: src/sdk/instruments/Hydraulics.ts:36
A publisher for control surfaces information.
Extends
Constructors
Constructor
new HydraulicsPublisher(
bus
,pacer?
):HydraulicsPublisher
Defined in: src/sdk/instruments/Hydraulics.ts:43
Create an HydraulicsPublisher.
Parameters
Parameter | Type | Description |
---|---|---|
bus | EventBus | The EventBus to publish to. |
pacer? | PublishPacer <HydraulicsEvents > | An optional pacer to use to control the rate of publishing. |
Returns
HydraulicsPublisher
Overrides
Properties
bus
protected
readonly
bus:EventBus
Defined in: src/sdk/instruments/BasePublishers.ts:10
Inherited from
indexedSimVars
protected
readonly
indexedSimVars:Map
<"hyd_pump_switch_state"
|"hyd_reservoir_perc"
|"hyd_pressure"
|`hyd_pump_switch_state_${number}`
|`hyd_reservoir_perc_${number}`
|`hyd_pressure_${number}`
,IndexedSimVarPublisherEntry
<any
>>
Defined in: src/sdk/instruments/BasePublishers.ts:149
Inherited from
SimVarPublisher
.indexedSimVars
pacer
protected
readonly
pacer:undefined
|PublishPacer
<HydraulicsEvents
>
Defined in: src/sdk/instruments/BasePublishers.ts:13
Inherited from
publishActive
protected
publishActive:boolean
Defined in: src/sdk/instruments/BasePublishers.ts:12
Inherited from
publisher
protected
readonly
publisher:Publisher
<HydraulicsEvents
>
Defined in: src/sdk/instruments/BasePublishers.ts:11
Inherited from
resolvedSimVars
protected
readonly
resolvedSimVars:Map
<"hyd_pump_switch_state"
|"hyd_reservoir_perc"
|"hyd_pressure"
|`hyd_pump_switch_state_${number}`
|`hyd_reservoir_perc_${number}`
|`hyd_pressure_${number}`
,ResolvedSimVarPublisherEntry
<any
>>
Defined in: src/sdk/instruments/BasePublishers.ts:147
Inherited from
SimVarPublisher
.resolvedSimVars
subscribed
protected
readonly
subscribed:Set
<"hyd_pump_switch_state"
|"hyd_reservoir_perc"
|"hyd_pressure"
|`hyd_pump_switch_state_${number}`
|`hyd_reservoir_perc_${number}`
|`hyd_pressure_${number}`
>
Defined in: src/sdk/instruments/BasePublishers.ts:151
Inherited from
INDEXED_REGEX
protected
readonly
static
INDEXED_REGEX:RegExp
Defined in: src/sdk/instruments/BasePublishers.ts:145
Inherited from
Methods
getValue()
protected
getValue<K
>(topic
):undefined
|HydraulicsEvents
[K
]
Defined in: src/sdk/instruments/BasePublishers.ts:343
Gets the current value for a topic.
Type Parameters
Type Parameter |
---|
K extends "hyd_pump_switch_state" | "hyd_reservoir_perc" | "hyd_pressure" | `hyd_pump_switch_state_${number}` | `hyd_reservoir_perc_${number}` | `hyd_pressure_${number}` |
Parameters
Parameter | Type | Description |
---|---|---|
topic | K | A topic. |
Returns
undefined
| HydraulicsEvents
[K
]
The current value for the specified topic.
Inherited from
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
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 | "hyd_pump_switch_state" | "hyd_reservoir_perc" | "hyd_pressure" | `hyd_pump_switch_state_${number}` | `hyd_reservoir_perc_${number}` | `hyd_pressure_${number}` | 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
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 BaseHydraulicsSystemEvents | `hyd_pump_switch_state_${number}` | `hyd_reservoir_perc_${number}` | `hyd_pressure_${number}` |
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | HydraulicsEvents [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()
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 | "hyd_pump_switch_state" | "hyd_reservoir_perc" | "hyd_pressure" | `hyd_pump_switch_state_${number}` | `hyd_reservoir_perc_${number}` | `hyd_pressure_${number}` | The topic to publish. |
Returns
void
Inherited from
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 | "hyd_pump_switch_state" | "hyd_reservoir_perc" | "hyd_pressure" | `hyd_pump_switch_state_${number}` | `hyd_reservoir_perc_${number}` | `hyd_pressure_${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
subscribe()
subscribe(
data
):void
Defined in: src/sdk/instruments/BasePublishers.ts:298
NOOP - For backwards compatibility.
Parameters
Parameter | Type | Description |
---|---|---|
data | keyof BaseHydraulicsSystemEvents | `hyd_pump_switch_state_${number}` | `hyd_reservoir_perc_${number}` | `hyd_pressure_${number}` | Key of the event type in the simVarMap |
Returns
void
Deprecated
Inherited from
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 BaseHydraulicsSystemEvents | `hyd_pump_switch_state_${number}` | `hyd_reservoir_perc_${number}` | `hyd_pressure_${number}` | Key of the event type in the simVarMap |
Returns
void