Class: SystemAlertPublisher

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.

Hierarchy

• BasePublisher<SystemAlertEvents>

  ↳ SystemAlertPublisher

Constructors

constructor

• new SystemAlertPublisher(bus, pacer?): SystemAlertPublisher

Creates an instance of BasePublisher.

Parameters

Name	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

Defined in

src/sdk/instruments/BasePublishers.ts:20

Properties

bus

• Protected Readonly bus: EventBus

Inherited from

BasePublisher.bus

Defined in

src/sdk/instruments/BasePublishers.ts:10

---

pacer

• Protected Readonly pacer: undefined | PublishPacer<SystemAlertEvents>

Inherited from

BasePublisher.pacer

Defined in

src/sdk/instruments/BasePublishers.ts:13

---

publishActive

• Protected publishActive: boolean

Inherited from

BasePublisher.publishActive

Defined in

src/sdk/instruments/BasePublishers.ts:12

---

publisher

• Protected Readonly publisher: Publisher<SystemAlertEvents>

Inherited from

BasePublisher.publisher

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

BasePublisher.isPublishing

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

BasePublisher.onUpdate

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 SystemAlertEvents

Parameters

Name	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

Defined in

src/sdk/instruments/BasePublishers.ts:63

---

publishAlert

▸ publishAlert<K>(event, value): void

Publish an alert event.

Type parameters

Name	Type
K	extends keyof SystemAlertEvents

Parameters

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

Returns

void

Defined in

src/sdk/alerts/SystemAlertPublisher.ts:25

---

startPublish

▸ startPublish(): void

Start publishing.

Returns

void

Inherited from

BasePublisher.startPublish

Defined in

src/sdk/instruments/BasePublishers.ts:30

---

stopPublish

▸ stopPublish(): void

Stop publishing.

Returns

void

Inherited from

BasePublisher.stopPublish

Defined in

src/sdk/instruments/BasePublishers.ts:37