nuget server logo nuget api documents
↑

API Docs / Microsoft.VisualBasic.Data.IO.HDF5 / FilterDescription

FilterDescription

Full name Microsoft.VisualBasic.Data.IO.HDF5.struct.messages.FilterDescription Assembly Microsoft.VisualBasic.Data.IO.HDF5 Members 9

01 Syntax

Microsoft.VisualBasic.Data.IO.HDF5.struct.messages.FilterDescription

02 Methods

NameOverloadsSummary
doDecode 1
ToString 1

03 Properties

NameOverloadsSummary
id 1 This value, often referred to as a filter identifier, is designed to be a unique identifier for the filter.
nameLength 1 Each filter has an optional null-terminated ASCII name and this field holds the length of the name including the null termination padded with nulls to be a multiple of eight.
clientData 1 This is an array of four-byte integers which will be passed to the filter function.
flags 1
numberOfClientDataValues 1
name 1
filter 1

04 Members

property id #
id

This value, often referred to as a filter identifier, is designed to be a unique identifier for the filter. Values from zero through 32,767 are reserved for filters supported by The HDF Group in the HDF5 Library and for filters requested and supported by third parties. Filters supported by The HDF Group are documented immediately below. Information on 3rd-party filters can be found at The HDF Group’s Contributions page.

Values from 32768 to 65535 are reserved for non-distributed uses (for example, internal company usage) or for application usage when testing a feature. The HDF Group does not track or document the use of the filters with identifiers from this range.

property nameLength #
nameLength

Each filter has an optional null-terminated ASCII name and this field holds the length of the name including the null termination padded with nulls to be a multiple of eight. If the filter has no name then a value of zero is stored in this field.

property clientData #
clientData

This is an array of four-byte integers which will be passed to the filter function. The Client Data Number of Values determines the number of elements in the array.

property flags #
flags
property numberOfClientDataValues #
numberOfClientDataValues
property name #
name
property filter #
filter
method doDecode #
doDecode(IEnumerable(Of Byte))
method ToString #
ToString()