isetprm.F

Go to the documentation of this file.

C> @file
C> @brief Define a customized parameter value for dynamic allocation.

C> This function sets a specified parameter to a specified value for
C> use in dynamically allocating one or more internal arrays within
C> the BUFRLIB software.
C>
C> <p>This function should only be called if a dynamic allocation
C> build of the software is being used.  A separate call to this
C> function must be made for each parameter that is to be set to a
C> customized value, and all such calls must be made prior to the
C> first call to subroutine openbf() from within an application
C> program, because that is when all internal arrays are dynamically
C> allocated based on the parameter values in effect at the time.
C> Otherwise, if this function is never called for a particular
C> parameter, then an internal default value for that parameter is
C> used instead.
C>
C> @author J. Ator
C> @date 2014-12-04
C>
C> @param[in] CPRMNM - character*(*): Parameter to be changed from its
C>                     internal default value
C>                    - 'MXMSGL' = Maximum length (in bytes) of a BUFR
C>                                 message
C>                    - 'MAXSS'  = Maximum number of data values in an
C>                                 uncompressed BUFR subset
C>                    - 'MXCDV'  = Maximum number of data values that
C>                                 can be written into a compressed BUFR
C>                                 subset
C>                    - 'MXLCC'  = Maximum length (in bytes) of a
C>                                 character string that can be written
C>                                 into a compressed BUFR subset
C>                    - 'MXCSB'  = Maximum number of subsets that can be
C>                                 written into a compressed BUFR
C>                                 message
C>                    - 'NFILES' = Maximum number of BUFR files that can
C>                                 be accessed for reading or writing at
C>                                 any one time
C>                    - 'MAXTBA' = Maximum number of entries in internal
C>                                 BUFR Table A per BUFR file
C>                    - 'MAXTBB' = Maximum number of entries in internal
C>                                 BUFR Table B per BUFR file
C>                    - 'MAXTBD' = Maximum number of entries in internal
C>                                 BUFR Table D per BUFR file
C>                    - 'MAXMEM' = Maximum number of bytes that can be
C>                                 used to store BUFR messages in
C>                                 internal memory
C>                    - 'MAXMSG' = Maximum number of BUFR messages that
C>                                 can be stored in internal memory
C>                    - 'MXDXTS' = Maximum number of dictionary tables
C>                                 that can be stored for use with BUFR
C>                                 messages in internal memory
C>                    - 'MXMTBB' = Maximum number of master Table B
C>                                 entries
C>                    - 'MXMTBD' = Maximum number of master Table D
C>                                 entries
C>                    - 'MXMTBF' = Maximum number of master Code/Flag
C>                                 entries
C>                    - 'MAXCD'  = Maximum number of child descriptors
C>                                 in a Table D descriptor sequence
C>                                 definition
C>                    - 'MAXJL'  = Maximum number of entries in the
C>                                 internal jump/link table
C>                    - 'MXS01V' = Maximum number of default Section 0
C>                                 or Section 1 values that can be
C>                                 overwritten within an output BUFR
C>                                 message
C>                    - 'MXBTM'  = Maximum number of bitmaps that can be
C>                     stored internally for a BUFR subset
C>                    - 'MXBTMSE' = Maximum number of entries that can
C>                      be set within a bitmap
C>                    - 'MXTAMC' = Maximum number of Table A mnemonics
C>                                 in the internal jump/link table which
C>                                 contain at least one Table C operator
C>                                 with XX >= 21 in their subset definition
C>                    - 'MXTCO'  = Maximum number of Table C operators
C>                                 with XX >= 21 in the subset definition
C>                                 of a Table A mnemonic
C>                    - 'MXNRV'  = Maximum number of 2-03 reference
C>                     values in the internal jump/link
C>                                 table
C>                    - 'MXRST'  = Maximum number of long character
C>                                 strings that can be read from a
C>                                 compressed subset
C> @param[in] IPVAL - integer: Value to be set for CPRMNM
C>
C> @returns  isetprm  - integer: return code
C>                      -  0 = normal return
C>                      - -1 = Unknown CPRMNM, or dynamic allocation
C>                             not in effect for this build of the
C>                             library
C>
C> <b>Program history log:</b>
C> - 2014-12-04  J. Ator    -- Original author
C> - 2016-05-24  J. Ator    -- Add MXNRV, MXBTM, MXBTMSE, MXTCO
C> - 2017-04-03  J. Ator    -- Add MXTAMC
C> - 2017-05-22  J. Ator    -- Add MXRST
C> - 2017-10-17  J. Ator    -- Add MXMTBF
C>
    INTEGER FUNCTION isetprm ( CPRMNM, IPVAL )

    USE modv_maxss
    USE modv_nfiles
    USE modv_mxmsgl
    USE modv_mxdxts
    USE modv_maxmsg
    USE modv_maxmem
    USE modv_maxtba
    USE modv_maxtbb
    USE modv_maxtbd
    USE modv_maxjl
    USE modv_mxcdv
    USE modv_mxlcc
    USE modv_mxcsb
    USE modv_mxmtbb
    USE modv_mxmtbd
    USE modv_mxmtbf
    USE modv_maxcd
    USE modv_mxs01v
    USE modv_mxbtm
    USE modv_mxbtmse
    USE modv_mxtamc
    USE modv_mxtco
    USE modv_mxnrv
    USE modv_mxrst

    character*(*)   cprmnm
    character*128   errstr

C-----------------------------------------------------------------------
C-----------------------------------------------------------------------

#ifdef DYNAMIC_ALLOCATION
    isetprm = 0
    IF ( cprmnm .EQ. 'MAXSS' ) THEN
        maxss = ipval
    ELSE IF ( cprmnm .EQ. 'NFILES' ) THEN
        nfiles = ipval
    ELSE IF ( cprmnm .EQ. 'MXMSGL' ) THEN
        mxmsgl = ipval
    ELSE IF ( cprmnm .EQ. 'MXDXTS' ) THEN
        mxdxts = ipval
    ELSE IF ( cprmnm .EQ. 'MAXMSG' ) THEN
        maxmsg = ipval
    ELSE IF ( cprmnm .EQ. 'MAXMEM' ) THEN
        maxmem = ipval
    ELSE IF ( cprmnm .EQ. 'MAXTBA' ) THEN
        maxtba = ipval
    ELSE IF ( cprmnm .EQ. 'MAXTBB' ) THEN
        maxtbb = ipval
    ELSE IF ( cprmnm .EQ. 'MAXTBD' ) THEN
        maxtbd = ipval
    ELSE IF ( cprmnm .EQ. 'MAXJL' ) THEN
        maxjl = ipval
    ELSE IF ( cprmnm .EQ. 'MXCDV' ) THEN
        mxcdv = ipval
    ELSE IF ( cprmnm .EQ. 'MXLCC' ) THEN
        mxlcc = ipval
    ELSE IF ( cprmnm .EQ. 'MXCSB' ) THEN
        mxcsb = ipval
    ELSE IF ( cprmnm .EQ. 'MXMTBB' ) THEN
        mxmtbb = ipval
    ELSE IF ( cprmnm .EQ. 'MXMTBD' ) THEN
        mxmtbd = ipval
    ELSE IF ( cprmnm .EQ. 'MXMTBF' ) THEN
        mxmtbf = ipval
    ELSE IF ( cprmnm .EQ. 'MAXCD' ) THEN
        maxcd = ipval
    ELSE IF ( cprmnm .EQ. 'MXS01V' ) THEN
        mxs01v = ipval
    ELSE IF ( cprmnm .EQ. 'MXBTM' ) THEN
        mxbtm = ipval
    ELSE IF ( cprmnm .EQ. 'MXBTMSE' ) THEN
        mxbtmse = ipval
    ELSE IF ( cprmnm .EQ. 'MXTAMC' ) THEN
        mxtamc = ipval
    ELSE IF ( cprmnm .EQ. 'MXTCO' ) THEN
        mxtco = ipval
    ELSE IF ( cprmnm .EQ. 'MXNRV' ) THEN
        mxnrv = ipval
    ELSE IF ( cprmnm .EQ. 'MXRST' ) THEN
        mxrst = ipval
    ELSE
        isetprm = -1
        CALL errwrt('++++++++++++++++++WARNING+++++++++++++++++++')
        errstr = 'BUFRLIB: ISETPRM - UNKNOWN INPUT PARAMETER '//
     .      cprmnm // ' -- NO ACTION WAS TAKEN'
        CALL errwrt(errstr)
        CALL errwrt('++++++++++++++++++WARNING+++++++++++++++++++')
    ENDIF
#else
    isetprm = -1
    CALL errwrt('++++++++++++++++++++WARNING+++++++++++++++++++++')
    errstr = 'BUFRLIB: ISETPRM - DYNAMIC MEMORY ALLOCATION IS '//
     .      'NOT SUPPORTED FOR THIS BUILD OF BUFRLIB'
    CALL errwrt(errstr)
    CALL errwrt('++++++++++++++++++++WARNING+++++++++++++++++++++')
#endif

    RETURN
    END