IGeoPathReader

Description

interface Tinman.Engine.Scenes.Data.IGeoPathReader → <TSample val>

Derived from

IGeoPathReaderBase

Extended by

GeoPathReader abstract
ITableGeoPathReader

Base interface for classes that read geo path samples.

Public / Methods

Read​All​Array

[OwnerThis]
public method ReadAllArray → ()

returns → TSample [ ]

The read path samples.

Reads all remaining path samples.

IOException

If an I/O error has occurred.

Read​All​Collect

[OwnerThis]
public method ReadAllCollect → (1)

collector in : ICollector<TSample>

[not-null]
The collector of read path samples.

Reads all remaining path samples and feeds them into the given collector.

IOException

If an I/O error has occurred.

Read​All​List

[OwnerThis]
public method ReadAllList → (1)

list opt : IVector<TSample> = null

The list to use as output or null to create a new one.

returns → IVectorConst<TSample>

The read path samples.

Reads all remaining path samples into a list.

IOException

If an I/O error has occurred.

Read​All​Path

[OwnerThis]
public method ReadAllPath → (1)

datum opt : GeodeticDatum = null

The geodetic datum to use (see IGeoPathBase.Datum). If null, GeodeticDatum.WGS84 will be used.

returns → IGeoPath<TSample>

The resulting geo path.

Reads all remaining path samples.

IOException

If an I/O error has occurred.

Read​Sample

public method ReadSample → (1)

sample out : TSample

The read geo path sample.

returns → bool

true if sample out has been written to,
false if there are no more geo path samples.

Reads the next geo path sample.

IOException

If an I/O error has occurred.

Vertical

[OwnerReturn] [OwnerThis]
public method Vertical → (2)

geocentric in : Geocentric

[not-null]
The geocentric transformation to use.

type in : VerticalType

The vertical type of the height values that are read by this reader.

returns → IGeoPathReader<TSample>

The resulting reader.

Converts the height values that have been read by this reader from the given vertical type in to the vertical type of the geo path sample type (see IGeoPathSampleTrait.Vertical).