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 Open¹ → (2)

filePath ⁱⁿ : 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 ⁱⁿ.

[OwnerReturn] [ThreadSafe]
public method Open² → (3)

filePath ⁱⁿ : string: [not-null]
Path to the dataset file.
readOnly ⁱⁿ : 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 ⁱⁿ.

[OwnerReturn] [ThreadSafe]
public method Open³ → (2)

filePath ⁱⁿ : 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 ⁱⁿ.

[OwnerReturn] [ThreadSafe]
public method Open⁴ → (3)

filePath ⁱⁿ : Path: [not-null]
Path to the dataset file.
readOnly ⁱⁿ : 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 ⁱⁿ.

[OwnerReturn] [ThreadSafe]
public method Open⁵ → (2)

file ⁱⁿ : IFile ^own: [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 ⁱⁿ.

Public / Methods

Add

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

dataset ⁱⁿ : T: [not-null]
The dataset to add.

Adds a dataset to this collection.

Lookup

_2 overloads

[BeginEnd] [OwnerReturn] [ThreadSafe]
public method Lookup¹ → (1)

path ⁱⁿ : 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 Lookup² → (1)

guid ⁱⁿ : 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 ⁱⁿ : T: [not-null]
The dataset to remove.

Removes a dataset from this collection.

Wait

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

path ⁱⁿ : Path: [not-null]
Path to the dataset.
wait ⁱⁿ : 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