Class FrontPanelPeriodicUpdateTimer

Class representing a timer that periodically updates WireOuts and TriggerOuts and dispatches events to notify subscribers of changes.

Implements

Constructors

constructor

Properties

_CancelTimeout? _Device _IsRunning _IsStopPending _TriggerOutValuesChangedEvent _UpdatePeriodMilliseconds _UpdateTimer _WireOutValuesChangedEvent

Accessors

triggerOutValuesChangedEvent wireOutValuesChangedEvent

Methods

start stop updateTimerLoop updateTriggerOuts updateWireOuts

Constructors

constructor

  • new FrontPanelPeriodicUpdateTimer(device, periodMilliseconds): FrontPanelPeriodicUpdateTimer

  • Creates a new instance of the FrontPanelPeriodicUpdateTimer.

    Parameters

    • device: IFrontPanel

      The interface to the FrontPanel device that is the source of WireOuts and TriggerOuts.

    • periodMilliseconds: number

      The period in milliseconds between updates.

    Returns FrontPanelPeriodicUpdateTimer

Properties

Private Optional _CancelTimeout

_CancelTimeout?: (() => void)

Function that cancels the timeout used to wait for the next update period.

Type declaration

    • (): void

    • Returns void

Private Readonly _Device

_Device: IFrontPanel

Event that is dispatched when WireOut values change.

Private _IsRunning

_IsRunning: boolean = false

Flag indicating whether the timer loop is currently running.

Private _IsStopPending

_IsStopPending: boolean = false

Flag indicating that the timer loop should exit on the next iteration.

Private Readonly _TriggerOutValuesChangedEvent

_TriggerOutValuesChangedEvent: FrontPanelEvent = ...

Event that notifies subscribers when TriggerOut values change.

Private _UpdatePeriodMilliseconds

_UpdatePeriodMilliseconds: number

The period in milliseconds between updates.

Private _UpdateTimer

_UpdateTimer: null | Promise<void> = null

Reference to the update timer loop used to identify when the timer loop has started and when it has exited.

Private Readonly _WireOutValuesChangedEvent

_WireOutValuesChangedEvent: FrontPanelEvent = ...

Event that notifies subscribers when WireOut values change.

Accessors

triggerOutValuesChangedEvent

  • get triggerOutValuesChangedEvent(): IFrontPanelEvent

  • Event that notifies subscribers when TriggerOut values change.

    Returns IFrontPanelEvent

wireOutValuesChangedEvent

  • get wireOutValuesChangedEvent(): IFrontPanelEvent

  • Event that notifies subscribers when WireOut values change.

    Returns IFrontPanelEvent

Methods

start

  • start(): Promise<boolean>

  • Starts the update timer loop if it is not already running.

    Returns Promise<boolean>

    true if the timer loop was successfully started; false if the timer loop was already started.

stop

  • stop(): Promise<void>

  • Stops the update timer loop and returns a promise that resolves when the loop has exited.

    Returns Promise<void>

    A promise that resolves when the timer loop has exited.

Private updateTimerLoop

  • updateTimerLoop(): Promise<void>

  • The main loop for the update timer. It periodically updates WireOuts and TriggerOuts, and dispatches the events.

    Returns Promise<void>

    A promise that resolves when the timer loop has exited.

Private updateTriggerOuts

  • updateTriggerOuts(): Promise<void>

  • Updates the TriggerOuts and dispatches the TriggerOutValuesChangedEvent.

    Returns Promise<void>

Private updateWireOuts

  • updateWireOuts(): Promise<void>

  • Updates the WireOuts and dispatches the WireOutValuesChangedEvent.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructor_CancelTimeout_Device_IsRunning_IsStopPending_TriggerOutValuesChangedEvent_UpdatePeriodMilliseconds_UpdateTimer_WireOutValuesChangedEventtriggerOutValuesChangedEventwireOutValuesChangedEventstartstopupdateTimerLoopupdateTriggerOutsupdateWireOuts

Generated using TypeDoc