Class PortrayalAlertReference

Namespace

EncDotNet.S100.Pipelines.Vector

Assembly

EncDotNet.S100.Core.dll

A reference from a drawing instruction to an alert in the portrayal catalogue's alert catalogue (S-100 Part 9 §9-11.2.5), set by the AlertReference:alertReference[,plan[,monitor]] command of Part 9a §9a-11.2.2.9: the S-101 NavHazard, ProhAre or SafetyContour alert a feature raises when a route crosses it.

public sealed record PortrayalAlertReference : IEquatable<PortrayalAlertReference>

Inheritance

object

PortrayalAlertReference

Implements

IEquatable<PortrayalAlertReference>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PortrayalAlertReference(string, int?, int?)

A reference from a drawing instruction to an alert in the portrayal catalogue's alert catalogue (S-100 Part 9 §9-11.2.5), set by the AlertReference:alertReference[,plan[,monitor]] command of Part 9a §9a-11.2.2.9: the S-101 NavHazard, ProhAre or SafetyContour alert a feature raises when a route crosses it.

public PortrayalAlertReference(string Reference, int? PlanViewingGroup = null, int? MonitorViewingGroup = null)

Parameters

Reference string

The alert's id in the alert catalogue, e.g. ProhAre.

PlanViewingGroup int?

The viewing group of the alert's highlight in route planning, or null when none is given and the highlight can't be turned off.

MonitorViewingGroup int?

The viewing group of the alert's highlight in route monitoring, or null when none is given.

Properties

MonitorViewingGroup

The viewing group of the alert's highlight in route monitoring, or null when none is given.

public int? MonitorViewingGroup { get; init; }

Property Value

int?

PlanViewingGroup

The viewing group of the alert's highlight in route planning, or null when none is given and the highlight can't be turned off.

public int? PlanViewingGroup { get; init; }

Property Value

int?

Reference

The alert's id in the alert catalogue, e.g. ProhAre.

public string Reference { get; init; }

Property Value

string

Methods

Parse(string?)

Parses the value of an AlertReference command.

public static PortrayalAlertReference? Parse(string? value)

Parameters

value string

The command's value, e.g. ProhAre,53023,53023.

Returns

PortrayalAlertReference

The reference, or null when the value is empty: a bare AlertReference clears the alert for the instructions that follow.