IDataset

Description

interface Tinman.Terrain.Datasets.IDataset

Base interface for map entities (e.g. heightmaps and pyramids) that are based on a dataset.

A dataset may be identified via its DatasetId, which allows caching and incremental processing. Also, metadata may be present in datasets.

Public / Methods

UpdateInfo


[ThreadSafe]
public method UpdateInfo → (1)

info in : IDatasetInfo

[not-null]
The new metadata information.

Updates metadata information of this dataset.

IOException

If an I/O error has occurred.

UseCache


public method UseCache → (1)

cache in : DatasetFileCache

The dataset file cache or null to disable file caching.

Tells this dataset instance to make use of the given dataset file cache.

File-based dataset caching is usually performed when streaming datasets over the internet.

Public / Attributes

DataId


public attribute DataId → (get)

value : DatasetId

The unique dataset identifier.

Returns a unique identifier for this dataset.

Info


public attribute Info → (get)

value : IDatasetInfo

[not-null]
The metadata information object.

Returns dataset metadata information.