Class: CcpEventPublisher
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/CCP/CcpEventPublisher.ts:12
Extends
BasePublisher<CcpEventPublisherType>
Constructors
Constructor
new CcpEventPublisher(
bus,pacer):CcpEventPublisher
Defined in: sdk/instruments/BasePublishers.ts:20
Creates an instance of BasePublisher.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
bus | EventBus | undefined | The common event bus. |
pacer | undefined | PublishPacer<CcpEventPublisherType> | undefined | An optional pacer to control the rate of publishing. |
Returns
CcpEventPublisher
Inherited from
BasePublisher<CcpEventPublisherType>.constructor
Properties
bus
protectedreadonlybus:EventBus
Defined in: sdk/instruments/BasePublishers.ts:10
Inherited from
BasePublisher.bus
pacer
protectedreadonlypacer:undefined|PublishPacer<CcpEventPublisherType>
Defined in: sdk/instruments/BasePublishers.ts:13
Inherited from
BasePublisher.pacer
publishActive
protectedpublishActive:boolean
Defined in: sdk/instruments/BasePublishers.ts:12
Inherited from
BasePublisher.publishActive
publisher
protectedreadonlypublisher:Publisher<CcpEventPublisherType>
Defined in: sdk/instruments/BasePublishers.ts:11
Inherited from
BasePublisher.publisher
Methods
dispatchHEvent()
dispatchHEvent(
event,sync):void
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/CCP/CcpEventPublisher.ts:18
Dispatches an CcpEvent to the event bus.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
event | CcpEvent | undefined | The CcpEvent to dispatch. |
sync | boolean | false | Whether this event should be synced (optional, default false) |
Returns
void
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: sdk/instruments/BasePublishers.ts:52
A callback called when the publisher receives an update cycle.
Returns
void
Inherited from
BasePublisher.onUpdate
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 "ccpEvent" |
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | CcpEventPublisherType[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
startPublish()
startPublish():
void
Defined in: sdk/instruments/BasePublishers.ts:30
Start publishing.
Returns
void
Inherited from
BasePublisher.startPublish
stopPublish()
stopPublish():
void
Defined in: sdk/instruments/BasePublishers.ts:37
Stop publishing.
Returns
void
Inherited from
BasePublisher.stopPublish