Class: ControlPublisher
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.
Hierarchy
↳
ControlPublisher
Constructors
constructor
• new ControlPublisher(bus
, pacer?
): ControlPublisher
Create a ControlPublisher.
Parameters
Name | 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
Overrides
Defined in
src/sdk/data/ControlPublisher.ts:78
Properties
bus
• Protected
Readonly
bus: EventBus
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:10
pacer
• Protected
Readonly
pacer: undefined
| PublishPacer
<ControlEvents
>
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:13
publishActive
• Protected
publishActive: boolean
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:12
publisher
• Protected
Readonly
publisher: Publisher
<ControlEvents
>
Inherited from
Defined in
src/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
Defined in
src/sdk/instruments/BasePublishers.ts:45
onUpdate
▸ onUpdate(): void
A callback called when the publisher receives an update cycle.
Returns
void
Inherited from
Defined in
src/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 ControlEvents |
Parameters
Name | 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
Defined in
src/sdk/instruments/BasePublishers.ts:63
publishEvent
▸ publishEvent<K
>(event
, value
): void
Publish a control event.
Type parameters
Name | Type |
---|---|
K | extends keyof ControlEvents |
Parameters
Name | Type | Description |
---|---|---|
event | K | The event from ControlEvents. |
value | ControlEvents [K ] | The value of the event. |
Returns
void
Defined in
src/sdk/data/ControlPublisher.ts:87
startPublish
▸ startPublish(): void
debug logger
Returns
void
Overrides
Defined in
src/sdk/data/ControlPublisher.ts:92
stopPublish
▸ stopPublish(): void
Stop publishing.
Returns
void
Inherited from
Defined in
src/sdk/instruments/BasePublishers.ts:37