Class: ControlPublisher
Defined in: src/sdk/data/ControlPublisher.ts:72
A publisher for control interactions. This is meant to handle the events for which there aren't existing HEvents in the sim to allow us to maintain a decoupled, event-driven architecture.
Extends
Constructors
Constructor
new ControlPublisher(
bus
,pacer
):ControlPublisher
Defined in: src/sdk/data/ControlPublisher.ts:78
Create a ControlPublisher.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
bus | EventBus | undefined | The EventBus to publish to. |
pacer | undefined | PublishPacer <ControlEvents > | undefined | An optional pacer to use to control the rate of publishing. |
Returns
ControlPublisher
Overrides
Properties
bus
protected
readonly
bus:EventBus
Defined in: src/sdk/instruments/BasePublishers.ts:10
Inherited from
pacer
protected
readonly
pacer:undefined
|PublishPacer
<ControlEvents
>
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
<ControlEvents
>
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 ControlEvents |
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
topic | K | undefined | The topic key to publish to. |
data | ControlEvents [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/data/ControlPublisher.ts:87
Publish a control event.
Type Parameters
Type Parameter |
---|
K extends keyof ControlEvents |
Parameters
Parameter | Type | Description |
---|---|---|
event | K | The event from ControlEvents. |
value | ControlEvents [K ] | The value of the event. |
Returns
void
startPublish()
startPublish():
void
Defined in: src/sdk/data/ControlPublisher.ts:92
debug logger
Returns
void
Overrides
stopPublish()
stopPublish():
void
Defined in: src/sdk/instruments/BasePublishers.ts:37
Stop publishing.
Returns
void