NCEPLIBS BUFR

https://noaa-emc.github.io/NCEPLIBS-bufr/
Admin
NCEPLIBS BUFR is a comprehensive library containing subroutines and functions for reading and...
Tokens:801,607
Snippets:7,766
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install NCEPLIBS-bufr

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/index.html

Clone the repository, configure the build using CMake, build the library, run tests, and install. Use CMake options to customize the build.

```bash
git clone https://github.com/NOAA-EMC/NCEPLIBS-bufr
cmake -S NCEPLIBS-bufr -B NCEPLIBS-bufr/build
cmake --build NCEPLIBS-bufr/build
ctest --test-dir NCEPLIBS-bufr/build
cmake --install NCEPLIBS-bufr/build
```

--------------------------------

### get_inode_c

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/bufr__c2f__interface_8F90_source.html

Gets the BUFR node index for the start node of the subset.

```APIDOC
## get_inode_c

### Description
Get the bufr node idx for the start node of the subset.

### Signature
`subroutine, public get_inode_c(lun, start_node)`

### Parameters
- `lun` (integer) - Input: Fortran logical unit number.
- `start_node` (integer) - Output: The BUFR node index for the start node.
```

--------------------------------

### get_inode_f

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/bufr__interface_8h_source.html

Get the bufr node idx for the start node of the subset.

```APIDOC
## get_inode_f

### Description
Get the bufr node idx for the start node of the subset.

### Signature
```c
void get_inode_f(int lun, int *start_node)
```
```

--------------------------------

### openbf_c

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/bufr__c2f__interface_8F90_source.html

Connects a new file to the library, initializes the library, or changes verbosity.

```APIDOC
## openbf_c

### Description
Connect a new file to the library, or initialize the library, or change verbosity associated with all BUFR library calls.

### Signature
`recursive subroutine, public openbf_c(bufr_unit, cio, table_file_id)`

### Parameters
- `bufr_unit` (integer) - Input/Output: Fortran logical unit number for the BUFR file.
- `cio` (integer) - Input: Controls the library's I/O mode (e.g., read, write).
- `table_file_id` (integer) - Input: Identifier for the table file to be used.
```

--------------------------------

### bufr_c2f_interface::get_inode_c

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/bufr__c2f__interface_8F90.html

Gets the bufr node index for the start node of the subset.

```APIDOC
## bufr_c2f_interface::get_inode_c

### Description
Gets the bufr node index for the start node of the subset.

### Method
subroutine, public

### Parameters
- **lun** (type) - Description
- **start_node** (type) - Description
```

--------------------------------

### openbf_c

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/namespacebufr__c2f__interface.html

Connects a new file to the library, initializes the library, or changes verbosity for an already connected file. Wraps the openbf() subroutine.

```APIDOC
## openbf_c()

### Description
Connects a new file to the library, or initializes the library, or changes verbosity associated with already-connected file. Wraps openbf() subroutine.

### Parameters
- **bufr_unit** (integer(c_int)) - Fortran logical unit number
- **cio** (character(kind=c_char), dimension(*)) - cio string
- **table_file_id** (integer(c_int)) - table_file unit number
```

--------------------------------

### Open and Initialize BUFR File

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/readbp_8F90_source.html

Opens the specified BUFR file for unformatted input and initializes the BUFR library for reading. Ensures the file exists before proceeding.

```fortran
narg=0
if(file=='nofile') goto 1
file = trim(adjustl(file))
inquire(file=file,exist=exist)
if (.not.exist) then
print *, trim(file)//' does not exist'
stop 3
endif

open(lubfr,file=file,form='unformatted')
call openbf(lubfr,'IN',lubfr)
call datelen(10)
```

--------------------------------

### Get Data Window (getwin)

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/jumplink_8F90_source.html

Determines the start (`iwin`) and end (`jwin`) indices for a data window associated with a given node and logical unit. Handles cases with and without RPC information, and reports errors if brackets are missing.

```Fortran
subroutine getwin(node,lun,iwin,jwin)

1327 subroutine getwin(node,lun,iwin,jwin)
1328
1329 use moda_usrint
1330
1331 implicit none
1332
1333 integer, intent(in) :: node, lun
1334 integer, intent(out) :: iwin, jwin
1335 integer irpc, lstjpb, invwin
1336
1337 character*128 bort_str
1338
1339 irpc = lstjpb(node,lun,'RPC')
1340
1341 if(irpc==0) then
1342 iwin = invwin(node,lun,jwin,nval(lun))
1343 if(iwin==0 .and. jwin>1) return
1344 iwin = 1
1345 jwin = nval(lun)
1346 return
1347 else
1348 iwin = invwin(irpc,lun,jwin,nval(lun))
1349 if(iwin==0) return
1350 if(val(iwin,lun)==0.) then
1351 iwin = 0
1352 return
1353 endif
1354 endif
1355
1356 jwin = invwin(irpc,lun,iwin+1,nval(lun))
1357 if(jwin==0) then
1358 write(bort_str,'("BUFRLIB: GETWIN - SEARCHED BETWEEN",I5," AND",I5,", MISSING BRACKET")') iwin+1, nval(lun)
1359 call bort(bort_str)
1360 endif
1361
1362 return
1363 end subroutine getwin
```

--------------------------------

### Fortran: Get Next Table Line

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/mastertable_8F90_source.html

Reads a line from a specified logical unit (lunt). It returns 0 if a valid line is read, and -1 if the end of the file is reached or an I/O error occurs. Lines starting with '#' or empty lines are skipped.

```fortran
integer function igetntbl ( lunt, line ) result ( iret )

implicit none

integer, intent(in) :: lunt
integer ier

character*(*), intent(out) :: line

do while (.true.)
read ( lunt, '(A)', iostat = ier ) line
if ( ( ier /= 0 ) .or. ( line(1:3) == 'END' ) ) then
iret = -1
return
endif
if ( ( line /= ' ' ) .and. ( line(1:1) /= '#' ) ) then
iret = 0
return
endif
enddo
```

--------------------------------

### Initialize Share Table Info Module

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/debufr_8F90_source.html

Initializes variables within the Share_Table_Info module, including setting ludx and ltbd, and allocating tbldir_f.

```fortran
module share_table_info

character(len=:), allocatable :: tbldir_f

integer ltbd

integer ludx
end module share_table_info
```

--------------------------------

### bufrlib::inittbf_c

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/bufrlib_8F90_source.html

Initializes a BUFR table.

```APIDOC
## bufrlib::inittbf_c

### Description
Initializes a BUFR table.

### Definition
bufrlib.F90:216
```

--------------------------------

### Table B Descriptor Examples

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/md__home_runner_work_NCEPLIBS_bufr_NCEPLIBS_bufr_bufr_docs_master_tables.html

Illustrates the format of descriptor definition lines with example data. These examples show variations in whitespace usage.

```text
  0-01-018 |   0 |  0 |  40 | CCITT IA5   | SSTN    ; ; Short station or site name

```

```text
  0-01-041 |   5 | -1073741824 |  31 | m/s | PS00   ;  ; Absolute platform velocity - first component

```

```text
  0-05-002 |   2 |       -9000 |  15 | Degree(N+,S-)  | CLAT     ;     ; Latitude (coarse accuracy)

```

```text
  0-07-002 |  -1 |         -40 |  16 | m              | HMSL     ;     ; Height or altitude

```

--------------------------------

### Specific Function Examples

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/functions.html

Examples of specific functions available in NCEPLIBS-bufr.

```APIDOC
## Specific Function Examples

### Description
This section provides examples of documented functions.

### Functions
#### arallocc_c()
- **Namespace**: bufrlib
- **Description**: Allocates space for a BUFR message.

#### ardllocc_c()
- **Namespace**: bufrlib
- **Description**: Deallocates space for a BUFR message.

#### backbufr_c()
- **Namespace**: bufrlib
- **Description**: Moves the BUFR message pointer back.

#### bort_goto_target_c()
- **Namespace**: bufrlib
- **Description**: Moves the BUFR message pointer to a specified target.
```

--------------------------------

### openmg

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/bufr__c2f__interface_8F90_source.html

Opens and initializes a new BUFR message for eventual output.

```APIDOC
## openmg

### Description
Open and initialize a new BUFR message within internal arrays, for eventual output to logical unit lunit.

### Signature
```fortran
recursive subroutine openmg(lunit, subset, jdate)
```

### Parameters
- **lunit** (integer) - Input: Logical unit number for the output BUFR file.
- **subset** (integer) - Input: The data subset number to initialize.
- **jdate** (integer) - Input: The date associated with the BUFR message.
```

--------------------------------

### Global Functions/Subroutines Starting with 'a'

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/globals.html

This section lists global functions and subroutines that start with the letter 'a'.

```APIDOC
## adn30()

### Description
Provides functionality related to adn30.

### Source File
fxy.F90

## apxdx()

### Description
Provides functionality related to apxdx.

### Source File
apxdx.F90

## arallocc()

### Description
Provides functionality related to arallocc.

### Source Files
bufrlib.h, arallocc.c

## arallocf()

### Description
Provides functionality related to arallocf.

### Source File
arallocf.F90

## ardllocc()

### Description
Provides functionality related to ardllocc.

### Source Files
bufrlib.h, arallocc.c

## ardllocf()

### Description
Provides functionality related to ardllocf.

### Source File
arallocf.F90

## atrcpt()

### Description
Provides functionality related to atrcpt.

### Source File
tankrcpt.F90

## atrcpt_f()

### Description
Provides functionality related to atrcpt_f.

### Source File
bufr_interface.h
```

--------------------------------

### openbf_f

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/bufr__interface_8h_source.html

Connect a new file to the library, or initialize the library, or change verbosity associated with alr...

```APIDOC
## openbf_f

### Description
Connect a new file to the library, or initialize the library, or change verbosity associated with alr...

### Signature
```c
void openbf_f(int bufr_unit, const char *cio, int table_file_id)
```
```

--------------------------------

### get_inode_c

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/namespacebufr__c2f__interface.html

Retrieves the BUFR node index for the start node of a subset. It requires the file unit number and returns the start node index.

```APIDOC
## get_inode_c()

### Description
Get the bufr node idx for the start node of the subset.

### Parameters
- **lun** (integer(c_int)) - Required - File ID.
- **start_node** (integer(c_int)) - Output - The start node of the subset
```

--------------------------------

### ufbqcp()

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/cftbvs_8F90.html

Given an event program code (Y value) for a category 63 Table D descriptor from an NCEP prepbufr file, returns the corresponding mnemonic.

```APIDOC
## ufbqcp()

### Description
Given an event program code, which is equivalent to the Y value of a category 63 Table D descriptor from an NCEP prepbufr file, return the corresponding mnemonic. Logical unit lunit should have already been opened via a previous call to subroutine openbf(). This subroutine is the logical inverse of subroutine ufbqcd().

### Parameters
- **lunit** (integer, intent(in)) - Fortran logical unit number for NCEP prepbufr file
- **iqcp** (integer, intent(in)) - Y value of a category 63 (i.e. X=63) Table D descriptor

### Returns
- **nemo** (character*(*), intent(out)) - Mnemonic associated with iqcp
```

--------------------------------

### Get Next Table Index - igetntbi

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/dxtable_8F90_source.html

Gets the next available index for storing an entry within a specified internal DX BUFR table.

```fortran
integer function igetntbi(lun, ctb)
Get the next available index for storing an entry within a specified internal DX BUFR table.
**Definition:** dxtable.F90:1150
```

--------------------------------

### Initialize BUFR Processing Variables

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/debufr_8F90_source.html

Allocates and transfers C strings to Fortran strings for file paths and parameters. Opens output and null files, and sets up initial processing flags.

```Fortran
allocate( character(len=lenof) :: ofile_f )
ofile_f = transfer( ofile(1:lenof), ofile_f )
allocate( character(len=lentf) :: tblfil_f )
tblfil_f = transfer( tblfil(1:lentf), tblfil_f )
allocate( character(len=lenps) :: prmstg_f )
prmstg_f = transfer( prmstg(1:lenps), prmstg_f )
basic_f = transfer( basic(1:1), basic_f )
forcemt_f = transfer( forcemt(1:1), forcemt_f )
cfms_f = transfer( cfms(1:1), cfms_f )
```

```Fortran
open ( unit = 51, file = ofile_f )
lunit = 92
open ( unit = lunit, file = '/dev/null' )
```

```Fortran
nmsg = 0
nsubt = 0
opened = 'N'
usemt = 'N'
```

--------------------------------

### ufbqcp_f

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/bufr__interface_8h_source.html

Returns a mnemonic corresponding to a prepbufr program code.

```APIDOC
## ufbqcp_f

### Description
Return a mnemonic corresponding to a prepbufr program code.

### Signature
```fortran
void ufbqcp_f(int lunit, int iqcp, char *cnemo, int cnemo_len)
```

### Parameters
*   **lunit** (int) - The BUFR file unit.
*   **iqcp** (int) - The prepbufr program code.
*   **cnemo** (char *) - Buffer to store the mnemonic.
*   **cnemo_len** (int) - The length of the mnemonic buffer.
```

--------------------------------

### Global Functions/Subroutines starting with 'w'

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/globals_w.html

This section details global functions and subroutines within NCEPLIBS-bufr that start with the letter 'w'. It includes their names and the source files where they are defined.

```APIDOC
## Global Functions/Subroutines

### wrcmps()

- **Source File**: compress.F90

### wrdesc()

- **Source File**: restd.c

### wrdxtb()

- **Source File**: dxtable.F90

### wrdxtb_f()

- **Source File**: bufr_interface.h

### writcp()

- **Source File**: compress.F90

### writdx()

- **Source File**: dxtable.F90

### writlc()

- **Source File**: readwriteval.F90

### writlc_f()

- **Source File**: bufr_interface.h

### writsa()

- **Source File**: readwritesb.F90

### writsa_f()

- **Source File**: bufr_interface.h

### writsb()

- **Source File**: readwritesb.F90

### writsb_f()

- **Source File**: bufr_interface.h

### wrtree()

- **Source File**: readwritesb.F90

### wtstat()

- **Source File**: openclosebf.F90
```

--------------------------------

### Readbp Usage Information

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/md__home_runner_work_NCEPLIBS_bufr_NCEPLIBS_bufr_bufr_docs_utils.html

This displays the command-line usage for the readbp utility, outlining available options for filtering and printing prepBUFR reports.

```bash
Usage: readbp <-s> <-w> <-m> <-k> <-r> <-d> <-n> <-h>  prep bufrfile

 Search filter and/or print prepbufr reports in various ways

 -s "station_id " print reports where "station_id" matches the report id up to the len of "station_id"
 -w "x1 x2 y1 y2" print reports within a lon/lat box
 -m "subset     " print reports with this subset name
 -k "gsi  rtype " print reports with this gsi report type
 -r "on29 rtype " print reports with this on29 report type
 -d               print reports using ufdump - note: this works with any NCEP BUFR file
 -n               no pause between reports output
 -h               print only report headers

 Only a filename is required in which case step through the reports one at a time using "enter"
```

--------------------------------

### Global Functions Starting with 'g'

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/globals_g.html

This section lists and describes global functions in NCEPLIBS-bufr whose names start with the letter 'g'. These functions are available for direct use by library users.

```APIDOC
## Global Functions

### get_inode_f()

#### Description
Retrieves the inode information.

#### Declaration
`bufr_interface.h`

### get_inv_f()

#### Description
Retrieves the inversion information.

#### Declaration
`bufr_interface.h`

### get_irf_f()

#### Description
Retrieves the IRF information.

#### Declaration
`bufr_interface.h`

### get_isc_f()

#### Description
Retrieves the ISC information.

#### Declaration
`bufr_interface.h`

### get_itp_f()

#### Description
Retrieves the ITP information.

#### Declaration
`bufr_interface.h`

### get_jmpb_f()

#### Description
Retrieves the JMPB information.

#### Declaration
`bufr_interface.h`

### get_link_f()

#### Description
Retrieves link information.

#### Declaration
`bufr_interface.h`

### get_nval_f()

#### Description
Retrieves the number of values.

#### Declaration
`bufr_interface.h`

### get_tag_f()

#### Description
Retrieves tag information.

#### Declaration
`bufr_interface.h`

### get_typ_f()

#### Description
Retrieves type information.

#### Declaration
`bufr_interface.h`

### get_val_f()

#### Description
Retrieves value information.

#### Declaration
`bufr_interface.h`

### getabdb()

#### Description
Gets the ABDB data.

#### Declaration
`dumpdata.F90`

### getabdb_f()

#### Description
Gets the ABDB data (interface).

#### Declaration
`bufr_interface.h`

### getbmiss()

#### Description
Gets missing values.

#### Declaration
`missing.F90`

### getcfmng()

#### Description
Manages CFTBVs.

#### Declaration
`cftbvs.F90`

### getcfmng_f()

#### Description
Manages CFTBVs (interface).

#### Declaration
`bufr_interface.h`

### getlens()

#### Description
Gets the length of something.

#### Declaration
`readwritemg.F90`

### getntbe()

#### Description
Gets the number of tables.

#### Declaration
`mastertable.F90`

### gets1loc()

#### Description
Gets S1 location.

#### Declaration
`s013vals.F90`

### gettab()

#### Description
Gets table data.

#### Declaration
`gettab.F90`

### gettagpr()

#### Description
Gets tag properties.

#### Declaration
`jumplink.F90`

### gettagpr_f()

#### Description
Gets tag properties (interface).

#### Declaration
`bufr_interface.h`

### gettagre()

#### Description
Gets tag records.

#### Declaration
`bitmaps.F90`

### gettagre_f()

#### Description
Gets tag records (interface).

#### Declaration
`bufr_interface.h`

### gettbh()

#### Description
Gets table header.

#### Declaration
`mastertable.F90`

### getvalnb()

#### Description
Gets values by number.

#### Declaration
`readwriteval.F90`

### getvalnb_f()

#### Description
Gets values by number (interface).

#### Declaration
`bufr_interface.h`

### getwin()

#### Description
Gets window information.

#### Declaration
`jumplink.F90`
```

--------------------------------

### Initialize DX BUFR Dictionary Tables

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/dxtable_8F90.html

Initializes internal modules with DX BUFR dictionary tables, which are required for reading, writing, initializing, or appending BUFR files. Initialization can be from an external file, the current BUFR file, or another opened BUFR file.

```Fortran
subroutine readdx  ( | integer, intent(in)  | _lunit_ ,
|  | integer, intent(in)  | _lun_ ,
|  | integer, intent(in)  | _lundx_ 
| ) | |
```

--------------------------------

### Module Members starting with 'd'

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/namespacemembers_d.html

This section details functions and subroutines within the NCEPLIBS-bufr library whose names start with the letter 'd'. Each entry includes the function/subroutine name and the module it belongs to.

```APIDOC
## datebf_c()

### Description
Converts a date from BUFR format to a floating-point representation.

### Module
bufr_c2f_interface

## datelen_c()

### Description
Calculates the length of a date string in BUFR format.

### Module
bufr_c2f_interface

## delete_table_data_c()

### Description
Deletes table data from the BUFR library.

### Module
bufr_c2f_interface

## drfini_c()

### Description
Finalizes the DR (Data Representation) processing in BUFR.

### Module
bufr_c2f_interface

## dumpbf_c()

### Description
Dumps the contents of a BUFR message.

### Module
bufr_c2f_interface

## dxdump_c()

### Description
Dumps the contents of a DX (Data Exchange) BUFR message.

### Module
bufr_c2f_interface
```

--------------------------------

### Initialize BUFR Library and Set Table Directory

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/sinv_8F90_source.html

Initializes the BUFR library by setting it to partial read mode and defines the master table directory. It handles command-line arguments for the input file and an optional table directory.

```Fortran
program sinv

parameter(maxa=16000000)
parameter(maxs=1000)

character(255) file
character(240) cmtdir,tbldir
character(8) subset
character ci*16,cj*80
dimension isat(0:maxs,0:maxs)
real(8) said(2,maxa)
logical exist

data lunbf /20/

!-----------------------------------------------------------------------
!-----------------------------------------------------------------------

isat=0
jsat=0
said=0
ssid=0

call setpart(.true.) ! put ufbtab in partial read mode

! get filename argument

narg=command_argument_count()
if(narg<1) then
write(*,*)'Usage: sinv satbufrfile <tabledir> will print inventory of satbufrfile by platform and instrument'
stop 2
endif
call get_command_argument(1,file)
file = trim(adjustl(file))
inquire(file=file,exist=exist)
if (.not.exist) call bort(trim(file)//' does not exist')

! define master table directory

! Before calling mtinfo, make an initial call to openbf so that bfrini is called internally.
! Otherwise, if we wait until later to make the initial call to openbf, then the internal call
! to bfrini will end up overwriting the master table directory that we pass in during either
! of the following calls to mtinfo.
call openbf(lunbf,'FIRST',lunbf)
if(narg==2) then ! arg 2 would be a user defined table dir
call get_command_argument(2,tbldir)
call mtinfo(tbldir,3,4)
else ! otherwise default table dir is used
cmtdir = '/home/runner/work/NCEPLIBS-bufr/NCEPLIBS-bufr/bufr/build-doc' // &
's/install/tables'
call mtinfo(cmtdir,3,4) 
endif
```

--------------------------------

### Global Functions/Subroutines starting with 'g'

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/globals_func_g.html

This section details the global functions and subroutines available in the NCEPLIBS-bufr library whose names start with the letter 'g'. Each entry includes the function/subroutine name and the file where it is defined.

```APIDOC
## Global Functions/Subroutines starting with 'g'

### Description
This section lists global functions and subroutines available in the NCEPLIBS-bufr library that start with the letter 'g'.

### Functions/Subroutines
- **get_inode_f()** : bufr_interface.h
- **get_inv_f()** : bufr_interface.h
- **get_irf_f()** : bufr_interface.h
- **get_isc_f()** : bufr_interface.h
- **get_itp_f()** : bufr_interface.h
- **get_jmpb_f()** : bufr_interface.h
- **get_link_f()** : bufr_interface.h
- **get_nval_f()** : bufr_interface.h
- **get_tag_f()** : bufr_interface.h
- **get_typ_f()** : bufr_interface.h
- **get_val_f()** : bufr_interface.h
- **getabdb()** : dumpdata.F90
- **getabdb_f()** : bufr_interface.h
- **getbmiss()** : missing.F90
- **getcfmng()** : cftbvs.F90
- **getcfmng_f()** : bufr_interface.h
- **getlens()** : readwritemg.F90
- **getntbe()** : mastertable.F90
- **gets1loc()** : s013vals.F90
- **gettab()** : gettab.F90
- **gettagpr()** : jumplink.F90
- **gettagpr_f()** : bufr_interface.h
- **gettagre()** : bitmaps.F90
- **gettagre_f()** : bufr_interface.h
- **gettbh()** : mastertable.F90
- **getvalnb()** : readwriteval.F90
- **getvalnb_f()** : bufr_interface.h
- **getwin()** : jumplink.F90
```

--------------------------------

### bort_c()

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/namespacemembers_func.html

Initializes BUFR processing.

```APIDOC
## bort_c()

### Description
Initializes BUFR processing.

### Signature
bort_c()

### Module
bufr_c2f_interface
```

--------------------------------

### igetsd_c()

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/namespacemembers_func.html

Gets the status descriptor.

```APIDOC
## igetsd_c()

### Description
Gets the status descriptor.

### Signature
igetsd_c()

### Module
bufr_c2f_interface
```

--------------------------------

### Initialize BUFR Object Constructor

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/python/ncepbufr.html

Use this constructor to open BUFR files for reading, writing, or appending. Specify the mode and optionally a table file or an existing ncepbufr.open instance for table sharing.

```python
112    def __init__(self,filename,mode='r',table=None):
113        """
114        bufr object constructor
115
116        `filename`: bufr file name.
117
118        `mode`: `'r'` for read (default),
119                `'s'` for read using Section3,
120                `'w'` for write,
121                `'n'` for write but excluding table messages,
122                `'a'` for append
123
124        `table`:  bufr table filename or ncepbufr.open instance.
125        Must be specified for `mode='w'` or `mode='n'`, optional for `mode='r'`, `mode='s'` or `mode='a'`.
126        If table is an existing ncepbufr.open instance, the table
127        will be shared. If not, it is assumed to be the filename of a bufr table.
128        For `mode='r'`, bufr table embedded in file will be used if not specified.
129        For `mode='s'`, master bufr tables will be used.
130        """
131        # randomly choose available fortran unit number
132        self.lunit = random.choice(_funits)
133        self.filename = filename
134        '''bufr file opened with this fortran unit number'''
135        _funits.remove(self.lunit)
136        if not _funits:
137            raise IOError("too many files open")
138        if mode == 'r':
139            self._ioflag = 'IN'
140        elif mode == 's':
141            self._ioflag = 'SEC3'
142        elif mode == 'w' or mode == 'n':
143            if table is None:
144                msg="must specify file containing bufr table when mode='w' or `mode='n'"
145                raise ValueError(msg)
146            if mode == 'w':
147                self._ioflag = 'OUT'
148            else:
149                self._ioflag = 'NODX'
150        elif mode == 'a':
151            self._ioflag = 'APN'
152        else:
153            raise ValueError("mode must be 'r', 's', 'w', 'n', or 'a'")
154        if mode == 'r' or mode == 's' or mode == 'a':
155            if not os.path.isfile(filename):
156                msg='%s does not exist' % filename
157                raise IOError(msg)
158            iret = _bufrlib.fortran_open(filename,self.lunit,"unformatted","rewind")
159            if iret != 0:
160                msg='error opening %s' % filename
161                raise IOError(msg)
162            if table is None:
163                # table embedded in bufr file
164                _bufrlib.openbf(self.lunit,self._ioflag,self.lunit)
165                self.lundx = self.lunit # table unit number same as bufr unit number
166            else:
167                try:
168                    # share a bufr table with another instance
169                    self.lundx = table.lunit
170                except AttributeError:
171                    # external table file specified
172                    self.lundx = random.choice(_funits)
173                    iret = _bufrlib.fortran_open(table,self.lundx,"formatted","rewind")
174                    if iret != 0:
175                        msg='error opening %s' % filename
176                        raise IOError(msg)
177                    _funits.remove(self.lundx)
178                _bufrlib.openbf(self.lunit,self._ioflag,self.lundx)
179        elif mode == 'w' or mode == 'n':
180            try:
181                # share a bufr table with another instance
182                self.lundx = table.lunit
183            except AttributeError:
184                # read bufr table from a file.
185                self.lundx = random.choice(_funits)
186                iret = _bufrlib.fortran_open(table,self.lundx,"formatted","rewind")
187                if iret != 0:
188                    msg='error opening %s' % table
189                raise IOError(msg)
190                _funits.remove(self.lundx)
191            iret = _bufrlib.fortran_open(filename,self.lunit,"unformatted","rewind")
192            if iret != 0:
193                msg='error opening %s' % filename
194                raise IOError(msg)
195            _bufrlib.openbf(self.lunit,self._ioflag,self.lundx)
196        # initialized message number counter
197        self.msg_counter = 0
198        '''current bufr message number'''
199        self.msg_type = None
200        '''current bufr message type'''
201        self.msg_date = None
202        '''reference date for bufr message'''
203        self.receipt_time = None
204        '''tank receipt time for bufr message (`YYYYMMDDHHMM`), -1 if missing'''
205        self.subsets = None
206        '''number of subsets in the bufr message'''
207        # missing value in decoded data.
208        # (if equal to self.missing_value, data is masked)
209        self.missing_value = get_missing_value()
210        '''bufr missing value'''
```

--------------------------------

### igetprm_c()

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/namespacemembers_func.html

Gets a parameter value.

```APIDOC
## igetprm_c()

### Description
Gets a parameter value.

### Signature
igetprm_c()

### Module
bufr_c2f_interface
```

--------------------------------

### Initialize DX BUFR Tables - dxmini

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/dxtable_8F90_source.html

Initializes a DX BUFR tables (dictionary) message, writing preliminary information into Section 1.

```fortran
subroutine dxmini(mbay, mbyt, mb4, mba, mbb, mbd)
Initialize a DX BUFR tables (dictionary) message, writing all the preliminary information into Sectio...
**Definition:** dxtable.F90:691
```

--------------------------------

### fortran_open

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/openclosebf_8F90.html

Opens a Fortran file on the local system with specified parameters.

```APIDOC
## fortran_open()

### Description
Open a Fortran file on the local system.

### Parameters
*   **filename** (character*(*)) - name of the file to be opened
*   **lunit** (integer) - Fortran logical unit number for Fortran file
*   **format** (character*(*)) - format of the Fortran file
*   **position** (character*(*)) - to rewind or continue with open file
*   **iret** (integer) - return code from the Fortran open statement
```

--------------------------------

### nemtab_c

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/bufr__c2f__interface_8F90_source.html

Get information about a descriptor.

```APIDOC
## nemtab_c

### Description
Get information about a descriptor.

### Subroutine Signature
`subroutine, public nemtab_c(lun, mnemonic, descriptor, table_type, table_idx)`

### Parameters
- `lun` (integer) - Fortran logical unit.
- `mnemonic` (character) - Mnemonic string.
- `descriptor` (integer) - Descriptor value.
- `table_type` (integer) - Type of table.
- `table_idx` (integer) - Index in the table.
```

--------------------------------

### nemtab_f

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/bufr__interface_8h.html

Gets information about a descriptor.

```APIDOC
## nemtab_f

### Description
Get information about a descriptor.

### Signature
`void nemtab_f(int lun, const char *mnemonic, int *descriptor, char *table_type, int *table_idx)`
```

--------------------------------

### readbp

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/readbp_8F90.html

Reads a PREPBUFR file containing embedded DX BUFR tables and prints each report one at a time. Options are listed by running "readbp" without arguments.

```APIDOC
## readbp()

### Description
Read PREPBUFR file containing embedded DX BUFR tables, and print each report one at a time.
Options are listed by running "readbp" without argumets.

### Returns
0 for success, error code otherwise.

### Author
J. Woollen

### Date
1994-01-06

### Definition
Definition at line 18 of file readbp.F90.
References datelen(), ireadmg(), ireadsb(), openbf(), printx(), ufbcnt(), ufbint(), and ufdump().
```

--------------------------------

### bufrlib::cewind_c

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/bufrlib_8F90_source.html

Initializes wind data.

```APIDOC
## bufrlib::cewind_c

### Description
Initializes wind data.

### Definition
bufrlib.F90:82
```

--------------------------------

### fstag

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/jumplink_8F90.html

Searches for a specified occurrence of a mnemonic within a data subset definition, starting from a specified location. It can search forwards or backwards from a given starting point and returns the location of the found mnemonic or an error code.

```APIDOC
## fstag()

### Description
Search for a specified occurrence of a specified mnemonic within a data subset definition, starting from a specified location. Search for the (nutag)th occurrence of mnemonic utag within the current overall subset definition, starting from parameter #(nin) within the subset. The subroutine searches forward from nin if nutag is positive or else backward if nutag is negative.

### Parameters
- **lun** (integer, intent(in)) - File ID
- **utag** (character*(*), intent(in)) - Mnemonic
- **nutag** (integer, intent(in)) - Ordinal occurrence of utag to search for within the overall subset definition, counting from parameter #(nin) within the subset. The subroutine will search in a forward direction from parameter #(nin) if nutag is positive or else in a backward direction if nutag is negative.
- **nin** (integer, intent(in)) - Location within the overall subset definition from which to begin searching for utag
- **nout** (integer, intent(out)) - Location of (nutag)th occurrence of utag
- **iret** (integer, intent(out)) - Return code: 0 = Normal return, -1 = Requested mnemonic could not be found, or some other error occurred

### Author
J. Ator

### Date
2014-10-02

### Definition
Line 1065 of file jumplink.F90.

### References
- moda_usrint::inv
- moda_usrint::nval
- parstr()
- moda_tables::tag

### Referenced by
- gettagpr()
- gettagre()
- getvalnb()
- nemspecs()
- setvalnb()
- ufdump()
```

--------------------------------

### iupvs01_f

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/bufr__interface_8h_source.html

Initializes the VS01 table with a BUFR unit and mnemonic.

```APIDOC
## iupvs01_f

### Description
Initializes the VS01 table with a BUFR unit and mnemonic.

### Signature
```c
int iupvs01_f(int bufr_unit, const char *c_s01m);
```

### Parameters
*   **bufr_unit** (int) - The BUFR unit.
*   **c_s01m** (const char *) - The mnemonic string.

### Returns
An integer return code.
```

--------------------------------

### igettdi_c()

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/namespacemembers_func.html

Gets the table descriptor information.

```APIDOC
## igettdi_c()

### Description
Gets the table descriptor information.

### Signature
igettdi_c()

### Module
bufr_c2f_interface
```

--------------------------------

### igetntbi_c()

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/namespacemembers_func.html

Gets the number of table entries.

```APIDOC
## igetntbi_c()

### Description
Gets the number of table entries.

### Signature
igetntbi_c()

### Module
bufr_c2f_interface
```

--------------------------------

### bfrini

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/misc_8F90.html

Initializes global variables and arrays within internal modules and common blocks.

```APIDOC
## subroutine bfrini

### Description
Initialize numerous global variables and arrays within internal modules and common blocks throughout the NCEPLIBS-bufr software.

### Method
subroutine

### Endpoint
bfrini
```

--------------------------------

### igetmxby_c()

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/namespacemembers_func.html

Gets the maximum number of bytes.

```APIDOC
## igetmxby_c()

### Description
Gets the maximum number of bytes.

### Signature
igetmxby_c()

### Module
bufr_c2f_interface
```

--------------------------------

### Initialize Master Table Info (Fortran)

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/mastertable_8F90_source.html

Initializes master table information and handles 8-byte integer compatibility. Use when setting up master table operations.

```Fortran
recursive subroutine mtinfo ( cmtdir, lunmt1, lunmt2 )

use modv_vars, only: im8b, lun1, lun2, mtdir, lmtd

implicit none

integer, intent(in) :: lunmt1, lunmt2
integer my_lunmt1, my_lunmt2

character*(*), intent(in) :: cmtdir

! Check for I8 integers
if(im8b) then
im8b=.false.
call x84 ( lunmt1, my_lunmt1, 1 )
call x84 ( lunmt2, my_lunmt2, 1 )
call mtinfo ( cmtdir, my_lunmt1, my_lunmt2 )
im8b=.true.
return
endif

call strsuc ( cmtdir, mtdir, lmtd )

lun1 = lunmt1
lun2 = lunmt2

return
end subroutine mtinfo
```

--------------------------------

### OPENBF Subroutine: Connect BUFR File

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/binv_8F90_source.html

Connects a new file to the NCEPLIBS-BUFR software for input or output operations, or initializes the library.

```Fortran
recursive subroutine openbf(lunit, io, lundx)
Connect a new file to the NCEPLIBS-BUFR software for input or output operations, or initialize the li...
**Definition:** openclosebf.F90:164
```

--------------------------------

### ifbget_c()

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/namespacemembers_func.html

Gets data from a BUFR file.

```APIDOC
## ifbget_c()

### Description
Gets data from a BUFR file.

### Signature
ifbget_c()

### Module
bufr_c2f_interface
```

--------------------------------

### bufrlib::catch_bort_ufbget_c

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/bufrlib_8F90_source.html

Gets BUFR data.

```APIDOC
## bufrlib::catch_bort_ufbget_c

### Description
Gets BUFR data.

### Definition
bufrlib.F90:1636
```

--------------------------------

### Process Command Line Options

Source: https://noaa-emc.github.io/NCEPLIBS-bufr/debufr_8c_source.html

Parses command-line arguments using getopt to configure the debufr utility. Handles options for version, help, output file, table directory, DX BUFR tables file, and parameter settings.

```c
while ( ( ch = getopt ( argc, argv, "vhbcmo:t:f:p:" ) ) != EOF ) {
    switch ( ch ) {
    case 'v':
        bvers_f( bvstr, VERS_STR_LEN+1 );
        printf( "This is the debufr utility, built with NCEPLIBS-bufr v%s\n", bvstr );
        return 0;
    case 'h':
        printf( "\nPROGRAM %s\n", argv[0] );
        printf( "\nABSTRACT: This program decodes a BUFR file and generates a verbose\n" );
        printf( " listing of the contents. If a DX BUFR tables file is specified\n" );
        printf( " (using the -f option) or if the specified BUFR file contains an\n" );
        printf( " embedded DX BUFR tables message as the first message in the file,\n" );
        printf( " then this DX BUFR tables information is used to decode the data\n" );
        printf( " messages in the file. Otherwise, or whenever the -m option is\n" );
        printf( " specified, master BUFR tables are read and used to decode the\n" );
        printf( " data messages in the file.\n" );
        prtusage( argv[0] );
        return 0;
    case 'b':
        basic = 'Y';
        break;
    case 'm':
        forcemt = 'Y';
        break;
    case 'c':
        cfms = 'N';
        break;
    case 'o':
        if ( ( ofile = malloc( strlen( optarg ) + 1 ) ) == NULL ) {
            printf( "\nERROR: Could not allocate memory for output file name!\n" );
            return -1;
        }
        strcpy ( ofile, optarg );
        break;
    case 't':
        if ( ( tbldir = malloc( strlen( optarg ) + 1 ) ) == NULL ) {
            printf( "\nERROR: Could not allocate memory for tables directory!\n" );
            return -1;
        }
        strcpy ( tbldir, optarg );
        break;
    case 'f':
        if ( ( wkstr = malloc( strlen( optarg ) + 1 ) ) == NULL ) {
            printf( "\nERROR: Could not allocate memory for DX BUFR tables file!\n" );
            return -1;
        }
        strcpy ( wkstr, optarg );
        break;
    case 'p':
        if ( ( prmstg = malloc( strlen( optarg ) + 1 ) ) == NULL ) {
            printf( "\nERROR: Could not allocate memory for PARAMETER(S)=VALUE(S) string!\n" );
            return -1;
        }
        strcpy ( prmstg, optarg );
        break;
    }
}

```
Tokens:
Raw