EncDotNet.S100.Datasets.S131 0.25.1

EncDotNet.S100.Datasets.S131

EncDotNet.S100.Datasets.S131 reads IHO S-131 Marine Harbour Infrastructure datasets: GML files (S-100 Part 10b) that describe berths, dolphins, harbour facilities, terminals and other port infrastructure. It parses a dataset, projects it into a typed model, validates it, and runs the S-131 Lua portrayal catalogue (S-100 Part 9A) over it. Reference it when you need typed access to S-131 data or its validation rules. To open and render any product, including S-131, use the EncDotNet.S100 package, which includes this one.

The S-131 data in this screenshot is derived from the NOAA ENC's harbour features.

Install

dotnet add package EncDotNet.S100.Datasets.S131

Read a dataset

Open the dataset from a path or a stream, then read its features:

using EncDotNet.S100.Datasets.S131;

var dataset = S131Dataset.Open("path/to/dataset.gml");

foreach (var feature in dataset.Features)
    Console.WriteLine($"{feature.FeatureType}: {feature.Id}");

For typed access, project it into the typed model:

using EncDotNet.S100.Datasets.S131.DataModel;

var typed = S131HarbourInfrastructureDataset.From(dataset, out var diagnostics);

foreach (var berth in typed.LayoutFeatures.Where(l => l.Kind == S131LayoutKind.Berth))
    Console.WriteLine($"{berth.Id}: {berth.Geometry.Points.FirstOrDefault()}");

foreach (var authority in typed.Authorities)
    Console.WriteLine($"{authority.Id}: contact {authority.ContactDetails?.Id}");

Main types

Typed data model

The EncDotNet.S100.Datasets.S131.DataModel namespace projects S131Dataset into typed features and information types. It's separate from portrayal: the Lua pipeline reads the S131Dataset features directly.

Feature families

Concrete feature types are grouped into four families, taken from the feature catalogue's supertypes (FC Edition 1.0.0 §B.2 and §B.5). The projection doesn't read the feature catalogue at run time.

Information types

Information types never have geometry.

Geometry

S131Geometry combines the four coordinate collections of S131Feature into one record, with a GeometryType of None, Point, Curve or Surface. Positions are GeoPosition(Latitude, Longitude) values in decimal degrees (S-100 Part 10b §6.2).

References

xlink:href references on child elements, such as <S131:applicability xlink:href="#info1"/>, resolve to S131ResolvedReference { Role, TargetRef, Target } entries in the ResolvedReferences property of features and information types. An unresolved reference has a null Target, and the projection reports both an xlink.unresolved and an s131.reference.dangling diagnostic.

Diagnostics

The projection reports problems as ProjectionDiagnostic entries. From throws only when the dataset has no features and no information types.

The typed enums follow the S-131 Edition 1.0.0 feature catalogue. The bundled feature catalogue is Edition 2.0.0. Types it adds are reported as s131.feature.unknown or s131.information.unknown and still project as S131OtherFeature or S131OtherInformationType.

Validate

S131HarbourInfrastructureRules.Default, in the EncDotNet.S100.Datasets.S131.Validation namespace, is the default rule set for S131HarbourInfrastructureDataset. Each rule ID traces to an S-131 or S-100 clause. The EncDotNet.S100 package's dataset.Validate() runs the same rule set.

using EncDotNet.S100.Datasets.S131;
using EncDotNet.S100.Datasets.S131.DataModel;
using EncDotNet.S100.Datasets.S131.Validation;

var dataset = S131Dataset.Open("path/to/dataset.gml");
var typed = S131HarbourInfrastructureDataset.From(dataset, out _);
var report = S131HarbourInfrastructureRules.Validate(typed);

foreach (var finding in report.Findings)
    Console.WriteLine($"[{finding.Severity}] {finding.RuleId}: {finding.Message}");

The rules check one dataset at a time. Cross-dataset checks, such as comparing Berth depths with a loaded S-102 surface, aren't included. A rule that needs other datasets would reach them through ValidationContext.Services.

Portrayal

S-131 is the only GML product whose portrayal catalogue is written in Lua (S-100 Part 9A); the other GML products' catalogues use XSLT. The pipeline reads GML like the other GML products and runs Lua rules like S-101:

flowchart TD
  A[S-131 GML] --> B[S131Dataset]
  B --> C[S131LuaDataProvider<br/>GML to Lua host API]
  C --> D[S131LuaRuleExecutor<br/>MoonSharp, Lua 5.2]
  D --> E[DrawingInstructionParser<br/>from S-101]
  E --> F[Vector pipeline and renderer]

• The S-131 dataset processor, in EncDotNet.S100.Datasets.Pipelines, doesn't derive from GmlDatasetProcessorBase, which assumes XSLT. It follows the S-101 processor's Lua design instead.
• The Lua host API expects numeric IDs, so GML string IDs (gml:id) are mapped to sequential numbers.
• GML has its geometry inline. The data provider builds spatial records from it in the shape S-101's HostGetSpatialData expects.
• S-131 puts features and information types in one <S131:members> container, with no <member>/<imember> split. The reader tells them apart with the list of information type codes from the feature catalogue.

The S-131 portrayal catalogue declares the TwoShades context parameter where S-101 declares FourShades. S131LuaRuleExecutor binds it as the inverse of FourShades.

Encoding notes

A dataset puts every feature and information type in one container:

<S131:Dataset xmlns:S131="http://www.iho.int/S131/1.0"
              xmlns:S100="http://www.iho.int/s100gml/5.0">
  <S131:members>
    
    <S131:Berth gml:id="f1">...</S131:Berth>
    <S131:ContactDetails gml:id="info1">...</S131:ContactDetails>
  </S131:members>
</S131:Dataset>

• The reader accepts the S-100 GML 5.0 namespace and the older 1.0 profile namespace.
• Coordinates are latitude then longitude for EPSG:4326 (S-100 Part 10b §6.2).

Bundled specification

Dependencies

• EncDotNet.S100.Core: GML types and pipeline interfaces.
• EncDotNet.S100.Datasets.S101: DrawingInstructionParser.
• EncDotNet.S100.Features: the feature catalogue reader.
• EncDotNet.S100.Portrayals: portrayal catalogue types.

See also

• Loading datasets: open files, folders, ZIPs and exchange sets through the EncDotNet.S100 package.
• Reading product data: features, information types and typed models for each product.
• Typed data models: the typed root for each product and the shared diagnostic codes.
• Custom catalogues and validation: run the bundled rules and add your own.