DatasetCollection

Description

abstract class Tinman.Terrain.Datasets.DatasetCollection
<T ref : IDataset>

Derived from

Disposable abstract
IBeginEnd

Extended by

HeightmapCollection sealed
PixelPyramidCollection sealed

A collection of datasets.

Public / Constructors

Open

5 overloads


[OwnerReturn] [ThreadSafe]
public method Open1 → (2)

filePath in : string

[not-null]
Path to the dataset file.

cache opt : DatasetFileCacheDelegate = null

Optional dataset file cache delegate to use.

returns → T

The opened dataset object.

Opens an existing dataset in read-only mode, adding it to the collection.

IOException

If an I/O error has occurred while opening filePath in.


[OwnerReturn] [ThreadSafe]
public method Open2 → (3)

filePath in : string

[not-null]
Path to the dataset file.

readOnly in : bool

Open dataset in read-only mode?

cache opt : DatasetFileCacheDelegate = null

Optional dataset file cache delegate to use.

returns → T

The opened dataset object.

Opens an existing dataset, adding it to the collection.

IOException

If an I/O error has occurred while opening filePath in.


[OwnerReturn] [ThreadSafe]
public method Open3 → (2)

filePath in : Path

[not-null]
Path to the dataset file.

cache opt : DatasetFileCacheDelegate = null

Optional dataset file cache delegate to use.

returns → T

The opened dataset object.

Opens an existing dataset in read-only mode, adding it to the collection.

IOException

If an I/O error has occurred while opening filePath in.


[OwnerReturn] [ThreadSafe]
public method Open4 → (3)

filePath in : Path

[not-null]
Path to the dataset file.

readOnly in : bool

Open dataset in read-only mode?

cache opt : DatasetFileCacheDelegate = null

Optional dataset file cache delegate to use.

returns → T

The opened dataset object.

Opens an existing dataset, adding it to the collection.

IOException

If an I/O error has occurred while opening filePath in.


[OwnerReturn] [ThreadSafe]
public method Open5 → (2)

file in : IFile

[not-null]
The dataset file.

cache opt : DatasetFileCacheDelegate = null

Optional dataset file cache delegate to use.

returns → T

The opened dataset object.

Opens an existing dataset, adding it to the collection.

IOException

If an I/O error has occurred while opening file in.

Public / Methods

Add


[BeginEnd] [ThreadSafe]
public method Add → (1)

dataset in : T

[not-null]
The dataset to add.

Adds a dataset to this collection.

Lookup

2 overloads


[BeginEnd] [OwnerReturn] [ThreadSafe]
public method Lookup1 → (1)

path in : Path

[not-null]
The file path.

returns → T

The corresponding dataset or null if not found.

Tries to find an opened dataset by its file path.


[BeginEnd] [OwnerReturn] [ThreadSafe]
public method Lookup2 → (1)

guid in : GUID

The GUID to look for.

returns → T

The corresponding dataset or null if not found.

Tries to find an opened dataset by its GUID.

Remove


[BeginEnd] [ThreadSafe]
public method Remove → (1)

dataset in : T

[not-null]
The dataset to remove.

Removes a dataset from this collection.

Wait


[BeginEnd] [ThreadSafe]
public method Wait → (2)

path in : Path

[not-null]
Path to the dataset.

wait in : int32

[>=0]
Maximum number of milliseconds to wait.

returns → bool

true if the dataset is closed and no longer in use,
false if the dataset is open and still in use.

Waits for the given dataset to close, i.e. until all other threads have disposes their referencing dataset objects.

Protected / Constructors

DatasetCollection


protected constructor DatasetCollection → ()

Creates a new instance of DatasetCollection.

Protected / Methods

DoOpen


[OwnerReturn]
protected abstract method DoOpen → (1)

file in : IFile

The dataset file.

returns → T

The opened dataset object.

Opens an existing dataset.

IOException

If an I/O error has occurred while opening file in.