Class AlertCatalogue

Namespace

EncDotNet.S100.Portrayals

Assembly

EncDotNet.S100.Portrayals.dll

A portrayal catalogue's alert catalogue (S-100 Part 9 §9-17): the alerts drawing instructions refer to with AlertReference, with their messages and highlights. S-101 defines SafetyContour, ProhAre and NavHazard.

public sealed class AlertCatalogue

Inheritance

object

AlertCatalogue

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Alerts

The alerts, in document order.

public required IReadOnlyList<AlertDefinition> Alerts { get; init; }

Property Value

IReadOnlyList<AlertDefinition>

Highlights

The highlights, in document order.

public required IReadOnlyList<AlertHighlight> Highlights { get; init; }

Property Value

IReadOnlyList<AlertHighlight>

Messages

The messages, by id.

public required IReadOnlyDictionary<string, AlertMessage> Messages { get; init; }

Property Value

IReadOnlyDictionary<string, AlertMessage>

Version

The catalogue's version, from the root @version; empty when absent.

public required string Version { get; init; }

Property Value

string

Methods

FindAlert(string)

The alert with an id, or null when there's none.

public AlertDefinition? FindAlert(string id)

Parameters

id string

The alert's id, as an AlertReference names it.

Returns

AlertDefinition

The alert, or null.

FindHighlight(string)

The highlight with an id, or null when there's none.

public AlertHighlight? FindHighlight(string id)

Parameters

id string

The highlight's id.

Returns

AlertHighlight

The highlight, or null.