Class NavigationalWarningInfo

Namespace

EncDotNet.S100.Datasets.Pipelines

Assembly

EncDotNet.S100.Core.dll

The message of a navigational warning part, projected for object information UIs: identification, type, validity, area and the full text in every language the dataset gives (S-124 NavwarnPart read through its NavwarnPreamble header).

public sealed record NavigationalWarningInfo : IEquatable<NavigationalWarningInfo>

Inheritance

object

NavigationalWarningInfo

Implements

IEquatable<NavigationalWarningInfo>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A UI shows this as one card, not as attribute rows. The text is the point of picking a warning, and a SECURITE message runs to 10–20 lines.

Properties

AffectedAreas

The areas the part affects beyond its own geometry (S-124 NavwarnAreaAffected, through areaAffected), in WGS-84. Empty when it names none.

public IReadOnlyList<S100FeatureGeometry> AffectedAreas { get; init; }

Property Value

IReadOnlyList<S100FeatureGeometry>

CancellationDate

When the warning cancels itself, or null when it stays in force until cancelled.

public DateTimeOffset? CancellationDate { get; init; }

Property Value

DateTimeOffset?

Cancels

The warnings this one cancels (S-124 References with referenceCategory 1), in document order. Empty when it cancels none.

public IReadOnlyList<NavigationalWarningReference> Cancels { get; init; }

Property Value

IReadOnlyList<NavigationalWarningReference>

GeneralArea

The general area (e.g. "Coral Sea"), when given.

public string? GeneralArea { get; init; }

Property Value

string

GeneralType

The general warning type (S-124 navwarnTypeGeneral), when given.

public string? GeneralType { get; init; }

Property Value

string

HasLocation

Whether the part has geometry, so the map draws it.

public bool HasLocation { get; init; }

Property Value

bool

InForceBulletin

What the warning lists as in force when it is an in-force bulletin (S-124: a References of referenceCategory 3), or null for any other warning. NavigationalWarningSet uses it to end warnings the latest bulletin leaves out (§9.2.1).

public NavigationalWarningBulletin? InForceBulletin { get; init; }

Property Value

NavigationalWarningBulletin

Issuer

The authority or agency that issued the warning, when given.

public string? Issuer { get; init; }

Property Value

string

Label

The series and number (e.g. "NAVAREA X 106/26"), or null when the preamble gives no number.

public string? Label { get; }

Property Value

string

Locality

The locality within the general area, when given.

public string? Locality { get; init; }

Property Value

string

Number

The warning number and two-digit year as mariners write it (e.g. "106/26"), or null when the preamble gives no number.

public string? Number { get; init; }

Property Value

string

PublicationTime

When the warning was published, when given.

public DateTimeOffset? PublicationTime { get; init; }

Property Value

DateTimeOffset?

Reference

The warning's identifier in its series, or null when the preamble gives no number; what another warning's cancellation names.

public NavigationalWarningReference? Reference { get; init; }

Property Value

NavigationalWarningReference

Series

The series name (e.g. "NAVAREA X", "AUSCOAST"), when given.

public string? Series { get; init; }

Property Value

string

Texts

The message text, one entry per language in document order. Empty when the part has none.

public IReadOnlyList<NavigationalWarningText> Texts { get; init; }

Property Value

IReadOnlyList<NavigationalWarningText>

Title

The warning's title, when given.

public string? Title { get; init; }

Property Value

string

Validity

When the part applies, in document order. Empty when the part gives no range.

public IReadOnlyList<NavigationalWarningValidity> Validity { get; init; }

Property Value

IReadOnlyList<NavigationalWarningValidity>

WarningType

The detailed warning type (S-124 navwarnTypeDetails, e.g. "Cable Operations"), when given.

public string? WarningType { get; init; }

Property Value

string

Methods

StatusAt(DateTimeOffset)

Whether the warning applies at time, judged on this warning alone. A warning is ended once its cancellation date has passed or every validity range has ended, and not yet in force while it waits for a range to start. With no validity range it is in force until cancelled.

public NavigationalWarningStatus StatusAt(DateTimeOffset time)

Parameters

time DateTimeOffset

The time to test, usually the view time.

Returns

NavigationalWarningStatus

The warning's status at that time.

Remarks

Cancellation datasets and in-force bulletins end a warning too; they are other warnings, so StatusAt(NavigationalWarningInfo, DateTimeOffset) applies them. The rule itself is StatusAt(IReadOnlyList<NavigationalWarningValidity>, DateTimeOffset?, DateTimeOffset), which CAP weather warnings share.