gets1loc.f

Go to the documentation of this file.

C> @file
C> @author ATOR @date 2005-11-29
      
C> THIS SUBROUTINE RETURNS THE LOCATION (I.E. STARTING BYTE
C>   AND BIT WIDTH) OF A SPECIFIED VALUE WITHIN SECTION 1 OF A BUFR
C>   MESSAGE ENCODED ACCORDING TO A SPECIFIED BUFR EDITION.  IT WILL
C>   WORK ON ANY MESSAGE ENCODED USING BUFR EDITION 2, 3 OR 4.  THE
C>   VALUE FOR WHICH THE LOCATION IS TO BE DETERMINED IS SPECIFIED VIA
C>   THE MNEMONIC S1MNEM, AS EXPLAINED IN FURTHER DETAIL BELOW.
C>
C> PROGRAM HISTORY LOG:
C> 2005-11-29  J. ATOR    -- ORIGINAL AUTHOR
C> 2006-04-14  D. KEYSER  -- ADDED OPTIONS FOR 'YCEN' AND 'CENT'
C>
C> USAGE:    GETS1LOC ( S1MNEM, IBEN, ISBYT, IWID, IRET )
C>   INPUT ARGUMENT LIST:
C>     S1MNEM   - CHARACTER*(*): MNEMONIC SPECIFYING VALUE WHOSE
C>                LOCATION WITHIN SECTION 1 IS TO BE DETERMINED:
C>                  'LEN1'  = LENGTH (IN BYTES) OF SECTION 1
C>                  'BMT'   = BUFR MASTER TABLE 
C>                  'OGCE'  = ORIGINATING CENTER
C>                  'GSES'  = ORIGINATING SUBCENTER
C>                              (NOTE: THIS VALUE IS PRESENT ONLY IN
C>                                     BUFR EDITION 3 OR 4 MESSAGES!)
C>                  'USN'   = UPDATE SEQUENCE NUMBER 
C>                  'ISC2'  = FLAG INDICATING ABSENCE/PRESENCE OF
C>                            (OPTIONAL) SECTION 2 IN BUFR MESSAGE:
C>                              0 = SECTION 2 ABSENT
C>                              1 = SECTION 2 PRESENT
C>                  'MTYP'  = DATA CATEGORY 
C>                  'MSBTI' = DATA SUBCATEGORY (INTERNATIONAL)
C>                              (NOTE: THIS VALUE IS PRESENT ONLY IN
C>                                     BUFR EDITION 4 MESSAGES!)
C>                  'MSBT'  = DATA SUBCATEGORY (LOCAL)
C>                  'MTV'   = VERSION NUMBER OF MASTER TABLE
C>                  'MTVL'  = VERSION NUMBER OF LOCAL TABLES
C>                  'YCEN'  = YEAR OF CENTURY (1-100)
C>                              (NOTE: THIS VALUE IS PRESENT ONLY IN
C>                                     BUFR EDITION 2 AND 3 MESSAGES!)
C>                  'CENT'  = CENTURY (I.E., 20 FOR YEARS 1901-2000,
C>                                           21 FOR YEARS 2001-2100)
C>                              (NOTE: THIS VALUE *MAY* BE PRESENT IN
C>                                     BUFR EDITION 2 AND 3 MESSAGES,
C>                                     BUT IT IS NEVER PRESENT IN ANY
C>                                     BUFR EDITION 4 MESSAGES!)
C>                  'YEAR'  = YEAR (4-DIGIT)
C>                              (NOTE: THIS VALUE IS PRESENT ONLY IN
C>                                     BUFR EDITION 4 MESSAGES!)
C>                  'MNTH'  = MONTH
C>                  'DAYS'  = DAY
C>                  'HOUR'  = HOUR
C>                  'MINU'  = MINUTE
C>                  'SECO'  = SECOND
C>                              (NOTE: THIS VALUE IS PRESENT ONLY IN
C>                                     BUFR EDITION 4 MESSAGES!)
C>     IBEN     - INTEGER: BUFR EDITION NUMBER
C>
C>
C>   OUTPUT ARGUMENT LIST:
C>     ISBYT    - INTEGER: NUMBER OF STARTING BYTE WITHIN SECTION 1
C>                WHICH CONTAINS VALUE CORRESPONDING TO S1MNEM
C>                   (NOTE: ISBYT IS ALWAYS RETURNED AS 18 WHENEVER
C>                          S1MNEM = 'CENT' AND IBEN = 2 OR 3; IN SUCH
C>                          CASES IT IS THEN UP TO THE CALLING ROUTINE
C>                          TO DETERMINE WHETHER THIS LOCATION ACTUALLY
C>                          CONTAINS A VALID CENTURY VALUE!)
C>     IWID     - INTEGER: WIDTH (IN BITS) OF VALUE CORRESPONDING
C>                TO S1MNEM
C>     IRET     - INTEGER: RETURN CODE
C>                   0 = NORMAL RETURN
C>                  -1 = THE INPUT S1MNEM MNEMONIC IS INVALID FOR
C>                       BUFR EDITION IBEN
C>
C> REMARKS:
C>    THIS ROUTINE CALLS:        None
C>    THIS ROUTINE IS CALLED BY: CRBMG    IUPBS01  PKBS1
C>                               Normally not called by any application
C>                               programs.
C>
      SUBROUTINE gets1loc(S1MNEM,IBEN,ISBYT,IWID,IRET)



    character*(*)   s1mnem

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

    iret = 0
    iwid = 8

    IF(s1mnem.EQ.'LEN1') THEN
        isbyt = 1 
        iwid = 24 
    ELSE IF(s1mnem.EQ.'BMT') THEN
        isbyt = 4 
    ELSE IF(s1mnem.EQ.'OGCE') THEN
        IF(iben.EQ.3) THEN
        isbyt = 6 
        ELSE

C               Note that this location is actually the same for both
C               Edition 2 *and* Edition 4 of BUFR!

        isbyt = 5
        iwid = 16
        ENDIF
    ELSE IF(s1mnem.EQ.'GSES') THEN
        IF(iben.EQ.3) THEN
        isbyt = 5
        ELSE IF(iben.EQ.4) THEN
        isbyt = 7
        iwid = 16
        ELSE
        iret = -1
        ENDIF
    ELSE IF(s1mnem.EQ.'USN') THEN
        IF(iben.EQ.4) THEN
        isbyt = 9
        ELSE
        isbyt = 7
        ENDIF
    ELSE IF(s1mnem.EQ.'ISC2') THEN
        iwid = 1
        IF(iben.EQ.4) THEN
        isbyt = 10
        ELSE
        isbyt = 8
        ENDIF
    ELSE IF(s1mnem.EQ.'MTYP') THEN
        IF(iben.EQ.4) THEN
        isbyt = 11
        ELSE
        isbyt = 9
        ENDIF
    ELSE IF(s1mnem.EQ.'MSBTI') THEN
        IF(iben.EQ.4) THEN
            isbyt = 12 
        ELSE
        iret = -1
        ENDIF
    ELSE IF(s1mnem.EQ.'MSBT') THEN
        IF(iben.EQ.4) THEN
        isbyt = 13 
        ELSE
        isbyt = 10
        ENDIF
    ELSE IF(s1mnem.EQ.'MTV') THEN
        IF(iben.EQ.4) THEN
        isbyt = 14 
        ELSE
        isbyt = 11 
        ENDIF
    ELSE IF(s1mnem.EQ.'MTVL') THEN
        IF(iben.EQ.4) THEN
        isbyt = 15 
        ELSE
        isbyt = 12 
        ENDIF
    ELSE IF(s1mnem.EQ.'YEAR') THEN
        IF(iben.EQ.4) THEN
        isbyt = 16
        iwid = 16
        ELSE
        iret = -1
        ENDIF
    ELSE IF(s1mnem.EQ.'YCEN') THEN
        IF(iben.LT.4) THEN
        isbyt = 13
        ELSE
        iret = -1
        ENDIF
    ELSE IF(s1mnem.EQ.'CENT') THEN
        IF(iben.LT.4) THEN
        isbyt = 18
        ELSE
        iret = -1
        ENDIF
    ELSE IF(s1mnem.EQ.'MNTH') THEN
        IF(iben.EQ.4) THEN
        isbyt = 18 
        ELSE
        isbyt = 14 
        ENDIF
    ELSE IF(s1mnem.EQ.'DAYS') THEN
        IF(iben.EQ.4) THEN
        isbyt = 19 
        ELSE
        isbyt = 15 
        ENDIF
    ELSE IF(s1mnem.EQ.'HOUR') THEN
        IF(iben.EQ.4) THEN
        isbyt = 20 
        ELSE
        isbyt = 16 
        ENDIF
    ELSE IF(s1mnem.EQ.'MINU') THEN
        IF(iben.EQ.4) THEN
        isbyt = 21 
        ELSE
        isbyt = 17 
        ENDIF
    ELSE IF(s1mnem.EQ.'SECO') THEN
        IF(iben.EQ.4) THEN
        isbyt = 22 
        ELSE
        iret = -1 
        ENDIF
    ELSE
        iret = -1
    ENDIF

    RETURN
    END