Struct Hdf5RootInfo

Namespace

EncDotNet.S100.Datasets.Pipelines

Assembly

EncDotNet.S100.Datasets.Pipelines.dll

A view of an HDF5 file's root group, handed to each product's DatasetHdf5Matcher. The root productSpecification attribute is read once up front; any other root attribute can be read with ReadStringAttribute(string), which is only valid while the matcher runs (the factory closes the file afterwards), so a matcher must not keep the value.

public readonly record struct Hdf5RootInfo : IEquatable<Hdf5RootInfo>

Implements

IEquatable<Hdf5RootInfo>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

ProductSpecification

The root productSpecification attribute (S-100 Part 10c), e.g. INT.IHO.S-102.2.2. Empty when the file declares none or it can't be read.

public required string ProductSpecification { get; init; }

Property Value

string

Methods

DeclaresProduct(string)

Whether ProductSpecification names productId (e.g. "S-104"). Matches by substring, case-insensitively, as the factory always has, so a producer that writes S-104 or INT.IHO.S-104.2.0 is recognized either way.

public bool DeclaresProduct(string productId)

Parameters

productId string

The canonical product id to look for.

Returns

bool

ReadStringAttribute(string)

Reads the root string attribute name, or returns null when it is absent or unreadable. Valid only while the matcher runs.

public string? ReadStringAttribute(string name)

Parameters

name string

The attribute name, e.g. "Conventions".

Returns

string