Class PortrayalPipeline

Namespace

EncDotNet.S100.Pipelines

Assembly

EncDotNet.S100.Core.dll

Façade that drives the appropriate inner portrayal pipeline (VectorPipeline for feature-based products, CoveragePipeline for gridded coverage products) and returns the result as the unified IPortrayalLayer type.

public sealed class PortrayalPipeline

Inheritance

object

PortrayalPipeline

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Use the strongly-typed ProcessAsync overloads when you know which kind of source you have. Callers that need to dispatch on the produced layer type can pattern-match the returned IPortrayalLayer against IVectorLayer or StyledCoverageLayer.

Constructors

PortrayalPipeline(IVectorRuleExecutor?)

Creates the façade and its inner vector and coverage pipelines.

public PortrayalPipeline(IVectorRuleExecutor? luaExecutor = null)

Parameters

luaExecutor IVectorRuleExecutor

Optional Lua rule executor passed to the inner VectorPipeline; when null vector portrayal runs XSLT rules only.

Methods

ProcessAsync(ICoverageSource, ICoverageStyle, Viewport?, ICrsTransform?, MarinerSettings?, CancellationToken)

Drives the coverage portrayal pipeline and returns the result as an IPortrayalLayer. The runtime type is StyledCoverageLayer.

public Task<IPortrayalLayer> ProcessAsync(ICoverageSource source, ICoverageStyle style, Viewport? viewport = null, ICrsTransform? wgs84ToNative = null, MarinerSettings? mariner = null, CancellationToken cancellationToken = default)

Parameters

source ICoverageSource

The coverage source.

style ICoverageStyle

The coverage style.

viewport Viewport

Optional map viewport for viewport-scoped sampling (issue #487). When null the full grid is sampled.

wgs84ToNative ICrsTransform

Optional CRS transform from WGS-84 to the grid's native CRS. Required when viewport is supplied and the grid CRS is not EPSG:4326.

mariner MarinerSettings

Optional mariner settings.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IPortrayalLayer>

ProcessAsync(IFeatureXmlSource, IVectorPortrayalCatalogue, Viewport?, MarinerSettings?, CancellationToken)

Drives the vector portrayal pipeline and returns the result as an IPortrayalLayer. The runtime type is IVectorLayer.

public Task<IPortrayalLayer> ProcessAsync(IFeatureXmlSource source, IVectorPortrayalCatalogue catalogue, Viewport? viewport = null, MarinerSettings? mariner = null, CancellationToken cancellationToken = default)

Parameters

source IFeatureXmlSource

catalogue IVectorPortrayalCatalogue

viewport Viewport

mariner MarinerSettings

cancellationToken CancellationToken

Returns

Task<IPortrayalLayer>