Class RouteArea

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

One regulated area to check a route against: an S-101 restricted, caution, anchorage or traffic area, or an S-122 protected area.

public sealed record RouteArea : IEquatable<RouteArea>

Inheritance

object

RouteArea

Implements

IEquatable<RouteArea>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RouteArea(RouteAreaProduct, RouteAreaKind, string, IReadOnlyList<SurfacePart>, RouteFindingFeature?)

One regulated area to check a route against: an S-101 restricted, caution, anchorage or traffic area, or an S-122 protected area.

public RouteArea(RouteAreaProduct Product, RouteAreaKind Kind, string FeatureType, IReadOnlyList<SurfacePart> Surfaces, RouteFindingFeature? Feature = null)

Parameters

Product RouteAreaProduct

The product it comes from.

Kind RouteAreaKind

What it is.

FeatureType string

Its feature type, such as "RestrictedArea".

Surfaces IReadOnlyList<SurfacePart>

Its surfaces in WGS-84, with their holes.

Feature RouteFindingFeature

The feature behind it, which the finding refers to, or null.

Properties

AreaKind

Its kind of prohibited area or area with special conditions in the S-101 alert catalogue: the viewing group of its ProhAre highlight (53012–53024, RouteAreaKinds), or null when it raises no ProhAre alert, as an S-122 area or an S-101 precautionary area (#1127).

public int? AreaKind { get; init; }

Property Value

int?

Categories

Its category codes: categoryOfRestrictedArea for a restricted or protected area, categoryOfMilitaryPracticeArea, categoryOfAnchorage.

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

Property Value

IReadOnlyList<int>

CategoryOfMarineProtectedArea

An S-122 area's categoryOfMarineProtectedArea (IUCN category), or null.

public int? CategoryOfMarineProtectedArea { get; init; }

Property Value

int?

Cell

The S-101 cell that charts it, for the finest-cell rule, or null (S-122, or when not known).

public RouteChartCell? Cell { get; init; }

Property Value

RouteChartCell

Feature

The feature behind it, which the finding refers to, or null.

public RouteFindingFeature? Feature { get; init; }

Property Value

RouteFindingFeature

FeatureType

Its feature type, such as "RestrictedArea".

public string FeatureType { get; init; }

Property Value

string

FixedDateRange

When the area is valid (fixedDateRange), or null for always.

public RouteAreaDateRange? FixedDateRange { get; init; }

Property Value

RouteAreaDateRange

Kind

What it is.

public RouteAreaKind Kind { get; init; }

Property Value

RouteAreaKind

Name

Its name (featureName), or null.

public string? Name { get; init; }

Property Value

string

PeriodicDateRanges

When the area is active each year (periodicDateRange); empty for all year.

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

Property Value

IReadOnlyList<RouteAreaDateRange>

Product

The product it comes from.

public RouteAreaProduct Product { get; init; }

Property Value

RouteAreaProduct

Restrictions

Its restriction codes, in the order given.

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

Property Value

IReadOnlyList<int>

Surfaces

Its surfaces in WGS-84, with their holes.

public IReadOnlyList<SurfacePart> Surfaces { get; init; }

Property Value

IReadOnlyList<SurfacePart>