Class: G1000ControlPublisher
Defined in: workingtitle-instruments-g1000/html_ui/Shared/G1000Events.ts:87
A control publisher that handles G1000 events too.
Extends
Constructors
Constructor
new G1000ControlPublisher(
bus):G1000ControlPublisher
Defined in: workingtitle-instruments-g1000/html_ui/Shared/G1000Events.ts:92
Create a ControlPublisher.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The EventBus to publish to. |
Returns
G1000ControlPublisher
Overrides
Properties
bus
protectedreadonlybus:EventBus
Defined in: sdk/instruments/BasePublishers.ts:10
Inherited from
pacer
protectedreadonlypacer:undefined|PublishPacer<G1000ControlEvents>
Defined in: sdk/instruments/BasePublishers.ts:13
Inherited from
publishActive
protectedpublishActive:boolean
Defined in: sdk/instruments/BasePublishers.ts:12
Inherited from
publisher
protectedreadonlypublisher:Publisher<G1000ControlEvents>
Defined in: sdk/instruments/BasePublishers.ts:11
Inherited from
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
onUpdate()
onUpdate():
void
Defined in: sdk/instruments/BasePublishers.ts:52
A callback called when the publisher receives an update cycle.
Returns
void
Inherited from
publish()
protectedpublish<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 G1000ControlEvents |
Parameters
| Parameter | 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
publishEvent()
publishEvent<
K>(event,value):void
Defined in: workingtitle-instruments-g1000/html_ui/Shared/G1000Events.ts:101
Publish a control event.
Type Parameters
| Type Parameter |
|---|
K extends keyof G1000ControlEvents |
Parameters
| Parameter | Type | Description |
|---|---|---|
event | K | The event from ControlEvents. |
value | G1000ControlEvents[K] | The value of the event. |
Returns
void
startPublish()
startPublish():
void
Defined in: sdk/instruments/BasePublishers.ts:30
Start publishing.
Returns
void
Inherited from
stopPublish()
stopPublish():
void
Defined in: sdk/instruments/BasePublishers.ts:37
Stop publishing.
Returns
void