Class AreaDetails

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

A regulated area the route meets (Area): what it is, what it restricts and when it's in force.

public sealed class AreaDetails : RouteFindingDetails

Inheritance

object

RouteFindingDetails

AreaDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AreaKind

Its alert-catalogue kind (AreaKind), or null.

public int? AreaKind { get; init; }

Property Value

int?

AtEta

Whether From and Until are ETAs rather than the fallback time.

public bool AtEta { get; init; }

Property Value

bool

Categories

Its category codes (Categories).

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

Property Value

IReadOnlyList<int>

CategoryOfMarineProtectedArea

An S-122 area's IUCN category code, or null.

public int? CategoryOfMarineProtectedArea { get; init; }

Property Value

int?

FeatureType

Its feature type, such as "RestrictedArea".

public required string FeatureType { get; init; }

Property Value

string

FixedDateRange

When it's valid, or null for always.

public RouteAreaDateRange? FixedDateRange { get; init; }

Property Value

RouteAreaDateRange

From

When the vessel reaches it: the ETA, or the fallback time when AtEta is false.

public DateTimeOffset From { get; init; }

Property Value

DateTimeOffset

InForce

Whether it's in force while the vessel is there.

public bool InForce { get; init; }

Property Value

bool

Kind

What it is.

public required RouteAreaKind Kind { get; init; }

Property Value

RouteAreaKind

Name

Its name, or null.

public string? Name { get; init; }

Property Value

string

PeriodicDateRanges

When it's active each year; empty for all year.

public IReadOnlyList<RouteAreaDateRange> PeriodicDateRanges { get; init; }

Property Value

IReadOnlyList<RouteAreaDateRange>

Product

The product it comes from.

public required RouteAreaProduct Product { get; init; }

Property Value

RouteAreaProduct

Relation

How it relates to the route (never Off).

public RouteAreaRelation Relation { get; init; }

Property Value

RouteAreaRelation

Restrictions

Its restriction codes.

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

Property Value

IReadOnlyList<int>

Until

When the vessel leaves it; equal to From when AtEta is false.

public DateTimeOffset Until { get; init; }

Property Value

DateTimeOffset