Class SampledField

Namespace

EncDotNet.S100.Datasets.Pipelines.Query

Assembly

EncDotNet.S100.Core.dll

One sampled value with its quantity and unit.

public sealed record SampledField : IEquatable<SampledField>

Inheritance

object

SampledField

Implements

IEquatable<SampledField>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SampledField(string, string, string?, double?, string?)

One sampled value with its quantity and unit.

public SampledField(string Name, string Quantity, string? Unit, double? Value, string? Text = null)

Parameters

Name string

The product's name for the field — its S-100 attribute code where it has one (depth, waterLevelHeight, surfaceCurrentSpeed). Unique within a sample.

Quantity string

What the value measures, independent of the product, in snake case (depth, water_level_height, current_speed, significant_wave_height, wind_speed), so a caller can find, say, a speed in any product.

Unit string

Unit symbol of Value: m, m/s, kn, deg (degrees from true north, clockwise) and so on; null for a unitless or categorical value.

Value double?

The numeric value, or null for a categorical value or one the cell does not carry.

Text string

The value of a categorical field (e.g. an S-104 trend), or null.

Properties

Name

The product's name for the field — its S-100 attribute code where it has one (depth, waterLevelHeight, surfaceCurrentSpeed). Unique within a sample.

public string Name { get; init; }

Property Value

string

Quantity

What the value measures, independent of the product, in snake case (depth, water_level_height, current_speed, significant_wave_height, wind_speed), so a caller can find, say, a speed in any product.

public string Quantity { get; init; }

Property Value

string

Text

The value of a categorical field (e.g. an S-104 trend), or null.

public string? Text { get; init; }

Property Value

string

Unit

Unit symbol of Value: m, m/s, kn, deg (degrees from true north, clockwise) and so on; null for a unitless or categorical value.

public string? Unit { get; init; }

Property Value

string

Value

The numeric value, or null for a categorical value or one the cell does not carry.

public double? Value { get; init; }

Property Value

double?