ddn.lib.hdf5.h5t

HDF5 Datatype Binding

This module provides D bindings for HDF5 datatype operations (H5T API).

License

BSD-3-Clause

var H5T_C_S1_g H5T_NATIVE_DOUBLE_g H5T_NATIVE_FLOAT_g H5T_NATIVE_INT_g H5T_NATIVE_LLONG_g H5T_NATIVE_LONG_g H5T_NATIVE_SCHAR_g H5T_NATIVE_SHORT_g H5T_NATIVE_UCHAR_g H5T_NATIVE_UINT_g H5T_NATIVE_ULLONG_g H5T_NATIVE_ULONG_g H5T_NATIVE_USHORT_g

alias H5T_conv_t

enum H5T_bkg_t H5T_class_t H5T_cmd_t H5T_cset_t H5T_direction_t H5T_norm_t H5T_order_t H5T_pad_t H5T_pers_t H5T_sign_t H5T_str_t

struct H5T_cdata_t

fn H5T_C_S1 H5T_NATIVE_DOUBLE H5T_NATIVE_FLOAT H5T_NATIVE_INT H5T_NATIVE_LLONG H5T_NATIVE_LONG H5T_NATIVE_SCHAR H5T_NATIVE_SHORT H5T_NATIVE_UCHAR H5T_NATIVE_UINT H5T_NATIVE_ULLONG H5T_NATIVE_ULONG H5T_NATIVE_USHORT H5Tarray_create1 H5Tarray_create2 H5Tclose H5Tcommit1 H5Tcommit2 H5Tcommit_anon H5Tcommitted H5Tcompiler_conv H5Tconvert H5Tcopy H5Tcreate H5Tdecode H5Tdetect_class H5Tencode H5Tenum_create H5Tenum_insert H5Tenum_nameof H5Tenum_valueof H5Tequal H5Tfind H5Tflush H5Tget_array_dims1 H5Tget_array_dims2 H5Tget_array_ndims H5Tget_class H5Tget_create_plist H5Tget_cset H5Tget_ebias H5Tget_fields H5Tget_inpad H5Tget_member_class H5Tget_member_index H5Tget_member_name H5Tget_member_offset H5Tget_member_type H5Tget_member_value H5Tget_native_type H5Tget_nmembers H5Tget_norm H5Tget_offset H5Tget_order H5Tget_pad H5Tget_precision H5Tget_sign H5Tget_size H5Tget_strpad H5Tget_super H5Tget_tag H5Tinsert H5Tis_variable_str H5Tlock H5Topen1 H5Topen2 H5Tpack H5Treclaim H5Trefresh H5Tregister H5Tset_cset H5Tset_ebias H5Tset_fields H5Tset_inpad H5Tset_norm H5Tset_offset H5Tset_order H5Tset_pad H5Tset_precision H5Tset_sign H5Tset_size H5Tset_strpad H5Tset_tag H5Tunregister H5Tvlen_create

Types 13

enumH5T_class_t : int

Datatype class identifiers

NO_CLASS = - 1

INTEGER = 0

FLOAT = 1

TIME = 2

STRING = 3

BITFIELD = 4

OPAQUE = 5

COMPOUND = 6

REFERENCE = 7

ENUM = 8

VLEN = 9

ARRAY = 10

NCLASSES = 11

enumH5T_order_t : int

Byte order

ORDER_ERROR = - 1

LE = 0

BE = 1

VAX = 2

MIXED = 3

NONE = 4

enumH5T_sign_t : int

Sign type

SGN_ERROR = - 1

SGN_NONE = 0

SGN_2 = 1

NSGN = 2

enumH5T_cset_t : int

Character set

CSET_ERROR = - 1

ASCII = 0

UTF8 = 1

enumH5T_str_t : int

String padding

STR_ERROR = - 1

NULLTERM = 0

NULLPAD = 1

SPACEPAD = 2

enumH5T_direction_t : int

Type search direction

DIR_DEFAULT = 0

DIR_ASCEND = 1

DIR_DESCEND = 2

enumH5T_pad_t : int

Padding type for bits

PAD_ERROR = - 1

PAD_ZERO = 0

PAD_ONE = 1

PAD_BACKGROUND = 2

NPAD = 3

enumH5T_norm_t : int

Floating-point normalization type

NORM_ERROR = - 1

NORM_IMPLIED = 0

NORM_MSBSET = 1

NORM_NONE = 2

enumH5T_pers_t : int

Type conversion persistence.

Controls whether a conversion function is hard (always used) or soft (used only as fallback).

DONTCARE = - 1Unused/error value

HARD = 0Hard conversion function - always used

SOFT = 1Soft conversion function - fallback

enumH5T_cmd_t : int

Conversion command for H5T_conv_t callbacks.

INIT = 0Initialize conversion (allocate private data)

CONV = 1Perform conversion

FREE = 2Free private data

enumH5T_bkg_t : int

Background buffer disposition.

NO = 0No background buffer needed

TEMP = 1Background buffer needed, preserve existing data

YES = 2Background buffer needed, don't preserve

structH5T_cdata_t

Conversion data structure.

Passed to type conversion functions to maintain state between calls.

Fields

H5T_cmd_t commandCommand (init, convert, or free)

H5T_bkg_t need_bkgNeed for background buffer

hbool_t recalcRecalculation needed flag

void * privPrivate data for conversion function

aliasH5T_conv_t = herr_t function(hid_t src_id, hid_t dst_id, H5T_cdata_t * cdata, size_t nelmts, size_t buf_stride, size_t bkg_stride, void * buf, void * bkg, hid_t plist_id) @nogc nothrow

Type conversion function pointer type.

Parameters

`src_id`	Source datatype identifier
`dst_id`	Destination datatype identifier
`cdata`	Conversion data structure
`nelmts`	Number of elements to convert
`buf_stride`	Buffer stride
`bkg_stride`	Background buffer stride
`buf`	Buffer containing data to convert
`bkg`	Background buffer
`plist_id`	Property list identifier

Returns

Non-negative on success, negative on failure.

Functions 85

fnhid_t H5T_NATIVE_SCHAR() @propertyNative signed char type

fnhid_t H5T_NATIVE_UCHAR() @propertyNative unsigned char type

fnhid_t H5T_NATIVE_SHORT() @propertyNative short type

fnhid_t H5T_NATIVE_USHORT() @propertyNative unsigned short type

fnhid_t H5T_NATIVE_INT() @propertyNative int type

fnhid_t H5T_NATIVE_UINT() @propertyNative unsigned int type

fnhid_t H5T_NATIVE_LONG() @propertyNative long type

fnhid_t H5T_NATIVE_ULONG() @propertyNative unsigned long type

fnhid_t H5T_NATIVE_LLONG() @propertyNative long long type

fnhid_t H5T_NATIVE_ULLONG() @propertyNative unsigned long long type

fnhid_t H5T_NATIVE_FLOAT() @propertyNative float type

fnhid_t H5T_NATIVE_DOUBLE() @propertyNative double type

fnhid_t H5T_C_S1() @propertyC string type

fnhid_t H5Tcreate(H5T_class_t type, size_t size)Creates a new datatype

fnhid_t H5Tcopy(hid_t type_id)Copies a datatype

fnherr_t H5Tclose(hid_t type_id)Closes a datatype

fnhtri_t H5Tequal(hid_t type1_id, hid_t type2_id)Determines whether two datatype identifiers refer to the same datatype

fnherr_t H5Tlock(hid_t type_id)Locks a datatype

fnherr_t H5Tcommit2(hid_t loc_id, const char * name, hid_t type_id, hid_t lcpl_id, hid_t tcpl_id, hid_t tapl_id)Commits a transient datatype to a file

fnhid_t H5Topen2(hid_t loc_id, const char * name, hid_t tapl_id)Opens a committed datatype

fnhtri_t H5Tcommitted(hid_t type_id)Determines whether a datatype is a committed type

fnherr_t H5Tinsert(hid_t parent_id, const char * name, size_t offset, hid_t member_id)Adds a new member to a compound datatype

fnherr_t H5Tpack(hid_t type_id)Recursively removes padding from within a compound datatype

fnhid_t H5Tenum_create(hid_t base_id)Creates a new enumeration datatype

fnherr_t H5Tenum_insert(hid_t type, const char * name, const void * value)Inserts a new enumeration member

fnhid_t H5Tvlen_create(hid_t base_id)Creates a new variable-length datatype

fnhid_t H5Tarray_create2(hid_t base_id, uint ndims, const hsize_t * dim)Creates an array datatype

fnint H5Tget_array_ndims(hid_t type_id)Returns the number of dimensions of an array datatype

fnint H5Tget_array_dims2(hid_t type_id, hsize_t * dims)Retrieves sizes of array dimensions

fnhid_t H5Tget_super(hid_t type)Returns the base datatype from which a datatype is derived

fnH5T_class_t H5Tget_class(hid_t type_id)Returns the datatype class identifier

fnhtri_t H5Tdetect_class(hid_t type_id, H5T_class_t cls)Determines whether a datatype contains a specific class

fnsize_t H5Tget_size(hid_t type_id)Returns the size of a datatype

fnH5T_order_t H5Tget_order(hid_t type_id)Returns the byte order of a datatype

fnsize_t H5Tget_precision(hid_t type_id)Returns the precision of an atomic datatype

fnH5T_sign_t H5Tget_sign(hid_t type_id)Returns the sign type for an integer datatype

fnH5T_cset_t H5Tget_cset(hid_t type_id)Returns the character set type of a string datatype

fnH5T_str_t H5Tget_strpad(hid_t type_id)Returns the string padding method for a string datatype

fnint H5Tget_nmembers(hid_t type_id)Returns the number of members in a compound or enumeration datatype

fnchar * H5Tget_member_name(hid_t type_id, uint membno)Returns the name of a compound or enumeration datatype member

fnint H5Tget_member_index(hid_t type_id, const char * name)Returns the index of a compound or enumeration datatype member

fnsize_t H5Tget_member_offset(hid_t type_id, uint membno)Returns the byte offset of a compound datatype member

fnH5T_class_t H5Tget_member_class(hid_t type_id, uint membno)Returns the class of a compound datatype member

fnhid_t H5Tget_member_type(hid_t type_id, uint membno)Returns the datatype of a compound datatype member

fnhtri_t H5Tis_variable_str(hid_t type_id)Determines whether a datatype is a variable-length string

fnhid_t H5Tget_native_type(hid_t type_id, H5T_direction_t direction)Returns the native datatype of a specified datatype

fnherr_t H5Tset_size(hid_t type_id, size_t size)Sets the total size for a datatype

fnherr_t H5Tset_order(hid_t type_id, H5T_order_t order)Sets the byte order of a datatype

fnherr_t H5Tset_precision(hid_t type_id, size_t prec)Sets the precision of an atomic datatype

fnherr_t H5Tset_cset(hid_t type_id, H5T_cset_t cset)Sets the character set used by a string datatype

fnherr_t H5Tset_strpad(hid_t type_id, H5T_str_t strpad)Sets the string padding method for a string datatype

fnhid_t H5Tget_create_plist(hid_t type_id)Returns the datatype creation property list identifier.

fnherr_t H5Tencode(hid_t obj_id, void * buf, size_t * nalloc)Encodes a datatype description into a binary buffer.

fnhid_t H5Tdecode(const void * buf)Decodes a binary buffer to create a datatype.

fnherr_t H5Tflush(hid_t type_id)Flushes a committed datatype to storage.

fnherr_t H5Trefresh(hid_t type_id)Refreshes a committed datatype's metadata.

fnherr_t H5Tenum_nameof(hid_t type, const void * value, char * name, size_t size)Returns the symbol name corresponding to an enumeration member value.

fnherr_t H5Tenum_valueof(hid_t type, const char * name, void * value)Returns the value corresponding to an enumeration member name.

herr_t H5Tconvert(hid_t src_id,  hid_t dst_id,  size_t nelmts,
       void *  buf,  void *  background,  hid_t plist_id)

Converts data from one datatype to another.

fnherr_t H5Treclaim(hid_t type_id, hid_t space_id, hid_t plist_id, void * buf)Reclaims memory used by variable-length datatype data.

fnherr_t H5Tcommit_anon(hid_t loc_id, hid_t type_id, hid_t tcpl_id, hid_t tapl_id)Commits an anonymous datatype to a file.

fnsize_t H5Tget_ebias(hid_t type_id)Gets the exponent bias of a floating-point type.

fnherr_t H5Tset_ebias(hid_t type_id, size_t ebias)Sets the exponent bias of a floating-point type.

herr_t H5Tget_fields(hid_t type_id,  size_t *  spos,  size_t *  epos,
       size_t *  esize,  size_t *  mpos,  size_t *  msize)

Gets the floating-point datatype bit field information.

herr_t H5Tset_fields(hid_t type_id,  size_t spos,  size_t epos,
       size_t esize,  size_t mpos,  size_t msize)

Sets the floating-point datatype bit field information.

fnH5T_pad_t H5Tget_inpad(hid_t type_id)Gets the internal padding type for unused bits in floating-point types.

fnherr_t H5Tset_inpad(hid_t type_id, H5T_pad_t pad)Sets the internal padding type for unused bits in floating-point types.

fnH5T_norm_t H5Tget_norm(hid_t type_id)Gets the mantissa normalization type.

fnherr_t H5Tset_norm(hid_t type_id, H5T_norm_t norm)Sets the mantissa normalization type.

fnint H5Tget_offset(hid_t type_id)Gets the bit offset of the first significant bit.

fnherr_t H5Tset_offset(hid_t type_id, size_t offset)Sets the bit offset of the first significant bit.

fnherr_t H5Tget_pad(hid_t type_id, H5T_pad_t * lsb, H5T_pad_t * msb)Gets the padding type for least and most significant bits.

fnherr_t H5Tset_pad(hid_t type_id, H5T_pad_t lsb, H5T_pad_t msb)Sets the padding type for least and most significant bits.

fnchar * H5Tget_tag(hid_t type_id)Gets the tag associated with an opaque datatype.

fnherr_t H5Tset_tag(hid_t type_id, const char * tag)Sets the tag for an opaque datatype.

fnherr_t H5Tset_sign(hid_t type_id, H5T_sign_t sign)Sets the sign property for an integer type.

fnherr_t H5Tget_member_value(hid_t type_id, uint membno, void * value)Gets the value of an enumeration member.

fnH5T_conv_t H5Tfind(hid_t src_id, hid_t dst_id, H5T_cdata_t * * pcdata)Finds a conversion function between datatypes.

fnhtri_t H5Tcompiler_conv(hid_t src_id, hid_t dst_id)Checks if the library's default conversion is a compiler cast.

herr_t H5Tregister(H5T_pers_t pers,  const  char *  name,  hid_t src_id,
       hid_t dst_id,  H5T_conv_t func)

Registers a datatype conversion function.

herr_t H5Tunregister(H5T_pers_t pers,  const  char *  name,  hid_t src_id,
       hid_t dst_id,  H5T_conv_t func)

Unregisters a datatype conversion function.

hid_t H5Tarray_create1(hid_t base_id,  int  ndims,  const  hsize_t *  dim,
       const  int *  perm)

Creates an array datatype (deprecated version 1).

fnint H5Tget_array_dims1(hid_t type_id, hsize_t * dims, int * perm)Gets array dimensions (deprecated version 1).

fnherr_t H5Tcommit1(hid_t loc_id, const char * name, hid_t type_id)Commits a transient datatype (deprecated version 1).

fnhid_t H5Topen1(hid_t loc_id, const char * name)Opens a committed datatype (deprecated version 1).

Variables 13

varhid_t H5T_NATIVE_SCHAR_g

varhid_t H5T_NATIVE_UCHAR_g

varhid_t H5T_NATIVE_SHORT_g

varhid_t H5T_NATIVE_USHORT_g

varhid_t H5T_NATIVE_INT_g

varhid_t H5T_NATIVE_UINT_g

varhid_t H5T_NATIVE_LONG_g

varhid_t H5T_NATIVE_ULONG_g

varhid_t H5T_NATIVE_LLONG_g

varhid_t H5T_NATIVE_ULLONG_g

varhid_t H5T_NATIVE_FLOAT_g

varhid_t H5T_NATIVE_DOUBLE_g

varhid_t H5T_C_S1_g