Class NativeGroup

Namespace

PureHDF.VOL.Native

Assembly

PureHDF.dll

An HDF5 group.

public class NativeGroup : NativeObject, IH5Group, IH5Object

Inheritance

object

NativeObject

NativeGroup

Implements

IH5Group

IH5Object

Derived

NativeFile

Inherited Members

NativeObject.Attributes()

NativeObject.AttributesAsync(CancellationToken)

NativeObject.Attribute(string)

NativeObject.AttributeAsync(string, CancellationToken)

NativeObject.AttributeExists(string)

NativeObject.AttributeExistsAsync(string, CancellationToken)

NativeObject.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)

NativeGroupExtensions.CommitedDatatype(NativeGroup, string, H5LinkAccess)

NativeGroupExtensions.Dataset(NativeGroup, string, H5LinkAccess)

NativeGroupExtensions.Get<T>(NativeGroup, NativeObjectReference1)

NativeGroupExtensions.Get<T>(NativeGroup, NativeObjectReference1, H5LinkAccess)

NativeGroupExtensions.Get<T>(NativeGroup, string, H5LinkAccess)

NativeGroupExtensions.Group(NativeGroup, string, H5LinkAccess)

Methods

Children()

Gets an enumerable of the available children.

public IEnumerable<IH5Object> Children()

Returns

IEnumerable<IH5Object>

An enumerable of the available children.

Children(H5LinkAccess)

Gets an enumerable of the available children using the optionally specified linkAccess.

public IEnumerable<IH5Object> Children(H5LinkAccess linkAccess = default)

Parameters

linkAccess H5LinkAccess

The link access properties.

Returns

IEnumerable<IH5Object>

An enumerable of the available children.

ChildrenAsync(CancellationToken)

Gets an enumerable of the available children.

public 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(NativeObjectReference1)

Gets the object that is at the given reference.

public IH5Object Get(NativeObjectReference1 reference)

Parameters

reference NativeObjectReference1

The reference of the object.

Returns

IH5Object

The requested object.

Get(NativeObjectReference1, H5LinkAccess)

Gets the object that is at the given reference.

public IH5Object Get(NativeObjectReference1 reference, H5LinkAccess linkAccess)

Parameters

reference NativeObjectReference1

The reference of the object.

linkAccess H5LinkAccess

The link access properties.

Returns

IH5Object

The requested object.

Get(string)

Gets the object that is at the given path.

public IH5Object Get(string path)

Parameters

path string

The path of the object.

Returns

IH5Object

The requested object.

Get(string, H5LinkAccess)

Gets the object that is at the given path.

public IH5Object Get(string path, H5LinkAccess linkAccess)

Parameters

path string

The path of the object.

linkAccess H5LinkAccess

The link access properties.

Returns

IH5Object

The requested object.

GetAsync(string, CancellationToken)

Gets the object that is at the given path.

public 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.

public bool LinkExists(string path)

Parameters

path string

The path of the link.

Returns

bool

A boolean which indicates if the link exists.

LinkExists(string, H5LinkAccess)

Checks if the link with the specified path exist.

public bool LinkExists(string path, H5LinkAccess linkAccess)

Parameters

path string

The path of the link.

linkAccess H5LinkAccess

The link access properties.

Returns

bool

A boolean which indicates if the link exists.

LinkExistsAsync(string, CancellationToken)

Checks if the link with the specified path exist.

public 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.