interface IDataset in Tinman.Terrain.Datasets

interface	IDataset	extends	IMapEntity
			IPathInfo
		base of	IHeightmapDataset

Attributes

CanUpdate

Does this map allow updates to its content (i.e. sample data and/or metadata)?

property	CanUpdate { get }
type	bool
value		true if the map content can be updated, false if not.
inherited	IMapEntity.CanUpdate

DataId

Returns a unique identifier for this dataset.

property	DataId { get }
type	DatasetId
value		The unique dataset identifier.

Georef

Returns georeferencing information.

property	Georef { get }
type	Raster
value		The georeferencing object or null if no georeferencing is available.
inherited	IGeorefInfo.Georef

Info

Returns dataset metadata information.

property	Info { get }
type	IDatasetInfo
value	[not-null]	The metadata information object.

LifecycleState

Returns the lifecycle state of this object.

property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	ILifecycleState.LifecycleState

Map

Returns a MapInfo value that describes the used map raster.

property	Map { get }
type	MapInfo
value		The map info value.
inherited	IMapInfo.Map

PathInfo

Returns a Path object that represents the file path this object is associated with.

property	PathInfo { get }
type	Path
value	[not-null]	The path info.
inherited	IPathInfo.PathInfo

Remarks:

Objects that do not have a meaningful file path association simply return Unknown.

Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	IDisposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
method	Dispose ()
inherited	IDisposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

Flush

Flushes all cached data.

method	Flush ()
inherited	IFlushable.Flush

Remarks:

Performing a flush may result in I/O work. Depending on the semantics of the implementing class, this work may need to be wrapped in special Begin / End method calls. See the documentation of the implementing classes for details.

In case this object represents a read-only resource, calling the Flush method has no effect.

ToConfig

Returns the configuration value that describes this object.

method	ToConfig ()
type	ConfigValue
returns		[not-null]	The configuration value.
inherited	IConfigurable.ToConfig

Remarks:

All configurable objects need to implement this interface. For simple types, it is preferable to delegate to ToValue.

The returned value may be of type Invalid, which means that this object in its current state cannot be described with the configuration API.

Before returning the resulting configuration value, Cache must be called on it, passing this IConfigurable object as parameter.

UpdateGeoref

Updates georeferencing data of this heightmap.

[ThreadSafe]
method	UpdateGeoref (Raster georef)
params	georef		The new georeferencing data or null.
inherited	IMapEntity.UpdateGeoref

See also:

IMapEntity.CanUpdate

UpdateInfo

Updates metadata information of this heightmap.

[ThreadSafe]
method	UpdateInfo (IDatasetInfo info)
params	info	[not-null]	The new metadata information.

See also:

IMapEntity.CanUpdate

UseCache

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

method	UseCache (DatasetFileCache cache)
params	cache		The dataset file cache or null to disable file caching.

Remarks:

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