Class LuaPortrayalSession

Namespace

EncDotNet.S100.Pipelines.Vector.Lua

Assembly

EncDotNet.S100.Core.dll

A Lua state set up for one dataset and one set of mariner settings that portrays chosen features on demand, by passing their ids to the catalogue's PortrayalMain(featureIDs) (S-100 Part 9a). Opened by OpenSessionAsync(MarinerSettings, CancellationToken).

public sealed class LuaPortrayalSession : IDisposable

Inheritance

object

LuaPortrayalSession

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Not thread-safe: portray from one thread at a time. A feature portrayed twice is portrayed again, so callers keep what they've already portrayed.

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Portray(IReadOnlyCollection<string>)

Portrays features and returns their drawing instructions.

public IReadOnlyList<DrawingInstruction> Portray(IReadOnlyCollection<string> featureIds)

Parameters

featureIds IReadOnlyCollection<string>

The features' ids, as the dataset's drawing instructions reference them (FeatureReference). Numeric ids are passed to Lua as numbers, as the S-101 host gives them.

Returns

IReadOnlyList<DrawingInstruction>

Their drawing instructions, in emission order.