NCEPLIBS-bufr  11.6.0
 All Data Structures Files Functions Variables Pages
bufr_interface.h File Reference

Define signatures to enable a number of BUFRLIB subprograms to be called via wrapper functions from C and C++ application programs. More...

Go to the source code of this file.

Functions

void closbf_f (int bufr_unit)
 Wraps BUFRLIB "closbf" subroutine. More...
 
void close_f (int unit)
 Wraps fortran "close" statement so we can close a Fortran file from a C program. More...
 
void exitbufr_f ()
 Wraps BUFRLIB "exitbufr" subroutine. Closes all open file units used by BUFRLIB. More...
 
int ireadmg_f (int bufr_unit, char *subset, int *iddate, int subset_len)
 Wraps BUFRLIB "ireadmg" subroutine. More...
 
int ireadsb_f (int bufr_unit)
 Wraps BUFRLIB "ireadsb" function. More...
 
void mtinfo_f (const char *path, int file_unit_1, int file_unit_2)
 Wraps BUFRLIB "mtinfo" function. More...
 
void open_f (int unit, const char *filepath)
 Wraps fortran "open" statement so we can open a Fortran file from a C program. More...
 
void openbf_f (int bufr_unit, const char *cio, int table_file_id)
 Wraps BUFRLIB "openbf" subroutine. More...
 
void ufbint_f (int bufr_unit, void **c_data, int dim_1, int dim_2, int *iret, const char *table_b_mnemonic)
 Wraps BUFRLIB "ufbint" function. More...
 
void ufbrep_f (int bufr_unit, void **c_data, int dim_1, int dim_2, int *iret, const char *table_b_mnemonic)
 Wraps BUFRLIB "ufbrep" function. More...
 

Detailed Description

Define signatures to enable a number of BUFRLIB subprograms to be called via wrapper functions from C and C++ application programs.

Author
Ronald Mclaren
Date
2020-07-29

This header file defines the signatures for the functions in bufr_interface.f90 which wrap a number of native Fortran subroutines in the BUFRLIB.

Definition in file bufr_interface.h.

Function Documentation

void closbf_f ( int  bufr_unit)

Wraps BUFRLIB "closbf" subroutine.

Author
Ronald McLaren
Date
2020-07-29
Parameters
[in]bufr_unit- int: the fortran file unit number to close
void close_f ( int  unit)

Wraps fortran "close" statement so we can close a Fortran file from a C program.

Author
Ronald McLaren
Date
2020-07-29
Parameters
[in]unit- int: the integer to use as the fortran file unit
void exitbufr_f ( )

Wraps BUFRLIB "exitbufr" subroutine. Closes all open file units used by BUFRLIB.

Author
Ronald McLaren
Date
2020-07-29
int ireadmg_f ( int  bufr_unit,
char *  subset,
int *  iddate,
int  subset_len 
)

Wraps BUFRLIB "ireadmg" subroutine.

Author
Ronald McLaren
Date
2020-07-29
Parameters
[in]bufr_unit- int: the fortran file unit number to read from
[in,out]subset- char*: the subset string
[out]iddate- int*: datetime of message
[in]subset_len- int: length of the subset string
int ireadsb_f ( int  bufr_unit)

Wraps BUFRLIB "ireadsb" function.

Author
Ronald McLaren
Date
2020-07-29
Parameters
[in]bufr_unit- int: the fortran file unit number to read from
void mtinfo_f ( const char *  path,
int  file_unit_1,
int  file_unit_2 
)

Wraps BUFRLIB "mtinfo" function.

Author
Ronald McLaren
Date
2021-02-24
Parameters
[in]path- const char*: the path where the WMO tables are stored
[in]file_unit_1- int: number to use for first file unit
[in]file_unit_2- int: number to use for second file unit
void open_f ( int  unit,
const char *  filepath 
)

Wraps fortran "open" statement so we can open a Fortran file from a C program.

Author
Ronald McLaren
Date
2020-07-29
Parameters
unit- int: the integer to use as the fortran file unit
filepath- const char*: path to the file we want to open.
void openbf_f ( int  bufr_unit,
const char *  cio,
int  table_file_id 
)

Wraps BUFRLIB "openbf" subroutine.

Author
Ronald McLaren
Date
2020-07-29
Parameters
[in]bufr_unit- int: the fortran file unit number
[in]cio- const char*: cio string (ex "IN", "SEC3", and "OUT")
[in]table_file_id- int: table_file unit number
void ufbint_f ( int  bufr_unit,
void **  c_data,
int  dim_1,
int  dim_2,
int *  iret,
const char *  table_b_mnemonic 
)

Wraps BUFRLIB "ufbint" function.

Author
Ronald McLaren
Date
2020-07-29
Parameters
[in]bufr_unit- int: the fortran file unit number to read from
[in,out]c_data- void**: c style pointer to a pre-allocated buffer
[in]dim_1,dim_2- int: dimensionality of data to read or write
[out]iret- int: return value, length of data read
[in]table_b_mnemonic- const char*: string of mnemonics
void ufbrep_f ( int  bufr_unit,
void **  c_data,
int  dim_1,
int  dim_2,
int *  iret,
const char *  table_b_mnemonic 
)

Wraps BUFRLIB "ufbrep" function.

Author
Ronald McLaren
Date
2020-07-29
Parameters
[in]bufr_unit- int: the fortran file unit number to read from
[in,out]c_data- void**: c style pointer to a pre-allocated buffer
[in]dim_1,dim_2- int: dimensionality of data to read or write
[out]iret- int: return value, length of data read
[in]table_b_mnemonic- const char*: string of mnemonics