Class: G1000ControlPublisher
A control publisher that handles G1000 events too.
Hierarchy
BasePublisher<G1000ControlEvents>↳
G1000ControlPublisher
Constructors
constructor
• new G1000ControlPublisher(bus): G1000ControlPublisher
Create a ControlPublisher.
Parameters
| Name | Type | Description |
|---|---|---|
bus | EventBus | The EventBus to publish to. |
Returns
Overrides
BasePublisher\<G1000ControlEvents\>.constructor
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/G1000Events.ts:92
Properties
bus
• Protected Readonly bus: EventBus
Inherited from
BasePublisher.bus
Defined in
sdk/instruments/BasePublishers.ts:10
pacer
• Protected Readonly pacer: undefined | PublishPacer<G1000ControlEvents>
Inherited from
BasePublisher.pacer
Defined in
sdk/instruments/BasePublishers.ts:13
publishActive
• Protected publishActive: boolean
Inherited from
BasePublisher.publishActive
Defined in
sdk/instruments/BasePublishers.ts:12
publisher
• Protected Readonly publisher: Publisher<G1000ControlEvents>
Inherited from
BasePublisher.publisher
Defined in
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
sdk/instruments/BasePublishers.ts:45
onUpdate
▸ onUpdate(): void
A callback called when the publisher receives an update cycle.
Returns
void
Inherited from
BasePublisher.onUpdate
Defined in
sdk/instruments/BasePublishers.ts:52
publish
▸ publish<K>(topic, data, sync?, isCached?): void
Publish a message if publishing is acpive
Type parameters
| Name | Type |
|---|---|
K | extends keyof G1000ControlEvents |
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | G1000ControlEvents[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
sdk/instruments/BasePublishers.ts:63
publishEvent
▸ publishEvent<K>(event, value): void
Publish a control event.
Type parameters
| Name | Type |
|---|---|
K | extends keyof G1000ControlEvents |
Parameters
| Name | Type | Description |
|---|---|---|
event | K | The event from ControlEvents. |
value | G1000ControlEvents[K] | The value of the event. |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/G1000Events.ts:101
startPublish
▸ startPublish(): void
Start publishing.
Returns
void
Inherited from
BasePublisher.startPublish
Defined in
sdk/instruments/BasePublishers.ts:30
stopPublish
▸ stopPublish(): void
Stop publishing.
Returns
void
Inherited from
BasePublisher.stopPublish
Defined in
sdk/instruments/BasePublishers.ts:37