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
IdstringThe highlight's id.
StylestringIts style, e.g.
AlarmHighlightorCautionHighlight.OptionalboolWhether the mariner may turn it off.
MessageIdstringThe id of the message shown when it's off, or null.
ViewingGroupsIReadOnlyList<int>The viewing groups it's drawn in; for S-101
ProhAre, one per kind of area (53012–53024), whichAlertReferencenames.
Properties
Id
The highlight's id.
public string Id { get; init; }
Property Value
MessageId
The id of the message shown when it's off, or null.
public string? MessageId { get; init; }
Property Value
Optional
Whether the mariner may turn it off.
public bool Optional { get; init; }
Property Value
Style
Its style, e.g. AlarmHighlight or CautionHighlight.
public string Style { get; init; }
Property Value
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; }