H5Z

[ Top ] [ Modules ]

NAME

  MODULE H5Z

PURPOSE

  This file contains Fortran interfaces for H5Z functions. It includes
  all the functions that are independent on whether the Fortran 2003 functions
  are enabled or disabled.

NOTES

                         *** IMPORTANT ***
  If you add a new H5Z function you must add the function name to the
  Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
  This is needed for Windows based operating systems.

h5zfilter_avail_f

[ Top ] [ H5Z ] [ Subroutines ]

NAME

  h5zfilter_avail_f

PURPOSE

  Queries if filter is available

INPUTS

  filter        - filter

OUTPUTS

  status        - status; .TRUE. if filter is available,
                  .FALSE. otherwise
  hdferr:       - error code
                   Success:  0
                   Failure: -1

AUTHOR

  Elena Pourmal
  March 12, 2003

SOURCE

  SUBROUTINE h5zfilter_avail_f(filter, status, hdferr)
    IMPLICIT NONE
    INTEGER, INTENT(IN)  :: filter      ! Filter; may be one of the following:
                                        !   H5Z_FILTER_DEFLATE_F
                                        !   H5Z_FILTER_SZIP_F
                                        !   H5Z_FILTER_NBIT_F
                                        !   H5Z_FILTER_SCALEOFFSET_F
                                        !   H5Z_FILTER_SHUFFLE_F
                                        !   H5Z_FILTER_FLETCHER32_F
    LOGICAL, INTENT(OUT) :: status      ! Flag, idicates if filter
                                        ! is availble  not ( TRUE or
                                        ! FALSE)
    INTEGER, INTENT(OUT) :: hdferr      ! Error code

h5zget_filter_info_f

[ Top ] [ H5Z ] [ Subroutines ]

NAME

  h5zget_filter_info_f

PURPOSE

  Queries if filter has its encoder and/or decoder
  available

INPUTS

  filter        - filter

OUTPUTS

  config_flags  - Bit vector possibly containing the
                  following values:
                     H5Z_FILTER_ENCODE_ENABLED_F
                     H5Z_FILTER_DECODE_ENABLED_F
  hdferr:       - error code
                   Success:  0
                   Failure: -1

AUTHOR

  Nat Furrer and James Laird
  June 16, 2004

SOURCE

  SUBROUTINE h5zget_filter_info_f(filter, config_flags, hdferr)
    IMPLICIT NONE
    INTEGER, INTENT(IN)  :: filter      ! Filter; may be one of the following:
                                        !   H5Z_FILTER_DEFLATE_F
                                        !   H5Z_FILTER_SZIP_F
                                        !   H5Z_FILTER_NBIT_F
                                        !   H5Z_FILTER_SCALEOFFSET_F
                                        !   H5Z_FILTER_SHUFFLE_F
                                        !   H5Z_FILTER_FLETCHER32_F
    INTEGER, INTENT(OUT) :: config_flags! Flag, indicates if filter
                                        ! has its encoder and/or decoder
                                        ! available
    INTEGER, INTENT(OUT) :: hdferr      ! Error code

h5zunregister_f

[ Top ] [ H5Z ] [ Subroutines ]

NAME

  h5zunregister_f

PURPOSE

  Unregisters specified filetr

INPUTS

  filter - filter; may have one of the following values:
            H5Z_FILTER_DEFLATE_F
            H5Z_FILTER_SZIP_F
            H5Z_FILTER_NBIT_F
            H5Z_FILTER_SCALEOFFSET_F
            H5Z_FILTER_SHUFFLE_F
            H5Z_FILTER_FLETCHER32_F

OUTPUTS

  hdferr - error code
            Success:  0
            Failure: -1

AUTHOR

  Elena Pourmal
  March 12, 2003

SOURCE

  SUBROUTINE h5zunregister_f(filter, hdferr)
    IMPLICIT NONE
    INTEGER, INTENT(IN)  :: filter
    INTEGER, INTENT(OUT) :: hdferr  ! Error code