A collection of datasets.
abstract class
|
DatasetCollection
|
with
|
<T>
|
as
|
class, IDataset
|
extends
|
Disposable
|
||||
implements
|
IBeginEnd
|
||||
base of
|
HeightmapCollection
|
Returns the lifecycle state of this object.
public
virtual
property
|
LifecycleState
{
get
}
|
||
type
|
LifecycleState
|
||
value
|
The lifecycle state. | ||
inherited
|
Disposable.LifecycleState
|
Opens an existing dataset in read-only mode, adding it to the collection.
[OwnerReturn, ThreadSafe]
|
||||
public
method
|
Open
(string filePath,
DatasetFileCacheDelegate cache = null)
|
|||
type
|
T
|
|||
params
|
filePath
|
[not-null]
|
Path to the dataset file. | |
cache
|
Optional
dataset
file
cache
delegate
to
use.
Defaults
to
null .
|
|||
returns
|
|
The opened IHeightmap object. |
Opens an existing dataset in read-only mode, adding it to the collection.
[OwnerReturn, ThreadSafe]
|
||||
public
method
|
Open
(Path filePath,
DatasetFileCacheDelegate cache = null)
|
|||
type
|
T
|
|||
params
|
filePath
|
[not-null]
|
Path to the dataset file. | |
cache
|
Optional
dataset
file
cache
delegate
to
use.
Defaults
to
null .
|
|||
returns
|
|
The opened IHeightmap object. |
Opens an existing dataset, adding it to the collection.
[OwnerReturn, ThreadSafe]
|
||||
public
method
|
Open
([Owner]
IFile file,
DatasetFileCacheDelegate cache = null)
|
|||
type
|
T
|
|||
params
|
file
|
[not-null]
|
The dataset file. | |
cache
|
Optional
dataset
file
cache
delegate
to
use.
Defaults
to
null .
|
|||
returns
|
|
The opened IHeightmap object. |
Opens an existing dataset, adding it to the collection.
[OwnerReturn, ThreadSafe]
|
||||
public
method
|
Open
(string filePath,
bool readOnly,
DatasetFileCacheDelegate cache = null)
|
|||
type
|
T
|
|||
params
|
filePath
|
[not-null]
|
Path to the dataset file. | |
readOnly
|
Open dataset in read-only mode? | |||
cache
|
Optional
dataset
file
cache
delegate
to
use.
Defaults
to
null .
|
|||
returns
|
|
The opened IHeightmap object. |
Opens an existing dataset, adding it to the collection.
[OwnerReturn, ThreadSafe]
|
||||
public
method
|
Open
(Path filePath,
bool readOnly,
DatasetFileCacheDelegate cache = null)
|
|||
type
|
T
|
|||
params
|
filePath
|
[not-null]
|
Path to the dataset file. | |
readOnly
|
Open dataset in read-only mode? | |||
cache
|
Optional
dataset
file
cache
delegate
to
use.
Defaults
to
null .
|
|||
returns
|
|
The opened IHeightmap object. |
Acquires a strong reference to this disposable object.
[OwnerReturn, ThreadSafe]
|
||||
public
method
|
AcquireTry
()
|
|||
type
|
IDisposable
|
|||
returns
|
this
if
a
new
strong
reference
has
been
acquired,
null
if
this
object
is
already
being
disposed.
|
|||
inherited
|
Disposable.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.
Adds a dataset to this collection.
[BeginEnd, ThreadSafe]
|
||||
public
method
|
Add
(T dataset)
|
|||
params
|
dataset
|
[not-null]
|
The dataset to add. |
Begins an access to this object.
public
method
|
Begin
()
|
||
implements
|
IBeginEnd.Begin
|
Remarks:
See the documentation of the class which implements this interface for details on the operations that must be wrapped in Begin and End calls.
See also:
BeginEndReleases 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]
|
||||
public
method
|
Dispose
()
|
|||
inherited
|
Disposable.Dispose
|
Remarks:
The Dispose method silently returns if the object has already been disposed.
Ends the current access to this object.
public
method
|
End
()
|
||
implements
|
IBeginEnd.End
|
Remarks:
See the documentation of the class which implements this interface for details on the operations that must be wrapped in Begin and End calls.
See also:
BeginEndTries to find an opened dataset by its GUID.
[OwnerReturn]
|
||||
public
method
|
Lookup
(GUID guid)
|
|||
type
|
T
|
|||
params
|
guid
|
The GUID to look for. | ||
returns
|
The
corresponding
dataset
or
null
if
not
found. |
Removes a dataset from this collection.
[BeginEnd, ThreadSafe]
|
||||
public
method
|
Remove
(T dataset)
|
|||
params
|
dataset
|
[not-null]
|
The dataset to remove. |
protected
constructor
|
DatasetCollection
()
|
Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.
protected
override
method
|
DisposeManaged
()
|
||
overrides
|
Disposable.DisposeManaged
|
Remarks:
This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.
Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.
The DisposeManaged method is called before the DisposeUnmanaged method.
Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.
protected
virtual
method
|
DisposeUnmanaged
()
|
||
inherited
|
Disposable.DisposeUnmanaged
|
Remarks:
Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.
The DisposeUnmanaged method is called after the DisposeManaged method.
Opens an existing dataset.
[OwnerReturn]
|
||||
protected
abstract
method
|
DoOpen
([Owner]
IFile file)
|
|||
type
|
T
|
|||
params
|
file
|
The dataset file. | ||
returns
|
|
The opened IHeightmap object. |