IShapeReaderModifier

Description

interface Tinman.Terrain.Shapes.IShapeReaderModifier

Derived from

IConfigurable
IEquatable<IShapeReaderModifier>

Extended by

ShapeReaderModifierBase abstract

Base interface for filters that may be specified when reading shapes.

A filter may modify the original geo-reference or metadata that is present in the shape data, before it is used to build a IShape object. Additionally, filters may remove custom shape values.

To construct a shape data modifier, start with ShapeReaderModifier.Original and then call one or more of the following operator methods subsequently:

See also

IShapeReader.ReadShape

Public / Methods

And

public method And → (1)

other in : IShapeReaderModifier

[not-null]
The other shape data modifier.

returns → IShapeReaderModifier

The resulting shape data modifier.

Returns an aggregated shape data modifier that will invoke both this modifier and the given other in modifier.

By default, this modifier is invoked first. Then, the other in modifier is invoked. However, implementations may define a different invocation order.

Identifier

public method Identifier → (1)

name opt : string = null

The JSON member name. If null, 'id' will be used.

returns → IShapeReaderModifier

The resulting shape data modifier.

Specifies a final shape data modification that will add a top-level JSON member of the given name opt which holds the unique ordinal number identifier of the shape in the shape data.

Calling this method multiple times will override the effect of previous calls.

See also

IShapeReaderModifier.And

Modify​Georef

public method ModifyGeoref → (2)

ordinal in : int32

[>=0]
The unique ordinal number identifier of the shape in the shape data.

georef in : CoordinateSystem

[not-null]
The original shape geo-reference, as it has been read from the shape data.

returns → CoordinateSystem

The modified CoordinateSystem object to use or georef in to use the original geo-reference.

Modifies the given shape geo-reference.

Modify​Metadata

public method ModifyMetadata → (2)

ordinal in : int32

[>=0]
The unique ordinal number identifier of the shape in the shape data.

metadata in : IJsonValue

[not-null]
The original shape metadata, as it has been read from the shape data.

returns → IJsonValue

The modified IJsonValue object to use or metadata in to use the original metadata.

Modifies the given shape metadata.

Modify​Values

public method ModifyValues → (2)

ordinal in : int32

[>=0]
The unique ordinal number identifier of the shape in the shape data.

values in : ShapeValue

The set of custom shape values that are present in the shape data.

returns → ShapeValue

The set of custom shape values that shall be read from the shape data.

Modifies the set of custom shape values.

Set

3 overloads

public method Set1 → (1)

georef in : CoordinateSystem

[not-null]
The geo-reference to set.

returns → IShapeReaderModifier

The resulting shape data modifier.

Specifies an initial shape data modification that sets the geo-reference.

Calling this method multiple times will override the effect of previous calls.

See also

IShapeReaderModifier.And

public method Set2 → (1)

metadata in : IJsonValue

[not-null]
The metadata to set.

returns → IShapeReaderModifier

The resulting shape data modifier.

Specifies an initial shape data modification that sets the metadata.

Calling this method multiple times will override the effect of previous calls.

See also

IShapeReaderModifier.And

public method Set3 → (1)

values in : ShapeValue

The custom shape value to set.

returns → IShapeReaderModifier

The resulting shape data modifier.

Specifies an initial shape data modification that sets the custom shape values.

Calling this method multiple times will override the effect of previous calls.

See also

IShapeReaderModifier.And