Class: SystemAlertPublisher

Defined in: src/sdk/alerts/SystemAlertPublisher.ts:19

A publisher for system alert messages. This publisher works primarily with integers that are indicies into an array of annunciation messages for the host instrument as provided by the panel.xml configuration parser.

Extends

• BasePublisher<SystemAlertEvents>

Constructors

Constructor

new SystemAlertPublisher(bus, pacer): SystemAlertPublisher

Defined in: src/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<SystemAlertEvents>	undefined	An optional pacer to control the rate of publishing.

Returns

SystemAlertPublisher

Inherited from

BasePublisher.constructor

Properties

bus

protected readonly bus: EventBus

Defined in: src/sdk/instruments/BasePublishers.ts:10

Inherited from

BasePublisher.bus

---

pacer

protected readonly pacer: undefined | PublishPacer<SystemAlertEvents>

Defined in: src/sdk/instruments/BasePublishers.ts:13

Inherited from

BasePublisher.pacer

---

publishActive

protected publishActive: boolean

Defined in: src/sdk/instruments/BasePublishers.ts:12

Inherited from

BasePublisher.publishActive

---

publisher

protected readonly publisher: Publisher<SystemAlertEvents>

Defined in: src/sdk/instruments/BasePublishers.ts:11

Inherited from

BasePublisher.publisher

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

BasePublisher.isPublishing

---

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

BasePublisher.onUpdate

---

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 SystemAlertEvents

Parameters

Parameter	Type	Default value	Description
topic	K	undefined	The topic key to publish to.
data	SystemAlertEvents[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

---

publishAlert()

publishAlert<K>(event, value): void

Defined in: src/sdk/alerts/SystemAlertPublisher.ts:25

Publish an alert event.

Type Parameters

Type Parameter
K extends keyof SystemAlertEvents

Parameters

Parameter	Type	Description
event	K	The event from SystemAlertEvents.
value	SystemAlertEvents[K]	The value for the event.

Returns

void

---

startPublish()

startPublish(): void

Defined in: src/sdk/instruments/BasePublishers.ts:30

Start publishing.

Returns

void

Inherited from

BasePublisher.startPublish

---

stopPublish()

stopPublish(): void

Defined in: src/sdk/instruments/BasePublishers.ts:37

Stop publishing.

Returns

void

Inherited from

BasePublisher.stopPublish