Class S100ExchangeSetDataset

Namespace

EncDotNet.S100

Assembly

EncDotNet.S100.dll

One dataset listed by an S100ExchangeSet: its discovery metadata and, for an S-101 base cell, the sequential updates the exchange set ships for it.

public sealed class S100ExchangeSetDataset

Inheritance

object

S100ExchangeSetDataset

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Metadata

The catalogue's discovery metadata for the dataset (for an S-101 cell with updates, the base cell). RelativePath locates it in the exchange set.

public DatasetDiscoveryMetadata Metadata { get; }

Property Value

DatasetDiscoveryMetadata

Updates

The S-101 sequential updates the exchange set ships for this base cell, in ascending update-number order; empty for every other dataset. Opening the dataset applies them.

public IReadOnlyList<DatasetDiscoveryMetadata> Updates { get; }

Property Value

IReadOnlyList<DatasetDiscoveryMetadata>

Methods

OpenAsync(CancellationToken)

Opens the dataset, parsed against the bundled catalogues. The product specification is taken from the catalogue entry and, when the catalogue does not declare a recognised one, detected from the dataset content. An S-101 base cell opens with its Updates applied, and an S-101 cell can resolve the text files it references through the exchange set's support files.

public Task<S100Dataset> OpenAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels reading the dataset for detection.

Returns

Task<S100Dataset>

The opened dataset. It reads from the exchange set's source lazily, so dispose it before the exchange set.

Exceptions

InvalidOperationException

The entry is an S-101 update whose base cell is not in the exchange set; updates are only applied together with their base cell.

NotSupportedException

The dataset is not a recognised S-100 product specification.

ObjectDisposedException

The exchange set has been disposed.