Skip to main content

Class: SpeedLimitPublisher

Defined in: workingtitle-instruments-epic2/shared/Instruments/SpeedLimit.ts:58

A publisher of airplane speed limits.

The publisher requires a functioning AdcSystem and AoaSystem and that the topics defined by ControlSurfacesEvents and FlapComputerEvents are published to the event bus.

Extends

Constructors

Constructor

new SpeedLimitPublisher(bus, aoaIndex, adahrsIndex, config, stickShakerNormAoa, pacer?): SpeedLimitPublisher

Defined in: workingtitle-instruments-epic2/shared/Instruments/SpeedLimit.ts:120

Creates a new instance of SpeedLimitPublisher.

Parameters

ParameterTypeDefault valueDescription
busEventBusundefinedThe event bus to which to publish.
aoaIndexnumber | Subscribable<number>undefinedThe index of the AoA system that is the source of this publisher's data.
adahrsIndexnumber | Subscribable<number>undefinedThe index of the ADAHRS system that is the source of this publisher's data.
configAvionicsConfigundefinedThe avionics config.
stickShakerNormAoanumber0.95The normalized angle of attack at which the stick shaker activates. Defaults to 0.95.
pacer?PublishPacer<SpeedLimitEvents>undefinedAn optional pacer to use to control the rate of publishing.

Returns

SpeedLimitPublisher

Overrides

BasePublisher.constructor

Properties

bus

protected readonly bus: EventBus

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

Inherited from

BasePublisher.bus


pacer

protected readonly pacer: undefined | PublishPacer<SpeedLimitEvents>

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

Inherited from

BasePublisher.pacer


publishActive

protected publishActive: boolean

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

Inherited from

BasePublisher.publishActive


publisher

protected readonly publisher: Publisher<SpeedLimitEvents>

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

Inherited from

BasePublisher.publisher

Methods

isPublishing()

isPublishing(): boolean

Defined in: 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: workingtitle-instruments-epic2/shared/Instruments/SpeedLimit.ts:206

A callback called when the publisher receives an update cycle.

Returns

void

Overrides

BasePublisher.onUpdate


publish()

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

Defined in: sdk/instruments/BasePublishers.ts:63

Publish a message if publishing is acpive

Type Parameters

Type Parameter
K extends keyof SpeedLimitEvents

Parameters

ParameterTypeDefault valueDescription
topicKundefinedThe topic key to publish to.
dataSpeedLimitEvents[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


startPublish()

startPublish(): void

Defined in: workingtitle-instruments-epic2/shared/Instruments/SpeedLimit.ts:181

Start publishing.

Returns

void

Overrides

BasePublisher.startPublish


stopPublish()

stopPublish(): void

Defined in: workingtitle-instruments-epic2/shared/Instruments/SpeedLimit.ts:190

Stop publishing.

Returns

void

Overrides

BasePublisher.stopPublish