Class IH5GroupExtensions

Namespace

PureHDF

Assembly

PureHDF.dll

Defines extensions methods for the IH5Group type.

public static class IH5GroupExtensions

Inheritance

object

IH5GroupExtensions

Methods

CommitedDatatype(IH5Group, string)

Gets the commited data type that is at the given path.

public static IH5CommitedDatatype CommitedDatatype(this IH5Group group, string path)

Parameters

group IH5Group

The group to operate on.

path string

The path of the object.

Returns

IH5CommitedDatatype

The requested commited data type.

CommitedDatatypeAsync(IH5Group, string, CancellationToken)

Gets the commited data type that is at the given path.

public static Task<IH5CommitedDatatype> CommitedDatatypeAsync(this IH5Group group, string path, CancellationToken cancellationToken = default)

Parameters

group IH5Group

The group to operate on.

path string

The path of the object.

cancellationToken CancellationToken

A token to cancel the current operation.

Returns

Task<IH5CommitedDatatype>

The requested commited data type.

Dataset(IH5Group, string)

Gets the dataset that is at the given path.

public static IH5Dataset Dataset(this IH5Group group, string path)

Parameters

group IH5Group

The group to operate on.

path string

The path of the object.

Returns

IH5Dataset

The requested dataset.

DatasetAsync(IH5Group, string, CancellationToken)

Gets the dataset that is at the given path.

public static Task<IH5Dataset> DatasetAsync(this IH5Group group, string path, CancellationToken cancellationToken = default)

Parameters

group IH5Group

The group to operate on.

path string

The path of the object.

cancellationToken CancellationToken

A token to cancel the current operation.

Returns

Task<IH5Dataset>

The requested dataset.

GetAsync<T>(IH5Group, string, CancellationToken)

Gets the object that is at the given path.

public static Task<T> GetAsync<T>(this IH5Group group, string path, CancellationToken cancellationToken = default) where T : IH5Object

Parameters

group IH5Group

The group to operate on.

path string

The path of the object.

cancellationToken CancellationToken

A token to cancel the current operation.

Returns

Task<T>

The requested object.

Type Parameters

T

The return type of the object.

Get<T>(IH5Group, string)

Gets the object that is at the given path.

public static T Get<T>(this IH5Group group, string path) where T : IH5Object

Parameters

group IH5Group

The group to operate on.

path string

The path of the object.

Returns

T

The requested object.

Type Parameters

T

The return type of the object.

Group(IH5Group, string)

Gets the group that is at the given path.

public static IH5Group Group(this IH5Group group, string path)

Parameters

group IH5Group

The group to operate on.

path string

The path of the object.

Returns

IH5Group

The requested group.

GroupAsync(IH5Group, string, CancellationToken)

Gets the group that is at the given path.

public static Task<IH5Group> GroupAsync(this IH5Group group, string path, CancellationToken cancellationToken = default)

Parameters

group IH5Group

The group to operate on.

path string

The path of the object.

cancellationToken CancellationToken

A token to cancel the current operation.

Returns

Task<IH5Group>

The requested group.