HDF5 1.14.5
API Reference
|
Modules | |
module | h5lib |
This module provides fortran specific helper functions for the HDF library. | |
Functions/Subroutines | |
subroutine, public | h5open_f (error) |
Initializes HDF5 Fortran interface. | |
subroutine, public | h5close_f (error) |
Closes HDF5 Fortran interface. | |
subroutine, public | h5get_libversion_f (majnum, minnum, relnum, error) |
Returns the HDF5 LIbrary release number. | |
subroutine, public | h5check_version_f (majnum, minnum, relnum, error) |
Verifies that library versions are consistent. | |
subroutine, public | h5garbage_collect_f (error) |
Garbage collects on all free-lists of all types. | |
subroutine, public | h5dont_atexit_f (error) |
Instructs library not to install atexit cleanup routine. | |
subroutine, public | h5get_free_list_sizes_f (reg_size, arr_size, blk_size, fac_size, error) |
Gets the current size of the free lists used to manage memory. | |
integer(hid_t) function, public | h5kind_to_type (ikind, flag) |
Converts the KIND to the correct HDF type. | |
integer(size_t) function, public | h5offsetof (start, end) |
Computes the offset in memory. | |
integer function, dimension(1:8), public | h5gmtime (stdtime_t) |
Convert time_t structure (C) to Fortran DATE AND TIME storage format. | |
Variables | |
integer, parameter | h5_real_kind = 1 |
Used in the function h5kind_to_type() | |
integer, parameter | h5_integer_kind = 0 |
Used in the function h5kind_to_type() | |
integer | h5_index_unknown_f |
H5_INDEX_UNKNOWN. | |
integer | h5_index_name_f |
H5_INDEX_NAME. | |
integer | h5_index_crt_order_f |
H5_INDEX_CRT_ORDER. | |
integer | h5_index_n_f |
H5_INDEX_N. | |
integer | h5_iter_unknown_f |
H5_ITER_UNKNOWN. | |
integer | h5_iter_inc_f |
H5_ITER_INC. | |
integer | h5_iter_dec_f |
H5_ITER_DEC. | |
integer | h5_iter_native_f |
H5_ITER_NATIVE. | |
integer | h5_iter_n_f |
H5_ITER_N. | |
integer(haddr_t) | haddr_undef_f |
HADDR_UNDEF. | |
integer | h5_szip_ec_om_f |
H5_SZIP_EC_OM. | |
integer | h5_szip_nn_om_f |
H5_SZIP_NN_OM. | |
subroutine, public h5check_version_f | ( | integer, intent(in) | majnum, |
integer, intent(in) | minnum, | ||
integer, intent(in) | relnum, | ||
integer, intent(out) | error | ||
) |
Verifies that library versions are consistent.
majnum | Major version of the library. |
minnum | Minor version of the library. |
relnum | Release version of the library. |
error | Returns 0 if successful and -1 if it fails. |
See C API: H5check_version()
subroutine, public h5close_f | ( | integer, intent(out) | error | ) |
Closes HDF5 Fortran interface.
error | Returns 0 if successful and -1 if it fails. |
subroutine, public h5dont_atexit_f | ( | integer, intent(out) | error | ) |
Instructs library not to install atexit cleanup routine.
error | Returns 0 if successful and -1 if it fails. |
See C API: H5dont_atexit()
subroutine, public h5garbage_collect_f | ( | integer, intent(out) | error | ) |
Garbage collects on all free-lists of all types.
error | Returns 0 if successful and -1 if it fails. |
See C API: H5garbage_collect()
subroutine, public h5get_free_list_sizes_f | ( | integer(c_size_t), intent(out) | reg_size, |
integer(c_size_t), intent(out) | arr_size, | ||
integer(c_size_t), intent(out) | blk_size, | ||
integer(c_size_t), intent(out) | fac_size, | ||
integer, intent(out) | error | ||
) |
Gets the current size of the free lists used to manage memory.
reg_size | The current size of all "regular" free list memory used |
arr_size | The current size of all "array" free list memory used |
blk_size | The current size of all "block" free list memory used |
fac_size | The current size of all "factory" free list memory used |
error | Returns 0 if successful and -1 if it fails. |
See C API: H5get_free_list_sizes()
subroutine, public h5get_libversion_f | ( | integer, intent(out) | majnum, |
integer, intent(out) | minnum, | ||
integer, intent(out) | relnum, | ||
integer, intent(out) | error | ||
) |
Returns the HDF5 LIbrary release number.
majnum | Major version of the library. |
minnum | Minor version of the library. |
relnum | Release version of the library. |
error | Returns 0 if successful and -1 if it fails. |
See C API: H5get_libversion()
integer function, dimension(1:8), public h5gmtime | ( | integer(kind=time_t), intent(in) | stdtime_t | ) |
Convert time_t structure (C) to Fortran DATE AND TIME storage format.
stdtime_t | Object of type time_t that contains a time value |
integer(hid_t) function, public h5kind_to_type | ( | integer, intent(in) | ikind, |
integer, intent(in) | flag | ||
) |
Converts the KIND to the correct HDF type.
ikind | Fortran KIND parameter |
flag | Whether KIND is of type INTEGER or REAL:
|
integer(size_t) function, public h5offsetof | ( | type(c_ptr), intent(in), value | start, |
type(c_ptr), intent(in), value | end | ||
) |
Computes the offset in memory.
start | Starting pointer address |
end | Ending pointer address |
subroutine, public h5open_f | ( | integer, intent(out) | error | ) |
Initializes HDF5 Fortran interface.
error | Returns 0 if successful and -1 if it fails. |
integer h5_index_crt_order_f |
H5_INDEX_CRT_ORDER.
integer h5_index_n_f |
H5_INDEX_N.
integer h5_index_name_f |
H5_INDEX_NAME.
integer h5_index_unknown_f |
H5_INDEX_UNKNOWN.
integer, parameter h5_integer_kind = 0 |
Used in the function h5kind_to_type()
integer h5_iter_dec_f |
H5_ITER_DEC.
integer h5_iter_inc_f |
H5_ITER_INC.
integer h5_iter_n_f |
H5_ITER_N.
integer h5_iter_native_f |
H5_ITER_NATIVE.
integer h5_iter_unknown_f |
H5_ITER_UNKNOWN.
integer, parameter h5_real_kind = 1 |
Used in the function h5kind_to_type()
integer h5_szip_ec_om_f |
H5_SZIP_EC_OM.
integer h5_szip_nn_om_f |
H5_SZIP_NN_OM.
integer(haddr_t) haddr_undef_f |
HADDR_UNDEF.