Interface IH5Group

Namespace

PureHDF

Assembly

PureHDF.dll

An HDF5 group.

public interface IH5Group : IH5Object

Inherited Members

IH5Object.Attributes()

IH5Object.AttributesAsync(CancellationToken)

IH5Object.Attribute(string)

IH5Object.AttributeAsync(string, CancellationToken)

IH5Object.AttributeExists(string)

IH5Object.AttributeExistsAsync(string, CancellationToken)

IH5Object.Name

Extension Methods

IH5GroupExtensions.CommitedDatatype(IH5Group, string)

IH5GroupExtensions.CommitedDatatypeAsync(IH5Group, string, CancellationToken)

IH5GroupExtensions.Dataset(IH5Group, string)

IH5GroupExtensions.DatasetAsync(IH5Group, string, CancellationToken)

IH5GroupExtensions.GetAsync<T>(IH5Group, string, CancellationToken)

IH5GroupExtensions.Get<T>(IH5Group, string)

IH5GroupExtensions.Group(IH5Group, string)

IH5GroupExtensions.GroupAsync(IH5Group, string, CancellationToken)

Methods

Children()

Gets an enumerable of the available children.

IEnumerable<IH5Object> Children()

Returns

IEnumerable<IH5Object>

An enumerable of the available children.

ChildrenAsync(CancellationToken)

Gets an enumerable of the available children.

Task<IEnumerable<IH5Object>> ChildrenAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to cancel the current operation.

Returns

Task<IEnumerable<IH5Object>>

An enumerable of the available children.

Get(string)

Gets the object that is at the given path.

IH5Object Get(string path)

Parameters

path string

The path of the object.

Returns

IH5Object

The requested object.

GetAsync(string, CancellationToken)

Gets the object that is at the given path.

Task<IH5Object> GetAsync(string path, CancellationToken cancellationToken = default)

Parameters

path string

The path of the object.

cancellationToken CancellationToken

A token to cancel the current operation.

Returns

Task<IH5Object>

The requested object.

LinkExists(string)

Checks if the link with the specified path exist.

bool LinkExists(string path)

Parameters

path string

The path of the link.

Returns

bool

A boolean which indicates if the link exists.

LinkExistsAsync(string, CancellationToken)

Checks if the link with the specified path exist.

Task<bool> LinkExistsAsync(string path, CancellationToken cancellationToken = default)

Parameters

path string

The path of the link.

cancellationToken CancellationToken

A token to cancel the current operation.

Returns

Task<bool>

A boolean which indicates if the link exists.