GeoPathReaderComponent

Description

sealed class Tinman.Engine.Scenes.Data.GeoPathReaderComponent

Represents a registered geo path component in a IGeoPathReader.

See also: IGeoPathReader.Component

Public / Methods

Column

_2 overloads

public method Column¹ → (1)

index ⁱⁿ : int32: The data source column index, see IGeoPathReader.Columns.
returns → GeoPathReaderComponent: this

Specifies the data source column mapping.

See also: GeoPathReaderComponent.ColumnIndex
GeoPathReaderComponent.ColumnName

public method Column² → (1)

name ⁱⁿ : string: The data source column name, see IGeoPathReader.ColumnName.
returns → GeoPathReaderComponent: this

Specifies the data source column mapping.

See also: GeoPathReaderComponent.ColumnIndex
GeoPathReaderComponent.ColumnName

Value

public method Value → (3)

value ^opt : float64 = 0: The default value to use, if unmapped.
scale ^opt : float64 = 1: The scale factor to use.
offset ^opt : float64 = 0: The value offset to use.
returns → GeoPathReaderComponent: this

Specifies the geo path component default value and linear transformation.

The linear transformation is defined as follows:

output = input * scale + offset

where input is the value that has been read from the mapped data source column and output is the value that will be present in the geo path component returned by IGeoPathReader.ReadComponents or in the geo path sample returned by IGeoPathReaderGeneric.ReadSample.

See also: GeoPathReaderComponent.ValueDefault
GeoPathReaderComponent.ValueScale
GeoPathReaderComponent.ValueOffset

Public / Attributes

ColumnIndex

public attribute ColumnIndex → (get)

value : int32: The mapped column index or -1 if unmapped.

Returns the mapped data source column index.

Defaults to -1.

See also: GeoPathReaderComponent.Column¹
GeoPathReaderComponent.Column²

ColumnName

public attribute ColumnName → (get)

value : string: The mapped column name or null if unmapped.

Returns the mapped data source column name.

Defaults to null.

See also: GeoPathReaderComponent.Column¹
GeoPathReaderComponent.Column²

Identifier

public attribute Identifier → (get)

value : GeoPathComponentId: The identifier.

Returns the geo path component identifier.

ValueDefault

public attribute ValueDefault → (get)

value : float64: The default value.

Returns the default value to use if unmapped.

Defaults 0.

See also: GeoPathReaderComponent.Value

ValueOffset

public attribute ValueOffset → (get)

value : float64: The transformation offset.

Returns the value transformation offset.

Defaults to 0.

See also: GeoPathReaderComponent.Value

ValueScale

public attribute ValueScale → (get)

value : float64: The transformation scale.

Returns the value transformation scale.

Defaults to 1.

See also: GeoPathReaderComponent.Value