Skip to main content

Class: VNavDataEventPublisher

Defined in: src/sdk/autopilot/vnav/VNavDataEvents.ts:40

A publisher for VNAV-related data events.

Extends​

Constructors​

Constructor​

new VNavDataEventPublisher(bus): VNavDataEventPublisher

Defined in: src/sdk/autopilot/vnav/VNavDataEvents.ts:45

Creates a new instance of VNavDataEventPublisher.

Parameters​

ParameterTypeDescription
busEventBusThe event bus to which to publish.

Returns​

VNavDataEventPublisher

Overrides​

BasePublisher.constructor

Properties​

bus​

protected readonly bus: EventBus

Defined in: src/sdk/instruments/BasePublishers.ts:10

Inherited from​

BasePublisher.bus


pacer​

protected readonly pacer: undefined | PublishPacer<VNavDataEvents>

Defined in: src/sdk/instruments/BasePublishers.ts:13

Inherited from​

BasePublisher.pacer


publishActive​

protected publishActive: boolean

Defined in: src/sdk/instruments/BasePublishers.ts:12

Inherited from​

BasePublisher.publishActive


publisher​

protected readonly publisher: Publisher<VNavDataEvents>

Defined in: src/sdk/instruments/BasePublishers.ts:11

Inherited from​

BasePublisher.publisher

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​

BasePublisher.isPublishing


onUpdate()​

onUpdate(): void

Defined in: src/sdk/instruments/BasePublishers.ts:52

A callback called when the publisher receives an update cycle.

Returns​

void

Inherited from​

BasePublisher.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 VNavDataEvents

Parameters​

ParameterTypeDefault valueDescription
topicKundefinedThe topic key to publish to.
dataVNavDataEvents[K]undefinedThe data type for chosen topic.
syncbooleanfalseWhether or not the event should be synced to other instruments. Defaults to false.
isCachedbooleantrueWhether or not the event should be cached. Defaults to true.

Returns​

void

Inherited from​

BasePublisher.publish


publishEvent()​

publishEvent<K>(event, value): void

Defined in: src/sdk/autopilot/vnav/VNavDataEvents.ts:54

Publish a control event.

Type Parameters​

Type Parameter
K extends keyof VNavDataEvents

Parameters​

ParameterTypeDescription
eventKThe event from ControlEvents.
valueVNavDataEvents[K]The value of the event.

Returns​

void


startPublish()​

startPublish(): void

Defined in: src/sdk/instruments/BasePublishers.ts:30

Start publishing.

Returns​

void

Inherited from​

BasePublisher.startPublish


stopPublish()​

stopPublish(): void

Defined in: src/sdk/instruments/BasePublishers.ts:37

Stop publishing.

Returns​

void

Inherited from​

BasePublisher.stopPublish