Class NativeDataset

Namespace

PureHDF.VOL.Native

Assembly

PureHDF.dll

A native HDF5 dataset.

public class NativeDataset : NativeObject, IH5Dataset, IH5Object

Inheritance

object

NativeObject

NativeDataset

Implements

IH5Dataset

IH5Object

Inherited Members

NativeObject.Attributes()

NativeObject.AttributesAsync(CancellationToken)

NativeObject.Attribute(string)

NativeObject.AttributeAsync(string, CancellationToken)

NativeObject.AttributeExists(string)

NativeObject.AttributeExistsAsync(string, CancellationToken)

NativeObject.Name

Properties

FillValue

Gets the fill value.

public IH5FillValue FillValue { get; }

Property Value

IH5FillValue

Layout

Gets the data layout.

public IH5DataLayout Layout { get; }

Property Value

IH5DataLayout

Space

Gets the data space.

public IH5Dataspace Space { get; }

Property Value

IH5Dataspace

Type

Gets the data type.

public IH5DataType Type { get; }

Property Value

IH5DataType

Methods

ReadAsync<T>(Selection?, Selection?, ulong[]?, CancellationToken)

Reads the data asynchronously.

public Task<T> ReadAsync<T>(Selection? fileSelection = null, Selection? memorySelection = null, ulong[]? memoryDims = null, CancellationToken cancellationToken = default)

Parameters

fileSelection Selection

The selection within the source HDF5 dataset.

memorySelection Selection

The selection within the target memory.

memoryDims ulong[]

The dimensions of the target memory buffer.

cancellationToken CancellationToken

A token to cancel the current operation.

Returns

Task<T>

A task which returns the read data as array of T.

Type Parameters

T

The type of the data to read.

ReadAsync<T>(T, Selection?, Selection?, ulong[]?, CancellationToken)

Reads the data asynchronously into the provided buffer.

public Task ReadAsync<T>(T buffer, Selection? fileSelection = null, Selection? memorySelection = null, ulong[]? memoryDims = null, CancellationToken cancellationToken = default)

Parameters

buffer T

The buffer to read the data into.

fileSelection Selection

The selection within the source HDF5 dataset.

memorySelection Selection

The selection within the target memory.

memoryDims ulong[]

The dimensions of the target memory buffer.

cancellationToken CancellationToken

A token to cancel the current operation.

Returns

Task

Type Parameters

T

The type of the data to read.

Read<T>(Selection?, Selection?, ulong[]?)

Reads the data.

public T Read<T>(Selection? fileSelection = null, Selection? memorySelection = null, ulong[]? memoryDims = null)

Parameters

fileSelection Selection

The selection within the source HDF5 dataset.

memorySelection Selection

The selection within the destination memory.

memoryDims ulong[]

The dimensions of the destination memory buffer.

Returns

T

The read data as array of T.

Type Parameters

T

The type of the data to read.

Read<T>(H5DatasetAccess, Selection?, Selection?, ulong[]?)

Reads the data.

public T Read<T>(H5DatasetAccess datasetAccess, Selection? fileSelection = null, Selection? memorySelection = null, ulong[]? memoryDims = null)

Parameters

datasetAccess H5DatasetAccess

The dataset access properties.

fileSelection Selection

The selection within the source HDF5 dataset.

memorySelection Selection

The selection within the destination memory.

memoryDims ulong[]

The dimensions of the destination memory buffer.

Returns

T

The read data as array of T.

Type Parameters

T

The type of the data to read.

Read<T>(H5DatasetAccess, Span<T>, Selection?, Selection?, ulong[]?)

Reads the data into the provided buffer.

public void Read<T>(H5DatasetAccess datasetAccess, Span<T> buffer, Selection? fileSelection = null, Selection? memorySelection = null, ulong[]? memoryDims = null)

Parameters

datasetAccess H5DatasetAccess

The dataset access properties.

buffer Span<T>

The buffer to read the data into.

fileSelection Selection

The selection within the source HDF5 dataset.

memorySelection Selection

The selection within the destination memory.

memoryDims ulong[]

The dimensions of the destination memory buffer.

Type Parameters

T

The type of the data to read.

Read<T>(H5DatasetAccess, T, Selection?, Selection?, ulong[]?)

Reads the data into the provided buffer.

public void Read<T>(H5DatasetAccess datasetAccess, T buffer, Selection? fileSelection = null, Selection? memorySelection = null, ulong[]? memoryDims = null)

Parameters

datasetAccess H5DatasetAccess

The dataset access properties.

buffer T

The buffer to read the data into.

fileSelection Selection

The selection within the source HDF5 dataset.

memorySelection Selection

The selection within the destination memory.

memoryDims ulong[]

The dimensions of the destination memory buffer.

Type Parameters

T

The type of the data to read.

Read<T>(Span<T>, Selection?, Selection?, ulong[]?)

Reads the data into the provided buffer.

public void Read<T>(Span<T> buffer, Selection? fileSelection = null, Selection? memorySelection = null, ulong[]? memoryDims = null)

Parameters

buffer Span<T>

The buffer to read the data into.

fileSelection Selection

The selection within the source HDF5 dataset.

memorySelection Selection

The selection within the destination memory.

memoryDims ulong[]

The dimensions of the destination memory buffer.

Type Parameters

T

The type of the data to read.

Read<T>(T, Selection?, Selection?, ulong[]?)

Reads the data into the provided buffer.

public void Read<T>(T buffer, Selection? fileSelection = null, Selection? memorySelection = null, ulong[]? memoryDims = null)

Parameters

buffer T

The buffer to read the data into.

fileSelection Selection

The selection within the source HDF5 dataset.

memorySelection Selection

The selection within the destination memory.

memoryDims ulong[]

The dimensions of the destination memory buffer.

Type Parameters

T

The type of the data to read.