Top APIs
This page lists the main public entry points in each EncDotNet.S100 package. For every type and member, see the API reference.
Start with the EncDotNet.S100 facade package. It covers opening, reading,
validating and rendering a dataset with the bundled catalogues. Use the
per-product and lower-level packages when you need your own catalogue wiring
or more control over the pipeline.
EncDotNet.S100
| API | Use it to |
|---|---|
S100Dataset.Open(path) |
Open a dataset file and detect its product specification. |
S100Dataset.OpenAsync(source, relativePath) |
Open a dataset inside an IAssetSource, such as a folder or a ZIP. |
S100ExchangeSet.OpenAsync(...) |
Open an exchange set from a folder, a CATALOG.XML or a ZIP, with S-101 updates applied. |
WithDecryption(keys) |
Decrypt an S-100 Part 15 protected exchange set. |
S100FeatureCatalogue.Bundled(spec) |
Read decoded features using the bundled feature catalogue. |
PngS100DatasetRenderer.RenderAsync(...) |
Render a dataset, or a list of S100Layer values, to PNG bytes. |
S100RendererOptions, S100CompositeOptions |
Set image size, palette, scale, time step and, for composites, the viewport and mariner settings. |
Validate() |
Run the product's bundled validation rules. |
Getting started shows these together, and Loading datasets covers the open methods in detail.
EncDotNet.S100.Core
IAssetSource, withFileSystemAssetSource,ZipAssetSourceandCachingAssetSource: where datasets, catalogues and support files are read from.CoveragePipelineandVectorPipeline: the portrayal pipelines.DrawingInstructionand its subclasses: the pipeline output.MarinerSettings,ViewportandBoundingBox.ValidationRuleSet<TModel>andValidationFinding: validation building blocks.ProjectionDiagnosticandGeoPosition: shared types for the typed data models. See Typed data models.
EncDotNet.S100.ExchangeSets
ExchangeSet.OpenAsync(source): open an exchange set'sCATALOG.XMLthrough anIAssetSource, then read its files withFetchDatasetAsyncandFetchSupportFileAsync.ExchangeCatalogueReader: parse a catalogue directly.ExchangeSetVerifier: verify digital signatures and checksums.EncDotNet.S100.ExchangeSets.Protection: S-100 Part 15 protection.PermitSignatureVerifier,PermitKeyProviderandDecryptingAssetSourceread protected data;Part15Signer,PermitFileWriterandDataPermitcreate it. See Reading protected exchange sets.
EncDotNet.S100.Datasets.Pipelines
DatasetPipelineFactory: detect a file's product specification and create itsIDatasetProcessor, including S-101 and S-57 update application.ExchangeSetLoader: load every dataset in an exchange set.
EncDotNet.S100.Datasets.S101
S101Dataset.Open(...)andS101Dataset.OpenWithUpdates(...): read an ISO 8211 base cell, with or without its updates.S101PortrayalCatalogue: the Lua (S-100 Part 9A) portrayal catalogue.
EncDotNet.S100.Datasets.S102, S104 and S111
S102DatasetReader,S104DatasetReaderandS111DatasetReader: read anIHdf5File. Open one withPureHdfFilefromEncDotNet.S100.Hdf5.PureHdf.S102CoverageSource,S104CoverageSourceandS111CoverageSource: grid and time-step access for the coverage pipeline.
GML product packages
SxxxDataset.Open(path)orSxxxDataset.Open(stream)for S-122, S-124, S-125, S-127, S-128, S-129, S-131, S-201, S-411 and S-421.- A typed data model for each, built with
Sxxx{Root}.From(dataset, out diagnostics), for exampleS421RoutePlanandS124NavigationalWarning. See Typed data models. S421DatasetWriter: write a typed S-421 route as GML. See the S-421 package README.
EncDotNet.S100.Datasets.S57
S57ToS101Translator: translate an S-57 cell into the S-101 model. See Bringing S-57 into the pipeline.S57ExchangeSetVerification: check the CRCs of an S-57 or S-63 exchange set.
Catalogues
FeatureCatalogueReaderandFeatureCatalogueManager(EncDotNet.S100.Features): S-100 Part 5 feature catalogues.PortrayalCatalogueReaderandPortrayalCatalogueManager(EncDotNet.S100.Portrayals): S-100 Part 9 portrayal catalogues.Specification(EncDotNet.S100.Specifications): the bundled official catalogues.
See Custom catalogues and validation.
Renderers
SkiaDisplayListRenderer,HeadlessVectorRendererandHeadlessCompositeRenderer(EncDotNet.S100.Renderers.Skia): headless rendering to images.VectorSceneandVectorSceneBuilder(EncDotNet.S100.Rendering.Scene): the backend-neutral scene that every renderer draws.AddS100andAddS100Mapsui(EncDotNet.S100.Renderers.Mapsui), andS100MapControl(EncDotNet.S100.Renderers.Mapsui.Avalonia): interactive maps.
See Render images and map tiles and Add S-100 data to a Mapsui app.
Backends
PureHdfFile(EncDotNet.S100.Hdf5.PureHdf): managed HDF5 reader.LuaCSharpLuaEngine(EncDotNet.S100.Scripting.LuaCSharp): the default Lua engine for S-100 Part 9A portrayal rules.MoonSharpLuaEngine(EncDotNet.S100.Scripting.MoonSharp): the previous Lua engine, selectable withLuaEngineKind.MoonSharp.LuaEngineFactory(EncDotNet.S100): creates either engine for aLuaEngineKind.ProjNetCrsTransformFactory(EncDotNet.S100.Crs.ProjNet): coordinate reference system transforms for projected grids.
Versions and supported surface
The supported surface of each package is the set of types its README
documents. internal and undocumented types can change at any time.
All EncDotNet.S100.* packages share one version, taken from the release tag.
Versions follow Semantic Versioning. Below 1.0.0, the
API is still settling: a minor version can include breaking changes, and the
release notes list them. From 1.0.0, breaking changes to a documented surface
come only in a major version.