Class: BaseInstrumentPublisher
Defined in: src/sdk/instruments/InstrumentEvents.ts:45
A publisher for VCockpit BaseInstrument events.
Extends
Constructors
Constructor
new BaseInstrumentPublisher(
instrument
,bus
,pacer
):BaseInstrumentPublisher
Defined in: src/sdk/instruments/InstrumentEvents.ts:58
Creates an instance of BasePublisher.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
instrument | BaseInstrument | undefined | The BaseInstrument instance. |
bus | EventBus | undefined | The common event bus. |
pacer | undefined | PublishPacer <InstrumentEvents > | undefined | An optional pacer to control the rate of publishing. |
Returns
BaseInstrumentPublisher
Overrides
Properties
bus
protected
readonly
bus:EventBus
Defined in: src/sdk/instruments/BasePublishers.ts:10
Inherited from
pacer
protected
readonly
pacer:undefined
|PublishPacer
<InstrumentEvents
>
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
<InstrumentEvents
>
Defined in: src/sdk/instruments/BasePublishers.ts:11
Inherited from
Methods
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
onUpdate()
onUpdate():
void
Defined in: src/sdk/instruments/InstrumentEvents.ts:80
A callback called when the publisher receives an update cycle.
Returns
void
Overrides
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 InstrumentEvents |
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | InstrumentEvents [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
startPublish()
startPublish():
void
Defined in: src/sdk/instruments/InstrumentEvents.ts:70
Start publishing.
Returns
void
Overrides
stopPublish()
stopPublish():
void
Defined in: src/sdk/instruments/InstrumentEvents.ts:75
Stop publishing.
Returns
void