Skip to main content

Class: DcpEventPublisher

Hierarchy

  • BasePublisher<DcpEvents>

    DcpEventPublisher

Constructors

constructor

new DcpEventPublisher(bus, pacer?): DcpEventPublisher

Creates an instance of BasePublisher.

Parameters

NameTypeDefault valueDescription
busEventBusundefinedThe common event bus.
pacerundefined | PublishPacer<DcpEvents>undefinedAn optional pacer to control the rate of publishing.

Returns

DcpEventPublisher

Inherited from

BasePublisher<DcpEvents>.constructor

Defined in

sdk/instruments/BasePublishers.ts:20

Properties

bus

Protected Readonly bus: EventBus

Inherited from

BasePublisher.bus

Defined in

sdk/instruments/BasePublishers.ts:10


pacer

Protected Readonly pacer: undefined | PublishPacer<DcpEvents>

Inherited from

BasePublisher.pacer

Defined in

sdk/instruments/BasePublishers.ts:13


publishActive

Protected publishActive: boolean

Inherited from

BasePublisher.publishActive

Defined in

sdk/instruments/BasePublishers.ts:12


publisher

Protected Readonly publisher: Publisher<DcpEvents>

Inherited from

BasePublisher.publisher

Defined in

sdk/instruments/BasePublishers.ts:11

Methods

dispatchHEvent

dispatchHEvent(event, sync?): void

Dispatches an DcpEvent to the event bus.

Parameters

NameTypeDefault valueDescription
eventDcpEventundefinedThe DcpEvent to dispatch.
syncbooleanfalseWhether this event should be synced (optional, default false)

Returns

void

Defined in

workingtitle-instruments-wt21/shared/DCP/DcpEventPublisher.ts:18


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

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

sdk/instruments/BasePublishers.ts:52


publish

publish<K>(topic, data, sync?, isCached?): void

Publish a message if publishing is acpive

Type parameters

NameType
Kextends "dcpEvent"

Parameters

NameTypeDefault valueDescription
topicKundefinedThe topic key to publish to.
dataDcpEvents[K]undefinedThe data type for chosen topic.
syncbooleanfalseWhether or not the event should be synced to other instruments. Defaults to false.
isCachedbooleantrueWhether or not the event should be cached. Defaults to true.

Returns

void

Inherited from

BasePublisher.publish

Defined in

sdk/instruments/BasePublishers.ts:63


startPublish

startPublish(): void

Start publishing.

Returns

void

Inherited from

BasePublisher.startPublish

Defined in

sdk/instruments/BasePublishers.ts:30


stopPublish

stopPublish(): void

Stop publishing.

Returns

void

Inherited from

BasePublisher.stopPublish

Defined in

sdk/instruments/BasePublishers.ts:37