Class ChartedDepth

Namespace

EncDotNet.S100.Navigation

Assembly

EncDotNet.S100.Navigation.dll

A charted depth at a point and where it came from.

public sealed record ChartedDepth : IEquatable<ChartedDepth>

Inheritance

object

ChartedDepth

Implements

IEquatable<ChartedDepth>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ChartedDepth(double, ChartedDepthKind, double?, int?, string?, string?, double?)

A charted depth at a point and where it came from.

public ChartedDepth(double DepthMeters, ChartedDepthKind Kind, double? UncertaintyMeters = null, int? VerticalDatum = null, string? DatasetId = null, string? Reference = null, double? SoundingDistanceMeters = null)

Parameters

DepthMeters double

Depth in metres below the vertical datum (positive down; negative for drying heights).

Kind ChartedDepthKind

The kind of source.

UncertaintyMeters double?

The S-102 vertical uncertainty in metres, or null.

VerticalDatum int?

The vertical datum as an S-100 register code (source identifier 996), or null when the source doesn't declare one.

DatasetId string

Identifier of the dataset or cell that supplied the depth.

Reference string

Where in the dataset the depth came from: the grid cell (row,col) for S-102, or the feature record id for S-101.

SoundingDistanceMeters double?

Distance to the sounding, for Sounding.

Properties

DatasetId

Identifier of the dataset or cell that supplied the depth.

public string? DatasetId { get; init; }

Property Value

string

DepthMeters

Depth in metres below the vertical datum (positive down; negative for drying heights).

public double DepthMeters { get; init; }

Property Value

double

IsLowConfidence

true when the depth comes from S-101 rather than an S-102 surface. A vector depth is a band minimum or a single sounding, not a surveyed surface, so the check marks it low confidence.

public bool IsLowConfidence { get; }

Property Value

bool

Kind

The kind of source.

public ChartedDepthKind Kind { get; init; }

Property Value

ChartedDepthKind

Reference

Where in the dataset the depth came from: the grid cell (row,col) for S-102, or the feature record id for S-101.

public string? Reference { get; init; }

Property Value

string

SoundingDistanceMeters

Distance to the sounding, for Sounding.

public double? SoundingDistanceMeters { get; init; }

Property Value

double?

UncertaintyMeters

The S-102 vertical uncertainty in metres, or null.

public double? UncertaintyMeters { get; init; }

Property Value

double?

VerticalDatum

The vertical datum as an S-100 register code (source identifier 996), or null when the source doesn't declare one.

public int? VerticalDatum { get; init; }

Property Value

int?