Interface IAlarmsManager

Namespace

Acuit.Pinpoint.Workstation

Assembly

Acuit.Pinpoint.Workstation.Abstractions.dll

An alarms manager service.

public interface IAlarmsManager

Remarks

As alarms are added, they are queued for display. Only one alarm is displayed at a time, as the "active" alarm. When the active alarm is acknowledged, it is removed from the display and the next alarm in the queue, if one exists, is displayed as the new active alarm.

Properties

ActiveAlarm

Gets the active alarm, or null if no alarm is active.

IAlarm? ActiveAlarm { get; }

Property Value

IAlarm

Methods

AcknowledgeAlarm()

Acknowledges the active alarm.

void AcknowledgeAlarm()

Remarks

This does nothing if no alarm is active.

This method is not thread-safe and should be called from the main user interface thread. The IApplicationDispatcher service can be used to invoke this from a background thread.

AddNewAlarm(string)

Adds a new alarm.

void AddNewAlarm(string message)

Parameters

message string

The alarm message.

Remarks

This method is not thread-safe and should be called from the main user interface thread. The IApplicationDispatcher service can be used to invoke this from a background thread.

Events

ActiveAlarmChanged

Raised when ActiveAlarm changes.

event EventHandler? ActiveAlarmChanged

Event Type

EventHandler