Class MarinerSettings

Namespace

EncDotNet.S100.Pipelines

Assembly

EncDotNet.S100.Core.dll

Mariner-configurable display preferences used by S-100 portrayal rules (S-100 Part 9 §4.2 — "Mariner Selections"). These values are independent of the current display viewport and are typically persisted across sessions per user preference.

public sealed record MarinerSettings : IEquatable<MarinerSettings>

Inheritance

object

MarinerSettings

Implements

IEquatable<MarinerSettings>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Depth fields are strongly typed as Depth (canonically metres); the DepthUnit only affects how depth values are presented to the mariner in the viewer (Pick panel, legend, status bar, settings inputs). Default values for the boolean toggles match the defaults declared by the bundled S-101 portrayal catalogue (portrayal_catalogue.xml §context).

Properties

DeepContour

Deep contour depth (S-101 PC parameter DeepContour).

public Depth DeepContour { get; init; }

Property Value

Depth

Default

Default mariner settings (safety contour 30 m, etc.).

public static MarinerSettings Default { get; }

Property Value

MarinerSettings

DepthUnit

Display unit used by the viewer when presenting depth values to the mariner (Pick panel, S-102 legend, status bar, settings inputs). Canonical depth storage in this record is always metres; this only affects formatting/parsing.

public DepthUnit DepthUnit { get; init; }

Property Value

DepthUnit

FourShades

Whether to use the four-shade depth area scheme (S-101 PC parameter FourShades). When false only the two-shade scheme is used, in which case ShallowContour and DeepContour are typically ignored by the catalogue.

public bool FourShades { get; init; }

Property Value

bool

FullLightLines

Whether to draw light sectors as full lines extending to their nominal range (S-101 PC parameter FullLightLines).

public bool FullLightLines { get; init; }

Property Value

bool

IgnoreScaleMinimum

Whether to ignore the cell scale-minimum attribute and always portray features regardless of the user's scale (S-101 PC parameter IgnoreScaleMinimum).

public bool IgnoreScaleMinimum { get; init; }

Property Value

bool

NationalLanguage

Preferred 3-letter ISO 639-2/B language code for chart text (S-101 PC parameter NationalLanguage). An empty string means "use the catalogue's declared default" — no override is sent to the portrayal engine.

public string NationalLanguage { get; init; }

Property Value

string

PlainBoundaries

Whether to draw plain (un-symbolised) area boundaries (S-101 PC parameter PlainBoundaries).

public bool PlainBoundaries { get; init; }

Property Value

bool

RadarOverlay

Whether the chart is being drawn under a radar overlay (S-101 PC parameter RadarOverlay).

public bool RadarOverlay { get; init; }

Property Value

bool

SafetyContour

Safety contour depth (S-101 PC parameter SafetyContour).

public Depth SafetyContour { get; init; }

Property Value

Depth

SafetyDepth

Safety depth for sounding selection (S-101 PC parameter SafetyDepth).

public Depth SafetyDepth { get; init; }

Property Value

Depth

ShallowContour

Shallow contour depth (S-101 PC parameter ShallowContour).

public Depth ShallowContour { get; init; }

Property Value

Depth

ShallowWaterDangers

Whether to highlight isolated dangers in shallow water (S-101 PC parameter ShallowWaterDangers).

public bool ShallowWaterDangers { get; init; }

Property Value

bool

SimplifiedSymbols

Whether to use simplified point symbols (S-101 PC parameter SimplifiedSymbols).

public bool SimplifiedSymbols { get; init; }

Property Value

bool