HDF5 1.14.5
API Reference
|
Modules | |
module | h5t |
This module contains Fortran interfaces for H5T functions. | |
Functions/Subroutines | |
subroutine | h5topen_f (loc_id, name, type_id, hdferr, tapl_id) |
Opens named datatype. | |
subroutine | h5tcommit_f (loc_id, name, type_id, hdferr, lcpl_id, tcpl_id, tapl_id) |
Commits a transient datatype to a file, creating a new named datatype. | |
subroutine | h5tcopy_f (type_id, new_type_id, hdferr) |
Creates a copy of existing datatype. | |
subroutine | h5tequal_f (type1_id, type2_id, flag, hdferr) |
Determines whether two datatype identifiers refer to the same datatype. | |
subroutine | h5tclose_f (type_id, hdferr) |
Releases a datatype. | |
subroutine | h5tget_class_f (type_id, class, hdferr) |
Returns the datatype class identifier. | |
subroutine | h5tget_size_f (type_id, size, hdferr) |
Returns the size of a datatype. | |
subroutine | h5tset_size_f (type_id, size, hdferr) |
Sets the total size for an atomic datatype. | |
subroutine | h5tget_order_f (type_id, order, hdferr) |
Returns the byte order of an atomic datatype. | |
subroutine | h5tset_order_f (type_id, order, hdferr) |
Sets the byte ordering of an atomic datatype. | |
subroutine | h5tget_precision_f (type_id, precision, hdferr) |
Returns the precision of an atomic datatype. | |
subroutine | h5tset_precision_f (type_id, precision, hdferr) |
Sets the precision of an atomic datatype. | |
subroutine | h5tget_offset_f (type_id, offset, hdferr) |
Retrieves the bit offset of the first significant bit. | |
subroutine | h5tset_offset_f (type_id, offset, hdferr) |
Sets the bit offset of the first significant bit. | |
subroutine | h5tget_pad_f (type_id, lsbpad, msbpad, hdferr) |
Retrieves the padding type of the least and most-significant bit padding. | |
subroutine | h5tset_pad_f (type_id, lsbpad, msbpad, hdferr) |
Sets the least and most-significant bits padding types. | |
subroutine | h5tget_sign_f (type_id, sign, hdferr) |
Retrieves the sign type for an integer type. | |
subroutine | h5tset_sign_f (type_id, sign, hdferr) |
Sets the sign property for an integer type. | |
subroutine | h5tget_fields_f (type_id, spos, epos, esize, mpos, msize, hdferr) |
Retrieves floating point datatype bit field information. | |
subroutine | h5tset_fields_f (type_id, spos, epos, esize, mpos, msize, hdferr) |
Sets locations and sizes of floating point bit fields. | |
subroutine | h5tget_ebias_f (type_id, ebias, hdferr) |
Retrieves the exponent bias of a floating-point type. | |
subroutine | h5tset_ebias_f (type_id, ebias, hdferr) |
Sets the exponent bias of a floating-point type. | |
subroutine | h5tget_norm_f (type_id, norm, hdferr) |
Retrieves mantissa normalization of a floating-point datatype. | |
subroutine | h5tset_norm_f (type_id, norm, hdferr) |
Sets the mantissa normalization of a floating-point datatype. | |
subroutine | h5tget_inpad_f (type_id, padtype, hdferr) |
Retrieves the internal padding type for unused bits in floating-point datatypes. | |
subroutine | h5tset_inpad_f (type_id, padtype, hdferr) |
Fills unused internal floating point bits. | |
subroutine | h5tget_cset_f (type_id, cset, hdferr) |
Retrieves the character set type of a string datatype. | |
subroutine | h5tset_cset_f (type_id, cset, hdferr) |
Sets character set to be used. | |
subroutine | h5tget_strpad_f (type_id, strpad, hdferr) |
Retrieves the storage mechanism for a string datatype. | |
subroutine | h5tset_strpad_f (type_id, strpad, hdferr) |
Defines the storage mechanism for character strings. | |
subroutine | h5tget_nmembers_f (type_id, num_members, hdferr) |
Retrieves the number of fields in a compound datatype. | |
subroutine | h5tget_member_name_f (type_id, index, member_name, namelen, hdferr) |
Retrieves the name of a field of a compound datatype. | |
subroutine | h5tget_member_offset_f (type_id, member_no, offset, hdferr) |
Retrieves the offset of a field of a compound datatype. | |
subroutine | h5tget_member_index_f (type_id, name, index, hdferr) |
Retrieves the index of a compound or enumeration datatype member. | |
subroutine | h5tget_array_dims_f (type_id, dims, hdferr) |
Returns sizes of array dimensions. | |
subroutine | h5tget_array_ndims_f (type_id, ndims, hdferr) |
Returns the rank of an array datatype. | |
subroutine | h5tget_super_f (type_id, base_type_id, hdferr) |
Returns the base datatype from which a datatype is derived. | |
subroutine | h5tget_member_type_f (type_id, field_idx, datatype, hdferr) |
Returns the datatype of the specified member. | |
subroutine | h5tcreate_f (class, size, type_id, hdferr) |
Creates a new datatype. | |
subroutine | h5tinsert_f (type_id, name, offset, field_id, hdferr) |
Adds a new member to a compound datatype. | |
subroutine | h5tpack_f (type_id, hdferr) |
Recursively removes padding from within a compound datatype. | |
subroutine | h5tarray_create_f (base_id, rank, dims, type_id, hdferr) |
Creates an array datatype object. | |
subroutine | h5tenum_create_f (parent_id, new_type_id, hdferr) |
Creates a new enumeration datatype. | |
subroutine | h5tenum_nameof_f (type_id, value, namelen, name, hdferr) |
Returns the symbol name corresponding to a specified member of an enumeration datatype. | |
subroutine | h5tenum_valueof_f (type_id, name, value, hdferr) |
Returns the value corresponding to a specified member of an enumeration datatype. | |
subroutine | h5tget_member_value_f (type_id, member_no, value, hdferr) |
Returns the value of an enumeration datatype member. | |
subroutine | h5tset_tag_f (type_id, tag, hdferr) |
Tags an opaque datatype. | |
subroutine | h5tget_tag_f (type_id, tag, taglen, hdferr) |
Gets the tag associated with an opaque datatype. | |
subroutine | h5tvlen_create_f (type_id, vltype_id, hdferr) |
Creates a new variable-length datatype. | |
subroutine | h5tis_variable_str_f (type_id, status, hdferr) |
Determines whether a dattype is a variable string. | |
subroutine | h5tget_member_class_f (type_id, member_no, class, hdferr) |
Returns datatype class of compound datatype member. | |
subroutine | h5tcommit_anon_f (loc_id, dtype_id, hdferr, tcpl_id, tapl_id) |
Commits a transient datatype to a file, creating a new named datatype, but does not link it into the file structure. | |
subroutine | h5tcommitted_f (dtype_id, committed, hdferr) |
Determines whether a datatype is a named type or a transient type. | |
subroutine | h5tdecode_f (buf, obj_id, hdferr) |
Decode A binary object description of data type and return a new object handle. | |
subroutine | h5tencode_f (obj_id, buf, nalloc, hdferr) |
Encode a data type object description into a binary buffer. | |
subroutine | h5tget_create_plist_f (dtype_id, dtpl_id, hdferr) |
Returns a copy of a datatype creation property list. | |
subroutine | h5tcompiler_conv_f (src_id, dst_id, flag, hdferr) |
Check whether the library's default conversion is hard conversion. | |
subroutine | h5tget_native_type_f (dtype_id, direction, native_dtype_id, hdferr) |
Returns the native datatype of a specified datatype. | |
subroutine | h5tconvert_f (src_id, dst_id, nelmts, buf, hdferr, background, plist_id) |
Converts data from between specified datatypes. | |
subroutine | h5tenum_insert_f (type_id, name, value, hdferr) |
Inserts a new enumeration datatype member. | |
subroutine | h5tenum_insert_f (type_id, name, value, hdferr) |
Inserts a new enumeration datatype member. | |
Variables | |
integer(hid_t) | h5t_native_real_c_float |
H5T_NATIVE_REAL_C_FLOAT. | |
integer(hid_t) | h5t_native_real_c_double |
H5T_NATIVE_REAL_C_DOUBLE. | |
integer(hid_t) | h5t_native_real_c_long_double |
H5T_NATIVE_REAL_C_LONG_DOUBLE. | |
integer(hid_t) | h5t_native_integer |
H5T_NATIVE_INTEGER. | |
integer(hid_t) | h5t_native_real |
H5T_NATIVE_REAL. | |
integer(hid_t) | h5t_native_double |
H5T_NATIVE_DOUBLE. | |
integer(hid_t) | h5t_native_character |
H5T_NATIVE_CHARACTER. | |
integer(hid_t) | h5t_std_ref_obj |
H5T_STD_REF_OBJ. | |
integer(hid_t) | h5t_std_ref_dsetreg |
H5T_STD_REF_DSETREG. | |
integer(hid_t) | h5t_ieee_f32be |
H5T_IEEE_F32BE. | |
integer(hid_t) | h5t_ieee_f32le |
H5T_IEEE_F32LE. | |
integer(hid_t) | h5t_ieee_f64be |
H5T_IEEE_F64BE. | |
integer(hid_t) | h5t_ieee_f64le |
H5T_IEEE_F64LE. | |
integer(hid_t) | h5t_std_i8be |
H5T_STD_I8BE. | |
integer(hid_t) | h5t_std_i8le |
H5T_STD_I8LE. | |
integer(hid_t) | h5t_std_i16be |
H5T_STD_I16BE. | |
integer(hid_t) | h5t_std_i16le |
H5T_STD_I16LE. | |
integer(hid_t) | h5t_std_i32be |
H5T_STD_I32BE. | |
integer(hid_t) | h5t_std_i32le |
H5T_STD_I32LE. | |
integer(hid_t) | h5t_std_i64be |
H5T_STD_I64BE. | |
integer(hid_t) | h5t_std_i64le |
H5T_STD_I64LE. | |
integer(hid_t) | h5t_std_u8be |
H5T_STD_U8BE. | |
integer(hid_t) | h5t_std_u8le |
H5T_STD_U8LE. | |
integer(hid_t) | h5t_std_u16be |
H5T_STD_U16BE. | |
integer(hid_t) | h5t_std_u16le |
H5T_STD_U16LE. | |
integer(hid_t) | h5t_std_u32be |
H5T_STD_U32BE. | |
integer(hid_t) | h5t_std_u32le |
H5T_STD_U32LE. | |
integer(hid_t) | h5t_std_u64be |
H5T_STD_U64BE. | |
integer(hid_t) | h5t_std_u64le |
H5T_STD_U64LE. | |
integer(hid_t) | h5t_string |
H5T_STRING. | |
integer(hid_t) | h5t_std_b8be |
H5T_STD_B8BE. | |
integer(hid_t) | h5t_std_b8le |
H5T_STD_B8LE. | |
integer(hid_t) | h5t_std_b16be |
H5T_STD_B16BE. | |
integer(hid_t) | h5t_std_b16le |
H5T_STD_B16LE. | |
integer(hid_t) | h5t_std_b32be |
H5T_STD_B32BE. | |
integer(hid_t) | h5t_std_b32le |
H5T_STD_B32LE. | |
integer(hid_t) | h5t_std_b64be |
H5T_STD_B64BE. | |
integer(hid_t) | h5t_std_b64le |
H5T_STD_B64LE. | |
integer(hid_t) | h5t_native_b8 |
H5T_NATIVE_B8. | |
integer(hid_t) | h5t_native_b16 |
H5T_NATIVE_B16. | |
integer(hid_t) | h5t_native_b32 |
H5T_NATIVE_B32. | |
integer(hid_t) | h5t_native_b64 |
H5T_NATIVE_B64. | |
integer(hid_t) | h5t_fortran_s1 |
H5T_FORTRAN_S1. | |
integer(hid_t) | h5t_c_s1 |
H5T_C_S1. | |
integer(hid_t) | h5t_std_ref |
H5T_STD_REF. | |
integer(hid_t) | h5t_native_float_128 |
Quadruple-precision floating-point. | |
integer | h5t_no_class_f |
H5T_NO_CLASS. | |
integer | h5t_integer_f |
H5T_INTEGER. | |
integer | h5t_float_f |
H5T_FLOAT. | |
integer | h5t_time_f |
H5T_TIME. | |
integer | h5t_string_f |
H5T_STRING. | |
integer | h5t_bitfield_f |
H5T_BITFIELD. | |
integer | h5t_opaque_f |
H5T_OPAQUE. | |
integer | h5t_compound_f |
H5T_COMPOUND. | |
integer | h5t_reference_f |
H5T_REFERENCE. | |
integer | h5t_enum_f |
H5T_ENUM. | |
integer | h5t_vlen_f |
H5T_VLEN. | |
integer | h5t_array_f |
H5T_ARRAY. | |
integer | h5t_order_le_f |
H5T_ORDER_LE. | |
integer | h5t_order_be_f |
H5T_ORDER_BE. | |
integer | h5t_order_vax_f |
H5T_ORDER_VAX. | |
integer | h5t_order_none_f |
H5T_ORDER_NONE. | |
integer | h5t_order_mixed_f |
H5T_ORDER_MIXED. | |
integer | h5t_pad_zero_f |
H5T_PAD_ZERO. | |
integer | h5t_pad_one_f |
H5T_PAD_ONE. | |
integer | h5t_pad_background_f |
H5T_PAD_BACKGROUND. | |
integer | h5t_pad_error_f |
H5T_PAD_ERROR. | |
integer | h5t_sgn_none_f |
H5T_SGN_NONE. | |
integer | h5t_sgn_2_f |
H5T_SGN_2. | |
integer | h5t_sgn_error_f |
H5T_SGN_ERROR. | |
integer | h5t_norm_implied_f |
H5T_NORM_IMPLIED. | |
integer | h5t_norm_msbset_f |
H5T_NORM_MSBSET. | |
integer | h5t_norm_none_f |
H5T_NORM_NONE. | |
integer | h5t_cset_ascii_f |
H5T_CSET_ASCII. | |
integer | h5t_cset_utf8_f |
H5T_CSET_UTF8. | |
integer | h5t_str_nullterm_f |
H5T_STR_NULLTERM. | |
integer | h5t_str_nullpad_f |
H5T_STR_NULLPAD. | |
integer | h5t_str_spacepad_f |
H5T_STR_SPACEPAD. | |
integer | h5t_str_error_f |
H5T_STR_ERROR. | |
integer | h5t_dir_ascend_f |
H5T_DIR_ASCEND. | |
integer | h5t_dir_descend_f |
H5T_DIR_DESCEND. | |
subroutine h5tarray_create_f | ( | integer(hid_t), intent(in) | base_id, |
integer, intent(in) | rank, | ||
integer(hsize_t), dimension(*), intent(in) | dims, | ||
integer(hid_t), intent(out) | type_id, | ||
integer, intent(out) | hdferr | ||
) |
Creates an array datatype object.
base_id | Datatype identifier for the array base datatype |
rank | Rank of the array. |
dims | Array dimension sizes. |
type_id | Array datatype identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tarray_create2()
subroutine h5tclose_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(out) | hdferr | ||
) |
Releases a datatype.
type_id | Datatype identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tclose()
subroutine h5tcommit_anon_f | ( | integer(hid_t), intent(in) | loc_id, |
integer(hid_t), intent(in) | dtype_id, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | tcpl_id, | ||
integer(hid_t), intent(in), optional | tapl_id | ||
) |
Commits a transient datatype to a file, creating a new named datatype, but does not link it into the file structure.
loc_id | A file or group identifier specifying the file in which the new named datatype is to be created. |
dtype_id | A datatype identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
tcpl_id | A datatype creation property list identifier (H5P_DEFAULT_F for the default property list.) |
tapl_id | A datatype access property list identifier should always be passed as the value H5P_DEFAULT_F. |
See C API: H5Tcommit_anon()
subroutine h5tcommit_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | name, | ||
integer(hid_t), intent(in) | type_id, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | lcpl_id, | ||
integer(hid_t), intent(in), optional | tcpl_id, | ||
integer(hid_t), intent(in), optional | tapl_id | ||
) |
Commits a transient datatype to a file, creating a new named datatype.
loc_id | Location identifier. |
name | Name of the datatype to be stored at the specified location |
type_id | Identifier of a datatype to be stored. |
hdferr | Returns 0 if successful and -1 if it fails. |
lcpl_id | Link creation property list. |
tcpl_id | Datatype creation property list. |
tapl_id | Datatype access property list. |
See C API: H5Tcommit2()
subroutine h5tcommitted_f | ( | integer(hid_t), intent(in) | dtype_id, |
logical, intent(out) | committed, | ||
integer, intent(out) | hdferr | ||
) |
Determines whether a datatype is a named type or a transient type.
dtype_id | A datatype identifier. |
committed | .TRUE. if the datatype has been committed, and .FALSE. if the datatype has not been committed. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tcommitted()
subroutine h5tcompiler_conv_f | ( | integer(hid_t), intent(in) | src_id, |
integer(hid_t), intent(in) | dst_id, | ||
logical, intent(out) | flag, | ||
integer, intent(out) | hdferr | ||
) |
Check whether the library's default conversion is hard conversion.
src_id | Identifier for the source datatype. |
dst_id | Identifier for the destination datatype. |
flag | .TRUE. for compiler conversion, .FALSE. for library conversion. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tcompiler_conv()
subroutine h5tconvert_f | ( | integer(hid_t), intent(in) | src_id, |
integer(hid_t), intent(in) | dst_id, | ||
integer(size_t), intent(in) | nelmts, | ||
type(c_ptr), intent(in) | buf, | ||
integer, intent(out) | hdferr, | ||
type(c_ptr), intent(in), optional | background, | ||
integer(hid_t), intent(in), optional | plist_id | ||
) |
Converts data from between specified datatypes.
src_id | Identifier for the source datatype. |
dst_id | Identifier for the destination datatype. |
nelmts | Size of array buf. |
buf | Array containing pre-conversion values. |
hdferr | Returns 0 if successful and -1 if it fails. |
background | Background buffer. |
plist_id | Dataset transfer property list identifier. |
See C API: H5Tconvert()
subroutine h5tcopy_f | ( | integer(hid_t), intent(in) | type_id, |
integer(hid_t), intent(out) | new_type_id, | ||
integer, intent(out) | hdferr | ||
) |
Creates a copy of existing datatype.
type_id | Datatype identifier. |
new_type_id | Identifier of datatype's copy. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tcopy()
subroutine h5tcreate_f | ( | integer, intent(in) | class, |
integer(size_t), intent(in) | size, | ||
integer(hid_t), intent(out) | type_id, | ||
integer, intent(out) | hdferr | ||
) |
Creates a new datatype.
class | Datatype class can be one of:
|
size | Size of the datatype. |
type_id | Datatype identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tcreate()
subroutine h5tdecode_f | ( | character(len=*), intent(in) | buf, |
integer(hid_t), intent(out) | obj_id, | ||
integer, intent(out) | hdferr | ||
) |
Decode A binary object description of data type and return a new object handle.
buf | Buffer for the data space object to be decoded. |
obj_id | Object ID. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tdecode()
subroutine h5tencode_f | ( | integer(hid_t), intent(in) | obj_id, |
character(len=*), intent(out) | buf, | ||
integer(size_t), intent(inout) | nalloc, | ||
integer, intent(out) | hdferr | ||
) |
Encode a data type object description into a binary buffer.
obj_id | Identifier of the object to be encoded. |
buf | Buffer for the object to be encoded into. |
nalloc | If set to zero, returns the size of the buffer needed. Otherwise, it sets the size of buf allocated. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tencode()
subroutine h5tenum_create_f | ( | integer(hid_t), intent(in) | parent_id, |
integer(hid_t), intent(out) | new_type_id, | ||
integer, intent(out) | hdferr | ||
) |
Creates a new enumeration datatype.
parent_id | Datatype identifier for base datatype. |
new_type_id | Datatype identifier for the enumeration datatype. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tenum_create()
subroutine h5tenum_insert_f | ( | integer(hid_t), intent(in) | type_id, |
character(len=*), intent(in) | name, | ||
type(c_ptr), intent(in) | value, | ||
integer, intent(out) | hdferr | ||
) |
Inserts a new enumeration datatype member.
type_id | Datatype identifier for the enumeration datatype. |
name | Datatype identifier. |
value | Pointer to the value of the new member. |
hdferr | Returns 0 if successful and -1 if it fails. |
subroutine h5tenum_insert_f | ( | integer(hid_t), intent(in) | type_id, |
character(len=*), intent(in) | name, | ||
integer, intent(in) | value, | ||
integer, intent(out) | hdferr | ||
) |
Inserts a new enumeration datatype member.
type_id | Datatype identifier for the enumeration datatype. |
name | Datatype identifier. |
value | Value of the new member. |
hdferr | Returns 0 if successful and -1 if it fails. |
subroutine h5tenum_nameof_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(in) | value, | ||
integer(size_t), intent(in) | namelen, | ||
character(len=*), intent(out) | name, | ||
integer, intent(out) | hdferr | ||
) |
Returns the symbol name corresponding to a specified member of an enumeration datatype.
type_id | Datatype identifier. |
value | Value of the enumeration datatype. |
namelen | Name buffer size. |
name | Buffer to hold symbol name. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tenum_nameof()
subroutine h5tenum_valueof_f | ( | integer(hid_t), intent(in) | type_id, |
character(len=*), intent(in) | name, | ||
integer, intent(out) | value, | ||
integer, intent(out) | hdferr | ||
) |
Returns the value corresponding to a specified member of an enumeration datatype.
type_id | Datatype identifier. |
name | Symbol name. |
value | Value of the enumeration datatype. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tenum_valueof()
subroutine h5tequal_f | ( | integer(hid_t), intent(in) | type1_id, |
integer(hid_t), intent(in) | type2_id, | ||
logical, intent(out) | flag, | ||
integer, intent(out) | hdferr | ||
) |
Determines whether two datatype identifiers refer to the same datatype.
type1_id | Datatype identifier. |
type2_id | Datatype identifier. |
flag | TRUE/FALSE flag to indicate if two datatypes are equal. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tequal()
subroutine h5tget_array_dims_f | ( | integer(hid_t), intent(in) | type_id, |
integer(hsize_t), dimension(*), intent(out) | dims, | ||
integer, intent(out) | hdferr | ||
) |
Returns sizes of array dimensions.
type_id | Array datatype identifier. |
dims | Buffer to store array datatype dimensions. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_array_dims2()
subroutine h5tget_array_ndims_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(out) | ndims, | ||
integer, intent(out) | hdferr | ||
) |
Returns the rank of an array datatype.
type_id | Array datatype identifier. |
ndims | Number of array dimensions. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_array_ndims()
subroutine h5tget_class_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(out) | class, | ||
integer, intent(out) | hdferr | ||
) |
Returns the datatype class identifier.
type_id | Datatype identifier. |
class | Class, possible values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_class()
subroutine h5tget_create_plist_f | ( | integer(hid_t), intent(in) | dtype_id, |
integer(hid_t), intent(out) | dtpl_id, | ||
integer, intent(out) | hdferr | ||
) |
Returns a copy of a datatype creation property list.
dtype_id | Datatype identifier. |
dtpl_id | Datatype property list identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_create_plist()
subroutine h5tget_cset_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(out) | cset, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the character set type of a string datatype.
type_id | Datatype identifier. |
cset | Character set type of a string datatype. Possible values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_cset()
subroutine h5tget_ebias_f | ( | integer(hid_t), intent(in) | type_id, |
integer(size_t), intent(out) | ebias, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the exponent bias of a floating-point type.
type_id | Datatype identifier. |
ebias | Datatype exponent bias. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_ebias()
subroutine h5tget_fields_f | ( | integer(hid_t), intent(in) | type_id, |
integer(size_t), intent(out) | spos, | ||
integer(size_t), intent(out) | epos, | ||
integer(size_t), intent(out) | esize, | ||
integer(size_t), intent(out) | mpos, | ||
integer(size_t), intent(out) | msize, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves floating point datatype bit field information.
type_id | Datatype identifier. |
spos | Sign bit-position. |
epos | Exponent bit-position. |
esize | Size of exponent in bits. |
mpos | Mantissa position. |
msize | Size of mantissa in bits. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_fields()
subroutine h5tget_inpad_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(out) | padtype, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the internal padding type for unused bits in floating-point datatypes.
type_id | Datatype identifier. |
padtype | Padding type for unused bits. Possible values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_inpad()
subroutine h5tget_member_class_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(in) | member_no, | ||
integer, intent(out) | class, | ||
integer, intent(out) | hdferr | ||
) |
Returns datatype class of compound datatype member.
type_id | Datartpe identifier. |
member_no | Index of compound datatype member. |
class | Class type for compound dadtype member. Valid classes:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_member_class()
subroutine h5tget_member_index_f | ( | integer(hid_t), intent(in) | type_id, |
character(len=*), intent(in) | name, | ||
integer, intent(out) | index, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the index of a compound or enumeration datatype member.
type_id | Datatype identifier. |
name | Name of the field or member whose index to be retrieved from the datatype. |
index | Based index of the filed or member (0 to N-1). |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_member_index()
subroutine h5tget_member_name_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(in) | index, | ||
character(len=*), intent(out) | member_name, | ||
integer, intent(out) | namelen, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the name of a field of a compound datatype.
type_id | Datatype identifier. |
index | Filed index (0-based). |
member_name | Buffer to hold member's name. |
namelen | Name length. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_member_name()
subroutine h5tget_member_offset_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(in) | member_no, | ||
integer(size_t), intent(out) | offset, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the offset of a field of a compound datatype.
type_id | Datatype identifier. |
member_no | Number of the field. |
offset | Byte offset of the requested field. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_member_offset()
subroutine h5tget_member_type_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(in) | field_idx, | ||
integer(hid_t), intent(out) | datatype, | ||
integer, intent(out) | hdferr | ||
) |
Returns the datatype of the specified member.
type_id | Compound datatype identifier. |
field_idx | Field index (0-based). |
datatype | Identifier of the member's datatype. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_member_type()
subroutine h5tget_member_value_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(in) | member_no, | ||
integer, intent(out) | value, | ||
integer, intent(out) | hdferr | ||
) |
Returns the value of an enumeration datatype member.
type_id | Datatype identifier. |
member_no | Number of the enumeration datatype member. |
value | Value of the enumeration datatype. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_member_value()
subroutine h5tget_native_type_f | ( | integer(hid_t), intent(in) | dtype_id, |
integer, intent(in) | direction, | ||
integer(hid_t), intent(out) | native_dtype_id, | ||
integer, intent(out) | hdferr | ||
) |
Returns the native datatype of a specified datatype.
dtype_id | Datatype identifier for the dataset datatype. |
direction | Direction of search: H5T_DIR_DEFAULT, default direction is inscendent, H5T_DIR_ASCEND , in inscendent order, H5T_DIR_DESCEND, in descendent order.
|
native_dtype_id | The native datatype identifier for the specified dataset datatype. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_native_type()
subroutine h5tget_nmembers_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(out) | num_members, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the number of fields in a compound datatype.
type_id | Datatype identifier. |
num_members | Number of members. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_nmembers()
subroutine h5tget_norm_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(out) | norm, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves mantissa normalization of a floating-point datatype.
type_id | Datatype identifier. |
norm | Normalization types, valid values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_norm()
subroutine h5tget_offset_f | ( | integer(hid_t), intent(in) | type_id, |
integer(size_t), intent(out) | offset, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the bit offset of the first significant bit.
type_id | Datatype identifier. |
offset | Offset value. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_offset()
subroutine h5tget_order_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(out) | order, | ||
integer, intent(out) | hdferr | ||
) |
Returns the byte order of an atomic datatype.
type_id | Datatype identifier. |
order | Byte order for the datatype, possible values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_order()
subroutine h5tget_pad_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(out) | lsbpad, | ||
integer, intent(out) | msbpad, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the padding type of the least and most-significant bit padding.
type_id | Datatype identifier. |
lsbpad | Least-significant bit padding type. |
msbpad | Most-significant bit padding type. Possible values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_pad()
subroutine h5tget_precision_f | ( | integer(hid_t), intent(in) | type_id, |
integer(size_t), intent(out) | precision, | ||
integer, intent(out) | hdferr | ||
) |
Returns the precision of an atomic datatype.
type_id | Datatype identifier. |
precision | Precision of the datatype. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_precision()
subroutine h5tget_sign_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(out) | sign, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the sign type for an integer type.
type_id | Datatype identifier. |
sign | Sign type. Possible values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_sign()
subroutine h5tget_size_f | ( | integer(hid_t), intent(in) | type_id, |
integer(size_t), intent(out) | size, | ||
integer, intent(out) | hdferr | ||
) |
Returns the size of a datatype.
type_id | Datatype identifier. |
size | Datatype size. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_size()
subroutine h5tget_strpad_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(out) | strpad, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves the storage mechanism for a string datatype.
type_id | Datatype identifier. |
strpad | Storage method for a string datatype. Possible values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_strpad()
subroutine h5tget_super_f | ( | integer(hid_t), intent(in) | type_id, |
integer(hid_t), intent(out) | base_type_id, | ||
integer, intent(out) | hdferr | ||
) |
Returns the base datatype from which a datatype is derived.
type_id | Datatype identifier. |
base_type_id | Identifier of the base type. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_super()
subroutine h5tget_tag_f | ( | integer(hid_t), intent(in) | type_id, |
character(len=*), intent(out) | tag, | ||
integer, intent(out) | taglen, | ||
integer, intent(out) | hdferr | ||
) |
Gets the tag associated with an opaque datatype.
type_id | Identifier for opaque datatype. |
tag | Unique ASCII string associated with opaque datatype. |
taglen | Length of tag. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tget_tag()
subroutine h5tinsert_f | ( | integer(hid_t), intent(in) | type_id, |
character(len=*), intent(in) | name, | ||
integer(size_t), intent(in) | offset, | ||
integer(hid_t), intent(in) | field_id, | ||
integer, intent(out) | hdferr | ||
) |
Adds a new member to a compound datatype.
type_id | Compound datatype identifier. |
name | Name of the field to insert. |
offset | Start of the member in an instance of the compound datatype. |
field_id | Datatype identifier of the field to insert. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tinsert()
subroutine h5tis_variable_str_f | ( | integer(hid_t), intent(in) | type_id, |
logical, intent(out) | status, | ||
integer, intent(out) | hdferr | ||
) |
Determines whether a dattype is a variable string.
type_id | Datartpe identifier. |
status | Flag to indicate if datatype is a variable string ( TRUE or FALSE). |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tis_variable_str()
subroutine h5topen_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | name, | ||
integer(hid_t), intent(out) | type_id, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | tapl_id | ||
) |
Opens named datatype.
loc_id | Location identifier. |
name | A datatype name. |
type_id | Datatype identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
tapl_id | Datatype access property list identifier. |
See C API: H5Topen2()
subroutine h5tpack_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(out) | hdferr | ||
) |
Recursively removes padding from within a compound datatype.
type_id | Compound datatype identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tpack()
subroutine h5tset_cset_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(in) | cset, | ||
integer, intent(out) | hdferr | ||
) |
Sets character set to be used.
type_id | Datatype identifier. |
cset | Character set type of a string datatype. Possible values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tset_cset()
subroutine h5tset_ebias_f | ( | integer(hid_t), intent(in) | type_id, |
integer(size_t), intent(in) | ebias, | ||
integer, intent(out) | hdferr | ||
) |
Sets the exponent bias of a floating-point type.
type_id | Datatype identifier. |
ebias | Datatype exponent bias. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tset_ebias()
subroutine h5tset_fields_f | ( | integer(hid_t), intent(in) | type_id, |
integer(size_t), intent(in) | spos, | ||
integer(size_t), intent(in) | epos, | ||
integer(size_t), intent(in) | esize, | ||
integer(size_t), intent(in) | mpos, | ||
integer(size_t), intent(in) | msize, | ||
integer, intent(out) | hdferr | ||
) |
Sets locations and sizes of floating point bit fields.
type_id | Datatype identifier. |
spos | Sign bit-position. |
epos | Exponent bit-position. |
esize | Size of exponent in bits. |
mpos | Mantissa position. |
msize | Size of mantissa in bits. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tset_fields()
subroutine h5tset_inpad_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(in) | padtype, | ||
integer, intent(out) | hdferr | ||
) |
Fills unused internal floating point bits.
type_id | Datatype identifier. |
padtype | Padding type for unused bits. Possible values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tset_inpad()
subroutine h5tset_norm_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(in) | norm, | ||
integer, intent(out) | hdferr | ||
) |
Sets the mantissa normalization of a floating-point datatype.
type_id | Datatype identifier. |
norm | Normalization types, valid values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tset_norm()
subroutine h5tset_offset_f | ( | integer(hid_t), intent(in) | type_id, |
integer(size_t), intent(in) | offset, | ||
integer, intent(out) | hdferr | ||
) |
Sets the bit offset of the first significant bit.
type_id | Datatype identifier. |
offset | Offset value. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tset_offset()
subroutine h5tset_order_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(in) | order, | ||
integer, intent(out) | hdferr | ||
) |
Sets the byte ordering of an atomic datatype.
type_id | Datatype identifier. |
order | Datatype byte order Possible values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tset_order()
subroutine h5tset_pad_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(in) | lsbpad, | ||
integer, intent(in) | msbpad, | ||
integer, intent(out) | hdferr | ||
) |
Sets the least and most-significant bits padding types.
type_id | Datatype identifier. |
lsbpad | Least-significant bit padding type. |
msbpad | Most-significant bit padding type. Possible values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tset_pad()
subroutine h5tset_precision_f | ( | integer(hid_t), intent(in) | type_id, |
integer(size_t), intent(in) | precision, | ||
integer, intent(out) | hdferr | ||
) |
Sets the precision of an atomic datatype.
type_id | Datatype identifier. |
precision | Datatype precision. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tset_precision()
subroutine h5tset_sign_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(in) | sign, | ||
integer, intent(out) | hdferr | ||
) |
Sets the sign property for an integer type.
type_id | Datatype identifier. |
sign | Sign type. Possible values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tset_sign()
subroutine h5tset_size_f | ( | integer(hid_t), intent(in) | type_id, |
integer(size_t), intent(in) | size, | ||
integer, intent(out) | hdferr | ||
) |
Sets the total size for an atomic datatype.
type_id | Datatype identifier. |
size | Size of the datatype. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tset_size()
subroutine h5tset_strpad_f | ( | integer(hid_t), intent(in) | type_id, |
integer, intent(in) | strpad, | ||
integer, intent(out) | hdferr | ||
) |
Defines the storage mechanism for character strings.
type_id | Datatype identifier. |
strpad | Storage method for a string datatype. Possible values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tset_strpad()
subroutine h5tset_tag_f | ( | integer(hid_t), intent(in) | type_id, |
character(len=*), intent(in) | tag, | ||
integer, intent(out) | hdferr | ||
) |
Tags an opaque datatype.
type_id | Identifier for opaque datatype. |
tag | Unique ASCII string with which the opaque datatype is to be tagged. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tset_tag()
subroutine h5tvlen_create_f | ( | integer(hid_t), intent(in) | type_id, |
integer(hid_t), intent(out) | vltype_id, | ||
integer, intent(out) | hdferr | ||
) |
Creates a new variable-length datatype.
type_id | Identifier iof base datatype. |
vltype_id | Identifier for VL datatype. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Tvlen_create()
integer h5t_array_f |
H5T_ARRAY.
integer h5t_bitfield_f |
H5T_BITFIELD.
integer(hid_t) h5t_c_s1 |
H5T_C_S1.
integer h5t_compound_f |
H5T_COMPOUND.
integer h5t_cset_ascii_f |
H5T_CSET_ASCII.
integer h5t_cset_utf8_f |
H5T_CSET_UTF8.
integer h5t_dir_ascend_f |
H5T_DIR_ASCEND.
integer h5t_dir_descend_f |
H5T_DIR_DESCEND.
integer h5t_enum_f |
H5T_ENUM.
integer h5t_float_f |
H5T_FLOAT.
integer(hid_t) h5t_fortran_s1 |
H5T_FORTRAN_S1.
integer(hid_t) h5t_ieee_f32be |
H5T_IEEE_F32BE.
integer(hid_t) h5t_ieee_f32le |
H5T_IEEE_F32LE.
integer(hid_t) h5t_ieee_f64be |
H5T_IEEE_F64BE.
integer(hid_t) h5t_ieee_f64le |
H5T_IEEE_F64LE.
integer h5t_integer_f |
H5T_INTEGER.
integer(hid_t) h5t_native_b16 |
H5T_NATIVE_B16.
integer(hid_t) h5t_native_b32 |
H5T_NATIVE_B32.
integer(hid_t) h5t_native_b64 |
H5T_NATIVE_B64.
integer(hid_t) h5t_native_b8 |
H5T_NATIVE_B8.
integer(hid_t) h5t_native_character |
H5T_NATIVE_CHARACTER.
integer(hid_t) h5t_native_double |
H5T_NATIVE_DOUBLE.
integer(hid_t) h5t_native_float_128 |
Quadruple-precision floating-point.
integer(hid_t) h5t_native_integer |
H5T_NATIVE_INTEGER.
integer(hid_t) h5t_native_real |
H5T_NATIVE_REAL.
integer(hid_t) h5t_native_real_c_double |
H5T_NATIVE_REAL_C_DOUBLE.
integer(hid_t) h5t_native_real_c_float |
H5T_NATIVE_REAL_C_FLOAT.
integer(hid_t) h5t_native_real_c_long_double |
H5T_NATIVE_REAL_C_LONG_DOUBLE.
integer h5t_no_class_f |
H5T_NO_CLASS.
integer h5t_norm_implied_f |
H5T_NORM_IMPLIED.
integer h5t_norm_msbset_f |
H5T_NORM_MSBSET.
integer h5t_norm_none_f |
H5T_NORM_NONE.
integer h5t_opaque_f |
H5T_OPAQUE.
integer h5t_order_be_f |
H5T_ORDER_BE.
integer h5t_order_le_f |
H5T_ORDER_LE.
integer h5t_order_mixed_f |
H5T_ORDER_MIXED.
integer h5t_order_none_f |
H5T_ORDER_NONE.
integer h5t_order_vax_f |
H5T_ORDER_VAX.
integer h5t_pad_background_f |
H5T_PAD_BACKGROUND.
integer h5t_pad_error_f |
H5T_PAD_ERROR.
integer h5t_pad_one_f |
H5T_PAD_ONE.
integer h5t_pad_zero_f |
H5T_PAD_ZERO.
integer h5t_reference_f |
H5T_REFERENCE.
integer h5t_sgn_2_f |
H5T_SGN_2.
integer h5t_sgn_error_f |
H5T_SGN_ERROR.
integer h5t_sgn_none_f |
H5T_SGN_NONE.
integer(hid_t) h5t_std_b16be |
H5T_STD_B16BE.
integer(hid_t) h5t_std_b16le |
H5T_STD_B16LE.
integer(hid_t) h5t_std_b32be |
H5T_STD_B32BE.
integer(hid_t) h5t_std_b32le |
H5T_STD_B32LE.
integer(hid_t) h5t_std_b64be |
H5T_STD_B64BE.
integer(hid_t) h5t_std_b64le |
H5T_STD_B64LE.
integer(hid_t) h5t_std_b8be |
H5T_STD_B8BE.
integer(hid_t) h5t_std_b8le |
H5T_STD_B8LE.
integer(hid_t) h5t_std_i16be |
H5T_STD_I16BE.
integer(hid_t) h5t_std_i16le |
H5T_STD_I16LE.
integer(hid_t) h5t_std_i32be |
H5T_STD_I32BE.
integer(hid_t) h5t_std_i32le |
H5T_STD_I32LE.
integer(hid_t) h5t_std_i64be |
H5T_STD_I64BE.
integer(hid_t) h5t_std_i64le |
H5T_STD_I64LE.
integer(hid_t) h5t_std_i8be |
H5T_STD_I8BE.
integer(hid_t) h5t_std_i8le |
H5T_STD_I8LE.
integer(hid_t) h5t_std_ref |
H5T_STD_REF.
integer(hid_t) h5t_std_ref_dsetreg |
H5T_STD_REF_DSETREG.
integer(hid_t) h5t_std_ref_obj |
H5T_STD_REF_OBJ.
integer(hid_t) h5t_std_u16be |
H5T_STD_U16BE.
integer(hid_t) h5t_std_u16le |
H5T_STD_U16LE.
integer(hid_t) h5t_std_u32be |
H5T_STD_U32BE.
integer(hid_t) h5t_std_u32le |
H5T_STD_U32LE.
integer(hid_t) h5t_std_u64be |
H5T_STD_U64BE.
integer(hid_t) h5t_std_u64le |
H5T_STD_U64LE.
integer(hid_t) h5t_std_u8be |
H5T_STD_U8BE.
integer(hid_t) h5t_std_u8le |
H5T_STD_U8LE.
integer h5t_str_error_f |
H5T_STR_ERROR.
integer h5t_str_nullpad_f |
H5T_STR_NULLPAD.
integer h5t_str_nullterm_f |
H5T_STR_NULLTERM.
integer h5t_str_spacepad_f |
H5T_STR_SPACEPAD.
integer(hid_t) h5t_string |
H5T_STRING.
integer h5t_string_f |
H5T_STRING.
integer h5t_time_f |
H5T_TIME.
integer h5t_vlen_f |
H5T_VLEN.