Class H5Filter

Namespace

PureHDF.Filters

Assembly

PureHDF.dll

A filter with associated options.

public record H5Filter : IEquatable<H5Filter>

Inheritance

object

H5Filter

Implements

IEquatable<H5Filter>

Constructors

H5Filter(H5Filter)

protected H5Filter(H5Filter original)

Parameters

original H5Filter

H5Filter(ushort, Dictionary<string, object>?)

A filter with associated options.

public H5Filter(ushort Id, Dictionary<string, object>? Options = null)

Parameters

Id ushort

The filter identifier.

Options Dictionary<string, object>

Optional filter options.

Properties

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

Id

The filter identifier.

public ushort Id { get; init; }

Property Value

ushort

Options

Optional filter options.

public Dictionary<string, object>? Options { get; init; }

Property Value

Dictionary<string, object>

Methods

Deconstruct(out ushort, out Dictionary<string, object>?)

public void Deconstruct(out ushort Id, out Dictionary<string, object>? Options)

Parameters

Id ushort

Options Dictionary<string, object>

Equals(H5Filter?)

public virtual bool Equals(H5Filter? other)

Parameters

other H5Filter

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

Register(IH5Filter)

Registers a new filter.

public static void Register(IH5Filter filter)

Parameters

filter IH5Filter

The filter.

ResetRegistrations()

Restores the default list of filter registrations.

public static void ResetRegistrations()

ToString()

public override string ToString()

Returns

string

<Clone>$()

public virtual H5Filter <Clone>$()

Returns

H5Filter

Operators

operator ==(H5Filter?, H5Filter?)

public static bool operator ==(H5Filter? left, H5Filter? right)

Parameters

left H5Filter

right H5Filter

Returns

bool

implicit operator H5Filter(ushort)

Converts a filter identifier into a H5Filter instance with default filter options.

public static implicit operator H5Filter(ushort filterId)

Parameters

filterId ushort

Returns

H5Filter

operator !=(H5Filter?, H5Filter?)

public static bool operator !=(H5Filter? left, H5Filter? right)

Parameters

left H5Filter

right H5Filter

Returns

bool