Namespace EncDotNet.S100.Collections
Classes
- CatalogFacetValue
One selectable value of an online catalogue's facet (a NOAA state, district or region, a USACE river, …) with what selecting it would include.
- ChartCatalogsFeedSource
A community chart list in the
chartcatalogsformat (for example "Romania IENC Charts"), optionally scoped to some of its entries. Entries are downloads that may hold several cells; until an entry is downloaded it is one online item without bounds, afterwards its cells are listed with their bounds.
- ChartCatalogsFilter
Selects entries from a community chart list by number. With no entry selected, every entry matches.
- CollectionItem
One dataset described by a collection source: its identification, currency, scale and coverage metadata, and where its data lives. Indexing produces items without loading the datasets.
- CollectionSource
Where a collection's items come from. Each concrete kind has an ICollectionSourceIndexer that turns it into CollectionItems.
- DatasetCollection
A named, persisted grouping of exchange sets and/or datasets, built from one or more CollectionSources (for example "Alaska ENCs").
- ExchangeSetLayout
The file-naming rules that identify exchange sets on disk: S-100 (
CATALOG.XML) and S-57 (CATALOG.031) catalogues. Shared by collection indexing and hosts that open exchange sets directly, so detection has one owner.
- ExchangeSetSource
A single exchange set: its root folder, its catalogue file, or a ZIP containing it. Referenced in place, never copied.
- ForecastModel
One forecast model of an S-100 forecast feed (#685), for example NOAA's Chesapeake Bay Operational Forecast System (
cbofs) for S-111 surface currents. Its catalogue lists only its latest run.
- GeoCoverage
The coverage of a collection item as a multi-polygon in EPSG:4326.
- GeoPolygon
One coverage polygon: an exterior ring and zero or more holes, with (latitude, longitude) vertices in EPSG:4326.
- IndexDiagnostic
A problem met while indexing a source.
- ItemLocation
Where a CollectionItem's data lives.
- LocalFolderSource
A local folder, scanned for exchange sets (S-100
CATALOG.XML, S-57CATALOG.031, and zipped exchange sets) and loose datasets. Referenced in place, never copied.
- LocalItemLocation
The item's data is on the local file system, either in a folder or inside a ZIP archive.
- LocalManifestFilter
Selects groups from a collection manifest. With no group selected, every group matches — including groups added to the manifest later.
- LocalManifestSource
A local collection manifest (
*.s100collection.json): a JSON file that names groups of local folders, exchange sets or datasets (for example one per producing country), optionally scoped to some of its groups. The manifest is a live reference — it is re-read on every refresh — and its data is referenced in place, never copied. Seedocs/local-collection-manifest.md.
- NoItemLocation
The source describes the product but has no data for it (for example an S-128 catalogue entry).
- NoaaEncFeedSource
The NOAA ENC product catalogue feed (
ENCProdCat.xml), optionally scoped to states, Coast Guard districts or regions (for example "NOAA ENC — Alaska"). Its items are online (RemoteItemLocation) until downloaded.
- NoaaEncFilter
Selects cells from the NOAA ENC product catalogue by state, Coast Guard district or region.
- PackageLayout
Where a dataset's files lie within a downloaded package, relative to its root (forward slashes): the same shape as a LocalItemLocation without the root.
- RemoteItemLocation
The item's data is available for download.
- RemotePart
One request of a download assembled from several (#1075).
- S100CatalogueFeedSource
A remote S-100 exchange catalogue (
CATALOG.XML) published over HTTP with its datasets beside it — for example NOAA's S-102 bathymetry on AWS Open Data (issue #685) — optionally scoped to some of its folders and navigation purposes. Its items carry the catalogue's coverage and are online (RemoteItemLocation) until downloaded.
- S100CatalogueFilter
Selects datasets from a remote S-100 exchange catalogue by folder (for NOAA's S-102, a region such as
Northeastor an area such asNortheast/Long_Island_Sound) and by navigation purpose (e.g.port,transit). An empty list leaves that facet unscoped.
- S100FeedFilter
Selects items from an S-100 feed by product specification. With no product selected, every item matches.
- S100FeedSource
An S-100 feed (issue #680) — this library's own JSON feed, for example one served by
s100 feed serveon another machine — optionally scoped to some product specifications. Its items carry the publisher's coverage and are online (RemoteItemLocation) until downloaded.
- S100ForecastFeedSource
An S-100 forecast feed (#685) — for example NOAA's S-111 surface currents on AWS Open Data — scoped to some of its models. Each model's catalogue (
<model>/CATALOG.XMLunderModelsUri) lists only its latest run, so its items are that run's datasets: online (RemoteItemLocation) until downloaded, superseded by the next run.
- S128CatalogueSource
An S-128 Catalogue of Nautical Products dataset. Its entries describe products that are usually not present locally, so they index as catalogue-only (NoItemLocation) items.
- SecomFilter
Selects objects from a SECOM service: by product specification (matched on this side, since services spell product types differently) and, optionally, by an area the service filters on. With nothing selected, every object matches.
- SecomSource
A SECOM (IEC 63173-2) service — for example the Canadian Coast Guard's S-124 navigational warnings — read anonymously through
GetSummaryandGet(issue #804), optionally scoped to some products or an area. Its objects are online (RemoteItemLocation with a Secom envelope) until downloaded; summaries carry no coverage, so objects have bounds only once downloaded.
- SourceIndex
The result of indexing one CollectionSource: its items plus the fingerprint that decides whether a later refresh can reuse it.
- SourceIndexGroup
A group of a SourceIndex, such as one group of a collection manifest.
- UsaceIencFeedSource
A USACE Inland ENC product catalogue feed (river cells or the buoy overlay), optionally scoped to rivers (for example "USACE IENC — Ohio"). Its items are online (RemoteItemLocation) until downloaded.
- UsaceIencFilter
Selects cells from a USACE Inland ENC product catalogue by river. With no river selected, every cell matches.
- WeatherFeedSource
A weather service (#1075; design note weather-sources.md §6.3): NOMADS' GRIB filter or NOAA's GFS files on AWS (one model run, cut to the chosen parameters, forecast hours and, for the filter, area), active
api.weather.govalerts for an area's marine zones, or ERDDAP datasets chosen by dataset id. Each index lists the service's latest run (or the alerts in force now) as one online item per model or dataset, downloaded as one file; a newer run replaces the last unless it is pinned.
Structs
- GeoBounds
An axis-aligned geographic bounding box in decimal degrees (EPSG:4326).
- IndexProgress
Progress reported while indexing a source.
Enums
- CollectionItemStatus
The currency status of a CollectionItem.
- ForecastShape
How a forecast feed's runs are downloaded.
- IndexDiagnosticSeverity
The severity of an IndexDiagnostic.
- RemoteEnvelope
How a RemoteItemLocation's download wraps its data.