hdf.f90

Go to the documentation of this file.

!****************************************************************************
!* NCSA HDF                                                                 *
!* Software Development Group                                               *
!* National Center for Supercomputing Applications                          *
!* University of Illinois at Urbana-Champaign                               *
!* 605 E. Springfield, Champaign IL 61820                                   *
!*                                                                          *
!* For conditions of distribution and use, see the accompanying             *
!* hdf/COPYING file.                                                        *
!*                                                                          *
!****************************************************************************
!
! $Id: hdf.inc 6034 2014-01-19 06:59:14Z epourmal $
!
! *-----------------------------------------------------------------------------
! * File:   hdf.inc
! * Purpose:    Fortran header file for HDF routines
! * Contents: 
! *     Tag definitions
! *     Error return codes
! *     Logical constants
! * Remarks: This file can be included with Fortran user programs.  As a
! *          general rule, don't use DFNT constants that don't include a
! *          number in their name.  E.g., don't use DFNT_FLOAT, use
! *          DFNT_FLOAT32 or DFNT_FLOAT64.  The DFNT constants that don't
! *          include numbers are for backward compatibility only.  Also,
! *          there are no current plans to support 128-bit number types.
! *          For more information about constants in this file, see the
! *          equivalent constant declarations in the C include file 'hdf.h'
! *------------------------------------------------------------------------
 
 
!   Error Return Codes 
 
      integer   DFE_NOERROR,   DFE_NONE,        DFE_FNF   
      integer   DFE_DENIED,    DFE_ALROPEN,     DFE_TOOMANY
      integer   DFE_BADNAME,   DFE_BADACC,      DFE_BADOPEN
      integer   DFE_NOTOPEN,   DFE_CANTCLOSE,   DFE_DFNULL
      integer   DFE_ILLTYPE,   DFE_UNSUPPORTED, DFE_BADDDLIST
      integer   DFE_NOTDFFILE, DFE_SEEDTWICE,   DFE_NOSPACE
      integer   DFE_NOSUCHTAG, DFE_READERROR
 
      parameter(dfe_noerror      =   0)
      parameter(dfe_none         =   0)
      parameter(dfe_fnf          =  -1)
      parameter(dfe_denied       =  -2)
      parameter(dfe_alropen      =  -3)
      parameter(dfe_toomany      =  -4)
      parameter(dfe_badname      =  -5)
      parameter(dfe_badacc       =  -6)
      parameter(dfe_badopen      =  -7)
      parameter(dfe_notopen      =  -8)
      parameter(dfe_cantclose    =  -9)
      parameter(dfe_dfnull       = -10)
      parameter(dfe_illtype      = -11)
      parameter(dfe_unsupported  = -12)
      parameter(dfe_badddlist    = -13)
      parameter(dfe_notdffile    = -14)
      parameter(dfe_seedtwice    = -15)
      parameter(dfe_nospace      = -16)
      parameter(dfe_nosuchtag    = -17)
      parameter(dfe_readerror    = -18)
 
      integer DFE_WRITEERROR,  DFE_SEEKERROR,   DFE_NOFREEDD
      integer   DFE_BADTAG,      DFE_BADREF,      DFE_RDONLY
      integer   DFE_BADCALL,     DFE_BADPTR,      DFE_BADLEN
      integer   DFE_BADSEEK,     DFE_NOMATCH,     DFE_NOTINSET
      integer   DFE_BADDIM,      DFE_BADOFFSET,   DFE_BADSCHEME
      integer   DFE_NODIM,       DFE_NOTENOUGH,   DFE_NOVALS
      integer   DFE_CORRUPT,     DFE_BADFP
 
      parameter(dfe_writeerror           = -19)
      parameter(dfe_seekerror            = -20)
      parameter(dfe_nofreedd             = -21)
      parameter(dfe_badtag               = -22)
      parameter(dfe_badref               = -23)
      parameter(dfe_rdonly               = -24)
      parameter(dfe_badcall              = -25)
      parameter(dfe_badptr               = -26)
      parameter(dfe_badlen               = -27)
      parameter(dfe_badseek              = -28)
      parameter(dfe_nomatch              = -29)
      parameter(dfe_notinset             = -30)
      parameter(dfe_baddim               = -31)
      parameter(dfe_badoffset            = -32)
      parameter(dfe_badscheme            = -33)
      parameter(dfe_nodim                = -34)
      parameter(dfe_notenough            = -35)
      parameter(dfe_novals               = -36)
      parameter(dfe_corrupt              = -37)
      parameter(dfe_badfp                = -38)
 
      integer DFE_NOREF,       DFE_BADDATATYPE, DFE_BADMCTYPE
      integer   DFE_BADNUMTYPE,  DFE_BADORDER,    DFE_ARGS
      integer   DFE_INTERNAL,    DFE_DUPDD,       DFE_CANTMOD
      integer   DFE_RANGE,       DFE_BADTABLE,    DFE_BADSDG
      integer   DFE_BADNDG,      DFE_BADFIELDS,   DFE_NORESET
      integer   DFE_NOVS,        DFE_VGSIZE,      DFE_DIFFFILES
      integer   DFE_VTAB,        DFE_BADAID
 
      parameter(dfe_noref                = -39)
      parameter(dfe_baddatatype          = -40)
      parameter(dfe_badmctype            = -41)
      parameter(dfe_badnumtype           = -42)
      parameter(dfe_badorder             = -43)
      parameter(dfe_args                 = -44)
      parameter(dfe_internal             = -45)
      parameter(dfe_dupdd                = -46)
      parameter(dfe_cantmod              = -47)
      parameter(dfe_range                = -48)
      parameter(dfe_badtable             = -49)
      parameter(dfe_badsdg               = -50)
      parameter(dfe_badndg               = -51)
      parameter(dfe_badfields            = -52)
      parameter(dfe_noreset              = -53)
      parameter(dfe_novs                 = -54)
      parameter(dfe_vgsize               = -55)
      parameter(dfe_difffiles            = -56)
      parameter(dfe_vtab                 = -57)
      parameter(dfe_badaid               = -58)
 
      integer   DFE_OPENAID, DFE_BADCONV, DFE_GENAPP, DFE_CANTFLUSH
      integer   DFE_BADTYPE, DFE_SYMSIZE, DFE_BADATTACH
      integer   DFE_CANTDETACH
 
      parameter(dfe_openaid              = -59)
      parameter(dfe_badconv              = -60)
      parameter(dfe_genapp               = -61)
      parameter(dfe_cantflush            = -62)
      parameter(dfe_badtype              = -63)
      parameter(dfe_symsize              = -64)
      parameter(dfe_badattach            = -65)
      parameter(dfe_cantdetach           = -66)
 
! internal file access codes
 
      integer DFACC_READ, DFACC_WRITE, DFACC_CREATE, DFACC_ALL  
      integer DFACC_RDONLY, DFACC_RDWR, DFACC_CLOBBER
 
      parameter(dfacc_read               = 1)
      parameter(dfacc_write              = 2)
      parameter(dfacc_create             = 4)
      parameter(dfacc_all                = 7)
      parameter(dfacc_rdonly             = 1)
      parameter(dfacc_rdwr               = 3)
      parameter(dfacc_clobber            = 4)
 
! Access types for SDsetaccesstype
 
      integer DFACC_DEFAULT, DFACC_SERIAL, DFACC_PARALLEL
      parameter(dfacc_default           = 0)
      parameter(dfacc_serial            = 1)
      parameter(dfacc_parallel          = 9)
 
! Constants for DFSDsetorder
 
      integer DFO_FORTRAN, DFO_C
 
      parameter(dfo_fortran            = 1)
      parameter(dfo_c                  = 2)
 
! Definitions of storage convention
 
      integer DFNTF_IEEE, DFNTF_VAX, DFNTF_CRAY, DFNTF_PC
      integer   DFNTF_CONVEX, DFNTF_VP
 
      parameter(dfntf_ieee             = 1)
      parameter(dfntf_vax              = 2)
      parameter(dfntf_cray             = 3)
      parameter(dfntf_pc               = 4)
      parameter(dfntf_convex           = 5)
      parameter(dfntf_vp               = 6)
 
!       Masks for types
 
      integer   DFNT_HDF, DFNT_NATIVE, DFNT_CUSTOM, DFNT_LITEND
 
      parameter(dfnt_hdf                 = 0)
      parameter(dfnt_native              = 4096)
      parameter(dfnt_custom              = 8192)
      parameter(dfnt_litend              = 16384)
 
! Number type info codes 
 
      integer DFNT_NONE, DFNT_QUERY, DFNT_VERSION
 
      parameter(dfnt_none       = 0)
      parameter(dfnt_query      = 0)
      parameter(dfnt_version    = 1)
      
      integer   DFNT_FLOAT32, DFNT_FLOAT, DFNT_FLOAT64
      integer   DFNT_DOUBLE,  DFNT_FLOAT128
 
      parameter(dfnt_float32    = 5)
      parameter(dfnt_float      = 5)
      parameter(dfnt_float64    = 6)
      parameter(dfnt_double     = 6)
      parameter(dfnt_float128   = 7)
 
      integer   DFNT_INT8,  DFNT_UINT8
      integer   DFNT_INT16, DFNT_UINT16
      integer   DFNT_INT32, DFNT_UINT32
      integer   DFNT_INT64, DFNT_UINT64
      integer   DFNT_INT128,DFNT_UINT128
 
      parameter(dfnt_int8       = 20)
      parameter(dfnt_uint8      = 21)
      parameter(dfnt_int16      = 22)
      parameter(dfnt_uint16     = 23)
      parameter(dfnt_int32      = 24)
      parameter(dfnt_uint32     = 25)
      parameter(dfnt_int64      = 26)
      parameter(dfnt_uint64     = 27)
      parameter(dfnt_int128     = 28)
      parameter(dfnt_uint128    = 29)
 
      integer  DFNT_UCHAR8, DFNT_UCHAR, DFNT_CHAR8
      integer  DFNT_CHAR,   DFNT_CHAR16, DFNT_UCHAR16
 
      parameter(dfnt_uchar8     = 3)
      parameter(dfnt_uchar      = 3)
      parameter(dfnt_char8      = 4)
      parameter(dfnt_char       = 4)
      parameter(dfnt_char16     = 42)
      parameter(dfnt_uchar16    = 43)
 
      integer DFNT_NFLOAT32, DFNT_NFLOAT, DFNT_NFLOAT64
      integer DFNT_NDOUBLE,  DFNT_NFLOAT128
 
      parameter(dfnt_nfloat32   = 4101)
      parameter(dfnt_nfloat     = 4101)
      parameter(dfnt_nfloat64   = 4102)
      parameter(dfnt_ndouble    = 4102)
      parameter(dfnt_nfloat128  = 4103)
 
      integer    DFNT_NINT8,  DFNT_NUINT8
      integer    DFNT_NINT16, DFNT_NUINT16
      integer    DFNT_NINT32, DFNT_NUINT32
      integer    DFNT_NINT64, DFNT_NUINT64
      integer    DFNT_NINT128,DFNT_NUINT128
 
      parameter(dfnt_nint8       = 4116)
      parameter(dfnt_nuint8      = 4117)
      parameter(dfnt_nint16      = 4118)
      parameter(dfnt_nuint16     = 4119)
      parameter(dfnt_nint32      = 4120)
      parameter(dfnt_nuint32     = 4121)
      parameter(dfnt_nint64      = 4122)
      parameter(dfnt_nuint64     = 4123)
      parameter(dfnt_nint128     = 4124)
      parameter(dfnt_nuint128    = 4125)
 
      integer DFNT_NUCHAR8, DFNT_NUCHAR, DFNT_NCHAR8
      integer DFNT_NCHAR,   DFNT_NCHAR16, DFNT_NUCHAR16
 
      parameter(dfnt_nuchar8  = 4099)
      parameter(dfnt_nuchar   = 4099)
      parameter(dfnt_nchar8   = 4100)
      parameter(dfnt_nchar    = 4100)
      parameter(dfnt_nchar16  = 4138)
      parameter(dfnt_nuchar16 = 4139)
 
      integer DFNT_LFLOAT32, DFNT_LFLOAT, DFNT_LFLOAT64
      integer DFNT_LDOUBLE,  DFNT_LFLOAT128
 
      parameter(dfnt_lfloat32  = 16389)
      parameter(dfnt_lfloat    = 16389)
      parameter(dfnt_lfloat64  = 16390)
      parameter(dfnt_ldouble   = 16390)
      parameter(dfnt_lfloat128 = 16391)
 
      integer   DFNT_LINT8,DFNT_LUINT8,DFNT_LINT16,DFNT_LUINT16
      integer   DFNT_LINT32,DFNT_LUINT32,DFNT_LINT64,DFNT_LUINT64
      integer   DFNT_LINT128,DFNT_LUINT128
 
      parameter(dfnt_lint8      = 16404)
      parameter(dfnt_luint8     = 16405)
      parameter(dfnt_lint16     = 16406)
      parameter(dfnt_luint16    = 16407)
      parameter(dfnt_lint32     = 16408)
      parameter(dfnt_luint32    = 16409)
      parameter(dfnt_lint64     = 16410)
      parameter(dfnt_luint64    = 16411)
      parameter(dfnt_lint128    = 16412)
      parameter(dfnt_luint128   = 16413)
 
      integer DFNT_LUCHAR8, DFNT_LUCHAR, DFNT_LCHAR8
      integer DFNT_LCHAR,   DFNT_LCHAR16, DFNT_LUCHAR16
 
      parameter(dfnt_luchar8    = 16387)
      parameter(dfnt_luchar     = 16387)
      parameter(dfnt_lchar8     = 16388)
      parameter(dfnt_lchar      = 16388)
      parameter(dfnt_lchar16    = 16426)
      parameter(dfnt_luchar16   = 16427)
 
! tags and refs
 
      integer DFREF_WILDCARD, DFTAG_WILDCARD, DFTAG_NULL
      integer DFTAG_LINKED, DFTAG_VERSION, DFTAG_COMPRESSED
 
      parameter(dfref_wildcard  = 0, dftag_wildcard  = 0)
      parameter(dftag_null      = 1, dftag_linked    = 20)
      parameter(dftag_version   = 30,dftag_compressed = 40)
 
 
! utility set
 
      integer DFTAG_FID, DFTAG_FD,  DFTAG_TID, DFTAG_TD
      integer DFTAG_DIL, DFTAG_DIA, DFTAG_NT,  DFTAG_MT
 
      parameter(dftag_fid       = 100, dftag_fd        = 101)
      parameter(dftag_tid       = 102, dftag_td        = 103)
      parameter(dftag_dil       = 104, dftag_dia       = 105)
      parameter(dftag_nt        = 106, dftag_mt        = 107)
 
!  raster-8 set 
 
      integer DFTAG_ID8, DFTAG_IP8, DFTAG_RI8
      integer DFTAG_CI8, DFTAG_II8
 
      parameter(dftag_id8       = 200, dftag_ip8       = 201)
      parameter(dftag_ri8       = 202, dftag_ci8       = 203)
      parameter(dftag_ii8       = 204)
 
! Raster Image set
 
      integer DFTAG_ID, DFTAG_LUT, DFTAG_RI, DFTAG_CI
 
      parameter(dftag_id        = 300, dftag_lut       = 301)
      parameter(dftag_ri        = 302, dftag_ci        = 303)
 
      integer DFTAG_RIG, DFTAG_LD,  DFTAG_MD, DFTAG_MA
      integer DFTAG_CCN, DFTAG_CFM, DFTAG_AR
  
      parameter(dftag_rig       = 306, dftag_ld        = 307)
      parameter(dftag_md        = 308, dftag_ma        = 309)
      parameter(dftag_ccn       = 310, dftag_cfm       = 311)
      parameter(dftag_ar        = 312)
 
      integer DFTAG_DRAW, DFTAG_RUN, DFTAG_XYP, DFTAG_MTO
 
      parameter(dftag_draw      = 400, dftag_run       = 401)
      parameter(dftag_xyp       = 500, dftag_mto       = 501)
 
! Tektronix 
 
      integer DFTAG_T14, DFTAG_T105
 
      parameter(dftag_t14       = 602, dftag_t105      = 603)
 
! Scientific Data set 
 
      integer   DFTAG_SDG, DFTAG_SDD, DFTAG_SD, DFTAG_SDS, DFTAG_SDL
      integer   DFTAG_SDU, DFTAG_SDF, DFTAG_SDM, DFTAG_SDC
      integer   DFTAG_SDT,DFTAG_SDLNK,DFTAG_NDG
      integer   DFTAG_BREQ,DFTAG_EREQ,DFTAG_CAL, DFTAG_FV
 
      parameter(dftag_sdg       = 700, dftag_sdd       = 701)
      parameter(dftag_sd        = 702, dftag_sds       = 703)
      parameter(dftag_sdl       = 704, dftag_sdu       = 705)
      parameter(dftag_sdf       = 706, dftag_sdm       = 707)
      parameter(dftag_sdc       = 708, dftag_sdt       = 709)
      parameter(dftag_sdlnk     = 710, dftag_ndg       = 720)
      parameter(dftag_cal       = 731, dftag_fv        = 732)
      parameter(dftag_breq      = 799, dftag_ereq      = 780)
 
! VSets 
 
      integer DFTAG_VG, DFTAG_VH, DFTAG_VS
 
      parameter(dftag_vg        = 1965, dftag_vh        = 1962)
      parameter(dftag_vs        = 1963)
 
! compression schemes 
 
      integer DFTAG_RLE, DFTAG_IMC, DFTAG_IMCOMP, DFTAG_JPEG
      integer   DFTAG_GREYJPEG
 
      parameter(dftag_rle       =11, dftag_imc       =12)
      parameter(dftag_imcomp   =12, dftag_jpeg      =13)
      parameter(dftag_greyjpeg =14)
 
! SPECIAL CODES 
 
      integer SPECIAL_LINKED, SPECIAL_EXT
 
      parameter(special_linked = 1, special_ext = 2)
 
! PARAMETERS 
 
      integer DF_MAXFNLEN
      integer   SD_UNLIMITED
      integer   SD_DIMVAL_BW_COMP
      integer   SD_DIMVAL_BW_INCOMP 
      integer   SD_FILL
      integer   SD_NOFILL
 
      parameter(df_maxfnlen     = 256, sd_unlimited    = 0)
      parameter(sd_dimval_bw_comp = 1, sd_dimval_bw_incomp = 0)
      parameter(sd_fill           = 0, sd_nofill = 256)
 
      integer   HDF_VDATA
      
      parameter(hdf_vdata = -1)
 
!       Standard return codes       
      integer SUCCEED, FAIL  
 
      parameter(succeed         = 0, fail     = -1)
 
 
! Compression Types 
 
      integer COMP_NONE, COMP_RLE, COMP_IMCOMP, COMP_JPEG
 
      parameter(comp_none       = 0, comp_rle        = 11)
      parameter(comp_imcomp     = 12, comp_jpeg       = 2)
!
!       Fortran chunking (SD and GR interfaces) and compression routines use
!       the following compression types:
!
      integer COMP_CODE_NONE, COMP_CODE_RLE, COMP_CODE_NBIT
      integer COMP_CODE_SKPHUFF, COMP_CODE_DEFLATE
      integer COMP_CODE_JPEG
      integer COMP_CODE_SZIP
      integer SZ_EC_OPTION_MASK, SZ_NN_OPTION_MASK
      integer COMP_DECODER_ENABLED, COMP_ENCODER_ENABLED
      parameter(comp_code_none = 0)
      parameter(comp_code_rle  = 1)
      parameter(comp_code_nbit = 2)
      parameter(comp_code_skphuff = 3)
      parameter(comp_code_deflate = 4)
      parameter(comp_code_szip = 5)
      parameter(comp_code_jpeg = 6)
!
!     SZIP parameters
!
      parameter(sz_ec_option_mask = 4)
      parameter(sz_nn_option_mask = 32)
      parameter(comp_decoder_enabled = 1)
      parameter(comp_encoder_enabled = 2)
!
! Interlace Types 
 
      integer MFGR_INTERLACE_PIXEL, MFGR_INTERLACE_LINE
      integer   MFGR_INTERLACE_COMPONENT
 
      parameter(mfgr_interlace_pixel    = 0)
      parameter(mfgr_interlace_line     = 1)
      parameter(mfgr_interlace_component= 2)
 
      integer FULL_INTERLACE, NO_INTERLACE
 
      parameter(full_interlace = 0, no_interlace = 1)
 
!       Vdata fields packing types
      integer   HDF_VSPACK, HDF_VSUNPACK
      parameter(hdf_vspack   = 0, hdf_vsunpack = 1)
 
!    Multi-file Annotation types
      integer AN_DATA_LABEL, AN_DATA_DESC, AN_FILE_LABEL, AN_FILE_DESC
 
      parameter(an_data_label = 0, an_data_desc  = 1)
      parameter(an_file_label = 2, an_file_desc  = 3)
 
!******************End of hdf.inc***************************