Class S125AtonLuaDataProvider

Namespace

EncDotNet.S100.Datasets.S125

Assembly

EncDotNet.S100.Datasets.S125.dll

Implements the S-100 Part 9A Lua host API over S-125 aids to navigation projected onto the S-101 model (S125AtonPortrayalProjection), so the bundled S-101 Portrayal Catalogue's AtoN rules can portray them.

public sealed class S125AtonLuaDataProvider : ILuaDataProvider

Inheritance

object

S125AtonLuaDataProvider

Implements

ILuaDataProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Feature ids: GML gml:id strings are mapped to sequential numeric ids for the Lua side and mapped back in HostPortrayalEmit, so emitted instructions reference the S-125 feature's gml:id.

Spatial records: GML features embed their geometry, whereas the S-101 rules inspect shared spatial records — a light's flare direction and the vertical offset of its description both depend on the other features associated with the same point (S-101 LightFlareAndDescription, GetColocatedTextCount). Point features at the same position are therefore given one shared synthetic point record, reproducing S-101's structure / equipment co-location. Curves and surfaces get per-feature synthetic curve, composite-curve and surface records.

Attribute and type information comes from the S-101 Feature Catalogue, since the rules being run are S-101 rules.

Constructors

S125AtonLuaDataProvider(S125Dataset, FeatureCatalogue, Action<string>?)

Initialises the provider over the portrayable features of an S-125 dataset.

public S125AtonLuaDataProvider(S125Dataset dataset, FeatureCatalogue s101FeatureCatalogue, Action<string>? trace = null)

Parameters

dataset S125Dataset

The S-125 dataset.

s101FeatureCatalogue FeatureCatalogue

The S-101 feature catalogue the rules are written against.

trace Action<string>

Optional sink for Lua Debug.Trace output; defaults to Trace.

S125AtonLuaDataProvider(IReadOnlyList<S125ProjectedAton>, FeatureCatalogue, Action<string>?)

Initialises the provider over already-projected aids.

public S125AtonLuaDataProvider(IReadOnlyList<S125ProjectedAton> aids, FeatureCatalogue s101FeatureCatalogue, Action<string>? trace = null)

Parameters

aids IReadOnlyList<S125ProjectedAton>

The projected aids (see Project(S125Dataset, FeatureCatalogue)).

s101FeatureCatalogue FeatureCatalogue

The S-101 feature catalogue the rules are written against.

trace Action<string>

Optional sink for Lua Debug.Trace output.

Properties

EmittedInstructions

Drawing instructions emitted during portrayal execution.

public IReadOnlyList<EmittedInstruction> EmittedInstructions { get; }

Property Value

IReadOnlyList<EmittedInstruction>

FeatureCount

The number of S-125 features handed to the S-101 rules.

public int FeatureCount { get; }

Property Value

int

PostLoadScripts

Product-specific Lua scripts that must run after main.lua loads and before context-parameter initialisation and PortrayalMain. These are the host-adapter shims (e.g. HostGetSpatial / HostFeatureGetSpatialAssociations wrappers) and compatibility patches. The list is executed in order.

public IReadOnlyList<string> PostLoadScripts { get; }

Property Value

IReadOnlyList<string>

Remarks

Owned by the provider because the shims bridge this provider's host functions into Lua objects; S-131's spatial shim differs from S-101's because its geometry is synthesised from GML.

Methods

GetFeatureTypeCode(string)

Resolves a Lua-side feature reference (the stringified record id passed to HostPortrayalEmit) to its feature-type code (e.g. DEPCNT), or null when it cannot be resolved. Used for per-feature-type telemetry.

public string? GetFeatureTypeCode(string featureRef)

Parameters

featureRef string

Returns

string

Remarks

Accepts either the gml:id carried by emitted instructions or the numeric id used inside the Lua engine; returns the S-101 feature type the feature is portrayed as.

RegisterHostFunctions(ILuaContext)

Registers all Host* functions (and any debug table) on the given Lua context.

public void RegisterHostFunctions(ILuaContext lua)

Parameters

lua ILuaContext