Class: BaseInstrumentPublisher

A publisher for VCockpit BaseInstrument events.

Hierarchy

• BasePublisher<InstrumentEvents>

  ↳ BaseInstrumentPublisher

Constructors

constructor

• new BaseInstrumentPublisher(instrument, bus, pacer?): BaseInstrumentPublisher

Creates an instance of BasePublisher.

Parameters

Name	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

BasePublisher.constructor

Defined in

src/sdk/instruments/InstrumentEvents.ts:58

Properties

bus

• Protected Readonly bus: EventBus

Inherited from

BasePublisher.bus

Defined in

src/sdk/instruments/BasePublishers.ts:10

---

pacer

• Protected Readonly pacer: undefined | PublishPacer<InstrumentEvents>

Inherited from

BasePublisher.pacer

Defined in

src/sdk/instruments/BasePublishers.ts:13

---

publishActive

• Protected publishActive: boolean

Inherited from

BasePublisher.publishActive

Defined in

src/sdk/instruments/BasePublishers.ts:12

---

publisher

• Protected Readonly publisher: Publisher<InstrumentEvents>

Inherited from

BasePublisher.publisher

Defined in

src/sdk/instruments/BasePublishers.ts:11

Methods

isPublishing

▸ isPublishing(): boolean

Tells whether or not the publisher is currently active.

Returns

boolean

True if the publisher is active, false otherwise.

Inherited from

BasePublisher.isPublishing

Defined in

src/sdk/instruments/BasePublishers.ts:45

---

onUpdate

▸ onUpdate(): void

A callback called when the publisher receives an update cycle.

Returns

void

Overrides

BasePublisher.onUpdate

Defined in

src/sdk/instruments/InstrumentEvents.ts:80

---

publish

▸ publish<K>(topic, data, sync?, isCached?): void

Publish a message if publishing is acpive

Type parameters

Name	Type
K	extends keyof InstrumentEvents

Parameters

Name	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

BasePublisher.publish

Defined in

src/sdk/instruments/BasePublishers.ts:63

---

startPublish

▸ startPublish(): void

Start publishing.

Returns

void

Overrides

BasePublisher.startPublish

Defined in

src/sdk/instruments/InstrumentEvents.ts:70

---

stopPublish

▸ stopPublish(): void

Stop publishing.

Returns

void

Overrides

BasePublisher.stopPublish

Defined in

src/sdk/instruments/InstrumentEvents.ts:75