H5T: Datatype Interface

Datatype Object API Functions

The C Interfaces:

General Datatype Operations H5Tcreate H5Topen H5Topen1  * H5Topen2 H5Tcommit H5Tcommit1  * H5Tcommit2 H5Tcommit_anon H5Tcommitted H5Tcopy H5Tequal H5Tlock H5Tget_class H5Tget_create_plist H5Tset_size H5Tget_size H5Tget_super H5Tget_native_type H5Tdetect_class H5Tclose Conversion Functions H5Tconvert H5Tfind H5Tcompiler_conv H5Tregister H5Tunregister H5Tdecode H5Tencode

Atomic Datatype Properties H5Tget_order H5Tset_order H5Tget_precision H5Tset_precision H5Tget_offset H5Tset_offset H5Tget_pad H5Tset_pad H5Tget_sign H5Tset_sign H5Tget_fields H5Tset_fields H5Tget_ebias H5Tset_ebias H5Tget_norm H5Tset_norm H5Tget_inpad H5Tset_inpad H5Tget_cset H5Tset_cset H5Tget_strpad H5Tset_strpad H5Tis_variable_str Array Datatypes H5Tarray_create H5Tarray_create1  * H5Tarray_create2 H5Tget_array_ndims H5Tget_array_dims H5Tget_array_dims1  * H5Tget_array_dims2

Compound Datatype Properties H5Tget_nmembers H5Tget_member_class H5Tget_member_name H5Tget_member_index H5Tget_member_offset H5Tget_member_type H5Tinsert H5Tpack Variable-length Array Datatypes H5Tvlen_create Opaque Datatypes H5Tset_tag H5Tget_tag Enumeration Datatypes H5Tenum_create H5Tenum_insert H5Tenum_nameof H5Tenum_valueof H5Tget_member_value H5Tget_nmembers H5Tget_member_name H5Tget_member_index         *   Use of these functions           is deprecated in           Release 1.8.0.

Alphabetical Listing

H5Tarray_create H5Tarray_create1  * H5Tarray_create2 H5Tclose H5Tcommit H5Tcommit1  * H5Tcommit2 H5Tcommit_anon H5Tcommitted H5Tcompiler_conv H5Tconvert H5Tcopy H5Tcreate H5Tdecode H5Tdetect_class H5Tencode H5Tenum_create H5Tenum_insert H5Tenum_nameof H5Tenum_valueof H5Tequal H5Tfind H5Tget_array_dims 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 H5Topen H5Topen1  * H5Topen2 H5Tpack 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

The Fortran Interface:
In general, each Fortran subroutine performs exactly the same task as the corresponding C function.

General Datatype Operations h5tcreate_f h5topen_f h5tcommit_f h5tcommitted_f h5tcopy_f h5tequal_f h5tget_class_f h5tset_size_f h5tget_size_f h5tget_super_f h5tget_native_type_f h5tclose_f Enumeration Datatypes h5tenum_create_f h5tenum_insert_f h5tenum_nameof_f h5tenum_valueof_f h5tget_member_value_f h5tget_nmembers_f h5tget_member_name_f h5tget_member_index_f

Atomic Datatype Properties h5tget_order_f h5tset_order_f h5tget_precision_f h5tset_precision_f h5tget_offset_f h5tset_offset_f h5tget_pad_f h5tset_pad_f h5tget_sign_f h5tset_sign_f h5tget_fields_f h5tset_fields_f h5tget_ebiass_f h5tset_ebiass_f h5tget_norm_f h5tset_norm_f h5tget_inpad_f h5tset_inpad_f h5tget_cset_f h5tset_cset_f h5tget_strpad_f h5tset_strpad_f h5tis_variable_str_f

Array Datatypes h5tarray_create_f h5tget_array_ndims_f h5tget_array_dims_f Compound Datatype Properties h5tget_nmembers_f h5tget_member_class_f h5tget_member_name_f h5tget_member_index_f h5tget_member_offset_f h5tget_member_type_f h5tinsert_f h5tpack_f Variable-length Array Datatypes h5tvlen_create_f Opaque Datatypes h5tset_tag_f h5tget_tag_f Conversion Subroutines h5tconvert_f

The Datatype interface, H5T, provides a mechanism to describe the storage format of individual data points of a data set and is hopefully designed in such a way as to allow new features to be easily added without disrupting applications that use the data type interface. A dataset (the H5D interface) is composed of a collection or raw data points of homogeneous type organized according to the data space (the H5S interface).

A datatype is a collection of datatype properties, all of which can be stored on disk, and which when taken as a whole, provide complete information for data conversion to or from that datatype. The interface provides functions to set and query properties of a datatype.

A data point is an instance of a datatype, which is an instance of a type class. We have defined a set of type classes and properties which can be extended at a later time. The atomic type classes are those which describe types which cannot be decomposed at the datatype interface level; all other classes are compound.

See “HDF5 Datatypes” in the HDF5 User’s Guide for more information.