Class H5Attribute

An HDF5 attribute.

Inheritance

System.Object

H5Attribute

Namespace: HDF5.NET

Assembly: HDF5.NET.dll

Syntax

public class H5Attribute : object

Properties

Name

Gets the attribute name.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

Space

Gets the data space.

Declaration

public H5Dataspace Space { get; }

Property Value

Type	Description
H5Dataspace

Type

Gets the data type.

Declaration

public H5DataType Type { get; }

Property Value

Type	Description
H5DataType

Methods

Read<T>()

Reads the data. The type parameter T must match the langword_csharp_unmanaged constraint.

Declaration

public T[] Read<T>()
    where T : struct

Returns

Type	Description
T[]	The read data as array of T.

Type Parameters

Name	Description
T	The type of the data to read.

ReadCompound()

Reads the compound data. This is the slowest but most flexible option to read compound data as no prior type knowledge is required.

Declaration

public Dictionary<string, object?>[] ReadCompound()

Returns

Type	Description
Dictionary<System.String, System.Nullable<System.Object>>[]	The read data as array of a dictionary with the keys corresponding to the compound member names and the values being the member data.

ReadCompound<T>(Nullable<Func<FieldInfo, String>>)

Reads the compound data. The type parameter T must match the langword_csharp_struct constraint. Nested fields with nullable references are not supported.

Declaration

public T[] ReadCompound<T>(Func<FieldInfo, string>? getName = null)
    where T : struct

Parameters

Type	Name	Description
System.Nullable<Func<FieldInfo, System.String>>	getName	An optional function to map the field names of T to the member names of the HDF5 compound type.

Returns

Type	Description
T[]	The read data as array of T.

Type Parameters

Name	Description
T	The type of the data to read.

ReadString()

Reads the string data.

Declaration

public string[] ReadString()

Returns

Type	Description
System.String[]	The read data as array of .