Class DownloadedCell

Namespace

EncDotNet.S100.Collections.Downloads

Assembly

EncDotNet.S100.Collections.dll

An ENC cell — or a package of cells — downloaded into a managed folder: what was downloaded and where its exchange set now lies.

public sealed record DownloadedCell : IEquatable<DownloadedCell>

Inheritance

object

DownloadedCell

Implements

IEquatable<DownloadedCell>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DownloadedCell(string, int?, int?, DateTimeOffset?, DateTimeOffset, LocalItemLocation)

An ENC cell — or a package of cells — downloaded into a managed folder: what was downloaded and where its exchange set now lies.

public DownloadedCell(string Name, int? Edition, int? Update, DateTimeOffset? PublishedAt, DateTimeOffset DownloadedAt, LocalItemLocation Location)

Parameters

Name string

The cell name, or the package name.

Edition int?

The edition downloaded (none for a package).

Update int?

The update number downloaded (none for a package).

PublishedAt DateTimeOffset?

When the provider published the download, if known.

DownloadedAt DateTimeOffset

When the download completed.

Location LocalItemLocation

The downloaded cell (for a package, its first cell), ready to load; for an S-100 package with no current datasets, its catalogue.

Properties

Datasets

The downloaded base cells by name (case-insensitive); for a single cell, just Location.

public IReadOnlyDictionary<string, LocalItemLocation> Datasets { get; init; }

Property Value

IReadOnlyDictionary<string, LocalItemLocation>

DownloadedAt

When the download completed.

public DateTimeOffset DownloadedAt { get; init; }

Property Value

DateTimeOffset

Edition

The edition downloaded (none for a package).

public int? Edition { get; init; }

Property Value

int?

IsPackage

True when this is a package: a download holding any number of cells.

public bool IsPackage { get; init; }

Property Value

bool

Location

The downloaded cell (for a package, its first cell), ready to load; for an S-100 package with no current datasets, its catalogue.

public LocalItemLocation Location { get; init; }

Property Value

LocalItemLocation

Name

The cell name, or the package name.

public string Name { get; init; }

Property Value

string

PublishedAt

When the provider published the download, if known.

public DateTimeOffset? PublishedAt { get; init; }

Property Value

DateTimeOffset?

Revision

The Revision downloaded, if the item had one.

public string? Revision { get; init; }

Property Value

string

Signature

The data signature check made when a SECOM object was downloaded (issue #804); null for other downloads.

public SecomSignatureCheck? Signature { get; init; }

Property Value

SecomSignatureCheck

Update

The update number downloaded (none for a package).

public int? Update { get; init; }

Property Value

int?

Methods

IsOlderThan(CollectionItem)

True when item (a feed item for the same cell or package) describes a newer download: a newer edition or update, or — for a package, or a dataset without editions such as a forecast run (#685) — a later publication date, or another Revision (#916).

public bool IsOlderThan(CollectionItem item)

Parameters

item CollectionItem

Returns

bool