Interface IH5Object

Namespace

PureHDF

Assembly

PureHDF.dll

A base class HDF5 objects.

public interface IH5Object

Properties

Name

Gets the name.

string Name { get; }

Property Value

string

Methods

Attribute(string)

Checks if the attribute with the specified name exist.

IH5Attribute Attribute(string name)

Parameters

name string

The name of the attribute.

Returns

IH5Attribute

A boolean which indicates if the attribute exists.

AttributeAsync(string, CancellationToken)

Checks if the attribute with the specified name exist.

Task<IH5Attribute> AttributeAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

The name of the attribute.

cancellationToken CancellationToken

A token to cancel the current operation.

Returns

Task<IH5Attribute>

A boolean which indicates if the attribute exists.

AttributeExists(string)

Gets the attribute named name.

bool AttributeExists(string name)

Parameters

name string

The name of the attribute.

Returns

bool

The requested attribute.

AttributeExistsAsync(string, CancellationToken)

Gets the attribute named name.

Task<bool> AttributeExistsAsync(string name, CancellationToken cancellationToken = default)

Parameters

name string

The name of the attribute.

cancellationToken CancellationToken

A token to cancel the current operation.

Returns

Task<bool>

The requested attribute.

Attributes()

Gets an enumerable of the available attributes.

IEnumerable<IH5Attribute> Attributes()

Returns

IEnumerable<IH5Attribute>

AttributesAsync(CancellationToken)

Gets an enumerable of the available attributes.

A token to cancel the current operation.

Task<IEnumerable<IH5Attribute>> AttributesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IEnumerable<IH5Attribute>>