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
Parameter | Type | Description |
---|---|---|
bus | EventBus | The event bus to which to publish. |
Returns
VNavDataEventPublisher
Overrides
Properties
bus
protected
readonly
bus:EventBus
Defined in: src/sdk/instruments/BasePublishers.ts:10
Inherited from
pacer
protected
readonly
pacer:undefined
|PublishPacer
<VNavDataEvents
>
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
<VNavDataEvents
>
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/BasePublishers.ts:52
A callback called when the publisher receives an update cycle.
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 VNavDataEvents |
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | VNavDataEvents [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
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
Parameter | Type | Description |
---|---|---|
event | K | The event from ControlEvents. |
value | VNavDataEvents [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
stopPublish()
stopPublish():
void
Defined in: src/sdk/instruments/BasePublishers.ts:37
Stop publishing.
Returns
void