Table of Contents

Class AlertHighlight

Namespace
EncDotNet.S100.Portrayals
Assembly
EncDotNet.S100.Portrayals.dll

A highlight an alert draws, and the viewing groups that turn it on or off.

public sealed record AlertHighlight : IEquatable<AlertHighlight>
Inheritance
AlertHighlight
Implements
Inherited Members

Constructors

AlertHighlight(string, string, bool, string?, IReadOnlyList<int>)

A highlight an alert draws, and the viewing groups that turn it on or off.

public AlertHighlight(string Id, string Style, bool Optional, string? MessageId, IReadOnlyList<int> ViewingGroups)

Parameters

Id string

The highlight's id.

Style string

Its style, e.g. AlarmHighlight or CautionHighlight.

Optional bool

Whether the mariner may turn it off.

MessageId string

The id of the message shown when it's off, or null.

ViewingGroups IReadOnlyList<int>

The viewing groups it's drawn in; for S-101 ProhAre, one per kind of area (53012–53024), which AlertReference names.

Properties

Id

The highlight's id.

public string Id { get; init; }

Property Value

string

MessageId

The id of the message shown when it's off, or null.

public string? MessageId { get; init; }

Property Value

string

Optional

Whether the mariner may turn it off.

public bool Optional { get; init; }

Property Value

bool

Style

Its style, e.g. AlarmHighlight or CautionHighlight.

public string Style { get; init; }

Property Value

string

ViewingGroups

The viewing groups it's drawn in; for S-101 ProhAre, one per kind of area (53012–53024), which AlertReference names.

public IReadOnlyList<int> ViewingGroups { get; init; }

Property Value

IReadOnlyList<int>