file with the utility routines for binary bufr2tac More...

#include "bufr2tac.h"

Include dependency graph for bufr2tac_utils.c:

Functions
unsigned int	three_bytes_to_uint (const unsigned char *source)
	returns the integer value from an array of three bytes, most significant first More...

int	integer_to_descriptor (struct bufr_descriptor *d, int id)
	parse an integer with a descriptor fom bufr ECWMF libary More...

int	descriptor_to_integer (int id, struct bufr_descriptor d)
	parse a descriptor and sets an integer in the decimal formas fxxyyy More...

uint32_t	get_flag_value (uint8_t width, uint8_t index)

char *	charray_to_string (char s, unsigned char buf, size_t size)
	get a null termitated c-string from an array of unsigned chars More...

char *	adjust_string (char *s)
	Supress trailing blanks of a string. More...

size_t	tokenize_string (char tk[], size_t ntk, char target, size_t len, char *blanks)
	Split the report string into tokens. More...

int	YYYYMMDDHHmm_to_met_datetime (struct met_datetime t, const char source)
	Parse the string YYYYMMDDHHmm[ss] and set a struct met_datetime. More...

char *	met_datetime_to_YYGG (char target, struct met_datetime t)
	Get YYGG from a struct met_datetime. More...

int	round_met_datetime_to_hour (struct met_datetime target, struct met_datetime source)

char *	guess_WMO_region (char A1, char Reg, const char II, const char iii)
	get WMO region A1 and Reg items from II and iii (WMO index) More...

int	check_date_from_future (struct metreport *m)
	Check a estructure metreport not from future. More...

int	guess_gts_header (struct gts_header h, const char f)
	Guess the WMO GTS header from filename. More...

Detailed Description

file with the utility routines for binary bufr2tac

Definition in file bufr2tac_utils.c.

Function Documentation

◆ adjust_string()

char * adjust_string ( char * s )

Supress trailing blanks of a string.

Parameters

s	string to process

Definition at line 99 of file bufr2tac_utils.c.

{
  size_t l;
  l = strlen ( s );
  while ( l && s[--l] == ' ' )
    s[l] = '\0';
  return s;
}

Referenced by buoy_parse_x01(), climat_parse_x01(), syn_parse_x01(), and temp_parse_x01().

Here is the caller graph for this function:

◆ charray_to_string()

char * charray_to_string	(	char *	s,
		unsigned char *	buf,
		size_t	size
	)

get a null termitated c-string from an array of unsigned chars

Parameters

s	resulting string
buf	pointer to first element in array
size	number of chars in array

Definition at line 85 of file bufr2tac_utils.c.

{
  // copy
  memcpy ( s , buf, size );
  // add final string mark
  s[size] = '\0';
  return s;
}

◆ check_date_from_future()

int check_date_from_future ( struct metreport * m )

Check a estructure metreport not from future.

Parameters

m	pointer to a struct metreport to check about date and time

It resturns 1 if date/time is from future, and likely wrong Returns 0 otherwise

Definition at line 292 of file bufr2tac_utils.c.

{
  time_t now;
 
  now = time ( NULL );
  if ( m->t.t > ( now + 1800 ) ) // Still 1/2 hour courtesy
    return 1;
  else
    return 0;
}

References metreport::t, and met_datetime::t.

Referenced by parse_subset_as_climat(), and parse_subset_as_synop().

Here is the caller graph for this function:

◆ descriptor_to_integer()

int descriptor_to_integer	(	int *	id,
		struct bufr_descriptor *	d
	)

parse a descriptor and sets an integer in the decimal formas fxxyyy

Parameters

id	pointer to target integer
d	pointer to a struct bufr_descriptor with the source

Definition at line 58 of file bufr2tac_utils.c.

{
  if ( d == NULL )
    return 1;
  *id = 100000 * d->f + 1000 * d->x + d->y;
  return 0;
}

References bufr_descriptor::f, bufr_descriptor::x, and bufr_descriptor::y.

Referenced by bufrtotac_parse_subset_sequence().

Here is the caller graph for this function:

◆ get_flag_value()

uint32_t get_flag_value	(	uint8_t	width,
		uint8_t	index
	)

Definition at line 66 of file bufr2tac_utils.c.

{
  if ( width == index )
    return ( uint32_t ) 1;
  else if ( width < index )
    return ( uint32_t ) 0;
  else if ( width <= 32 )
    return ( ( ( uint32_t ) 1 ) << ( width - index ) );
  else
    return ( uint32_t ) 0;
}

◆ guess_gts_header()

int guess_gts_header	(	struct gts_header *	h,
		const char *	f
	)

Guess the WMO GTS header from filename.

Parameters

h	pointer to a struct gts_header where to set the results
f	pathname of bufrfile

It returns 1 if guessed, 0 otherwise

This routine assume the filename format of a bufr file is

  YYYYMMDDHHmmss_BULLNN_ICAO_YYGGgg_ORD.bufr

where

 YYYYMMDDHHmmss

is the timestamp (UTC) of the file in GTS (as example, in NOAA gateway)

BULLNN is the bulletin identifier in GTS. It is a six chars lenght in the form T1 T2 A1 A2 N1 N2

  For observations, T1 is 'I'
  Possible values of T2 for T1 = 'I' are
     O   Oceanographic/limnographic (water properties)
     P   Pictorial
     S   Surface/sea level
     T   Text (plain language information)
     U   Upper air
     X   Other data types
     Z   Mixed data types


  For T1T2 = 'IS' Then A1:

     IS A 01–29 Routinely scheduled observations for n/a 000/006
                distribution from automatic (fixed or mobile)
                land stations (e.g. 0000, 0100, … or 0220, 0240,
                0300, …, or 0715, 0745, ... UTC)
     IS A 30–59 N-minute observations from automatic (fixed n/a 000/007
                or mobile) land stations
     IS B   Radar reports (parts A and B) RADOB 006/003
     IS C 01–45 Climatic observations from land stations CLIMAT 000/020
     IS C 46–59 Climatic observations from marine stations CLIMAT SHIP 001/0202009 edition
                ATTACHmENT II-5 I
     IS D   Radiological observation RADREP 010/001
     IS E   Ozone measurement at surface n/a 008/000
     IS F   Source of atmospherics SFAZI, SFLOC, SFAZU 000/030
     IS I 01–45 Intermediate synoptic observations from fixed SYNOP (SIxx) 000/001
            land stations 000/051
     IS I 46–59 Intermediate synoptic observations from mobile SYNOP mOBIL 000/004
            land stations
     IS M 01–45 Main synoptic observations from fixed land SYNOP (SMxx) 000/002
            stations 000/052
     IS M 46–59 Main synoptic observations from mobile land SYNOP mOBIL 000/005
             stations
     IS N 01–45 Synoptic observations from fixed land stations SYNOP (SNxx) 000/000
            at non-standard time (i.e. 0100, 0200, 0400,   000/050
            0500, ... UTC)
     IS N 46–59 Synoptic observations from mobile land stations SYNOP mOBIL 000/003
            at non-standard time (i.e. 0100, 0200, 0400,
            0500, ... UTC)
     IS R   Hydrologic reports HYDRA 000/040
     IS S 01–19 Synoptic observations from marine stations SHIP 001/000
     IS S 20–39 One-hour observations from automatic marine n/a 001/006
           stations
     IS S 40–59 N-minute observations from automatic marine n/a 001/007
           stations
     IS T 01–19 Tide gauge observations n/a 001/030
     IS T 20–39 Observed water level time series n/a 001/031
     IS V   Special aeronautical observations (SPECI) SPECI 000/011
     IS W   Aviation routine weather observations (mETAR) mETAR 000/010
     IS X   Other surface data IAC, IAC FLEET

  For T1T2 = 'IU'  then A1:
     IU A   Single level aircraft reports (automatic) AmDAR 004/000
     IU A   Single level aircraft reports (manual) AIREP/PIREP 004/001
     IU B   Single level balloon reports n/a
     IU C   (used for single level satellite-derived SAREP/SATOB 005/000
             reports – see Note 3)
     IU D   Dropsonde/Dropwindsondes TEmP DROP 002/007
     IU E   Ozone vertical sounding n/a 008/001
     IU I   Dispersal and transport analysis n/a 009/000
     IU J 01–19 Upper wind from fixed land stations (entire PILOT (parts A, 002/001
            sounding) B, C, D)
     IU J 20–39 Upper wind from mobile land stations (entire PILOT mOBIL 002/003
            sounding) (parts A, B, C, D)
     IU J 40–59 Upper wind from marine stations (entire PILOT SHIP 002/002
           sounding) (parts A, B, C, D)
     IU K 01–19 Radio soundings from fixed land stations TEmP (parts A, B) 002/004
           (up to 100 hPa)
     IU K 20–39 Radio soundings from mobile land stations TEmP mOBIL 002/006
          (up to 100 hPa) (parts A, B)
     IU K 40–59 Radio soundings from marine stations TEmP SHIP (parts A, B) 002/005
           (up to 100 hPa)
     IU M   Model derived sondes
     IU N   Rocketsondes
     IU O   Profiles of aircraft observations in ascending/ AmDAR 002/020
            descending
     IU P   Profilers PILOT 002/010
     IU Q   RASS temperature profilers TEmP 002/011
     IU R   (used for radiance data – see Note 3)
     IU S   01–19 Radiosondes/pibal reports from fixed land TEmP (parts A, B, C, D) 002/004
             stations (entire sounding)
     IU S 20–39 Radio soundings from mobile land stations TEmP mOBIL (parts A, 002/006
             (entire sounding) B, C, D)
     IU S 40–59 Radio soundings from marine stations TEmP SHIP (parts A, 002/005
             (entire sounding) B, C, D)
     IU T   (used for satellite-derived sondes – see Note 3) SATEm, SARAD, SATOB
     IU U 01–45 Monthly statistics of data from upper-air stations CLImAT TEmP 002/025
     IU U 46–59 Monthly statistics of data from marine stations CLImAT TEmP, SHIP 002/026
     IU W 01–19 Upper wind from fixed land stations (up to PILOT (parts A, B) 002/001
             100 hPa)
     IU W 20–39 Upper wind from mobile land stations (up to PILOT mOBIL 002/003
             100 hPa) (parts A, B)
     IU W 40–59 Upper wind from marine stations (up to PILOT SHIP 002/002
             100 hPa) (parts A, B)
     IU X   Other upper-air reports

  for T1T2 = 'IO' then  A1:
     IO B   Buoy observations BUOY 001/025
     IO I   Sea ice
     IO P   Sub-surface profiling floats TESAC 031/004
     IO R   Sea surface observations TRACKOB 031/001
     IO S   Sea surface and below soundings BATHY, TESAC 031/005
     IO T   Sea surface temperature
     IO W   Sea surface waves WAVEOB 031/002
     IO X   Other sea environmental

  About A2
     A   0 - 90W northern hemisphere
     B   90W - 180 northern hemisphere
     C   180 - 90E northern hemisphere
     D   90E - 0 northern hemisphere
     E   0 - 90W tropical belt
     F   90W - 180 tropical belt
     G   180 - 90E tropical belt
     H   90E - 0 tropical belt
     I   0 - 90W southern hemisphere
     J   90W - 180 southern hemisphere
     K   180 - 90E southern hemisphere
     L   90E - 0 southern hemisphere
     M   Lower left 10S 100E/upper right 70N 110W
     N   Northern hemisphere
     P   Area between 64.69N - 136.76W, 55.61N - 13.43W
     64.69N - 156.76W, 55.61N - 33.43W
     S   Southern hemisphere
     T   45W - 180 northern hemisphere
     U   Area between 21.0N - 128.1W, 36.0N - 130.9W
               21.1N - 113.0W, 36.2N - 110.5W
     V   Area between 30.3N - 83.7W, 51.0N - 68.9W
               19.8N - 64.5W, 33.3N - 47.1W
     X   Global Area (area not definable)


 ICAO is the ICAO index for release center.

 YYGGgg is the nominal release time (day, hour, minute) UTC

 ORD is the order sequence as RRA, RRB, CCA .... is optional

Definition at line 466 of file bufr2tac_utils.c.

{
  size_t nt;
  char aux[256], *tk[16], *c;
 
  // parse file name
  strcpy ( h->filename, f );
  strcpy ( aux, f );
 
  // check latest '/' in filename
  if ( ( c = strrchr ( aux,'/' ) ) == NULL )
    c = &aux[0];
  else
    c++;
 
  nt = tokenize_string ( tk, 16, c, strlen ( c ), "_. " );
  // parse filenames with format as example 'AAAAMMDDHHmmss_ISIE06_SBBR_012100_RRB.bufr'
 
  // 5 or 6 items
  if ( nt < 5 || nt > 6 )
    return 0;
 
  // extension bufr
  if ( strcmp ( tk[nt - 1],"bufr" ) )
    return 0;
 
  // item 0 the timestamp of file in NOAA GTS gateway
  if ( strlen ( tk[0] ) != 14 || strspn ( tk[0], "0123456789" ) != 14 )
    return 0;
  strcpy ( h->timestamp, tk[0] );
 
  // item 1
  if ( strlen ( tk[1] ) != 6 || strspn ( &tk[1][4],"0123456789" ) != 2 )
    return 0;
  strcpy ( h->bname, tk[1] );
 
  // item 2
  if ( strlen ( tk[2] ) != 4 )
    return 0;
  strcpy ( h->center, tk[2] );
 
  if ( strlen ( tk[3] ) != 6 || strspn ( tk[3], "0123456789" ) != 6 )
    return 0;
  strcpy ( h->dtrel, tk[3] );
 
  if ( nt == 5 )
    {
      strcpy ( h->order, "BBB" );
    }
  else
    {
      if ( strlen ( tk[4] ) == 3 )
        strcpy ( h->order, tk[4] );
      else
        return 0;
    }
 
  return 1;
}

References gts_header::bname, gts_header::center, gts_header::dtrel, gts_header::filename, gts_header::order, gts_header::timestamp, and tokenize_string().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ guess_WMO_region()

char * guess_WMO_region	(	char *	A1,
		char *	Reg,
		const char *	II,
		const char *	iii
	)

get WMO region A1 and Reg items from II and iii (WMO index)

Parameters

A1	string woth resulting A1
Reg	string with resulting Reg
II	WMO block number
iii	WMO number

Definition at line 211 of file bufr2tac_utils.c.

{
  char aux[8];
 
  // filter bad inputs
  if ( II == NULL || iii == NULL )
    return NULL;
 
  if ( II[0] == 0 || iii[0] == 0 )
    return NULL;
 
  // aux string
  sprintf ( aux,"%s%s", II, iii );
 
  if ( ( II[0] == '0' && ( strstr ( aux,"042" ) != aux ) && ( strstr ( aux,"043" ) != aux )  &&
         ( strstr ( aux,"044" ) != aux )  && ( strstr ( aux,"0858" ) != aux ) && ( strstr ( aux,"0859" ) != aux ) ) ||
       II[0] == '1' || ( strstr ( aux,"201" ) == aux ) ||
       strcmp ( II,"22" ) == 0 || strcmp ( II,"26" ) == 0 || strcmp ( II,"27" ) == 0 ||
       strcmp ( II,"33" ) == 0 || strcmp ( II,"34" ) == 0 || strcmp ( II,"22" ) == 0 ||
       ( strstr ( aux,"201" ) == aux ) )
    {
      // Reg 6. Europe
      A1[0] = '6';
      strcpy ( Reg,"VI" );
    }
  else if ( II[0] == '6' || ( strstr ( aux,"0858" ) == aux ) || ( strstr ( aux,"0859" ) == aux ) )
    {
      // Reg 1. Africa
      A1[0] = '1';
      strcpy ( Reg,"I" );
    }
  else if ( II[0] == '5' || ( strcmp ( II,"49" ) == 0 ) || ( strcmp ( II,"21" ) == 0 ) ||
            ( strcmp ( II,"23" ) == 0 ) || ( strcmp ( II,"24" ) == 0 ) || ( strcmp ( II,"25" ) == 0 ) ||
            ( strcmp ( II,"28" ) == 0 ) || ( strcmp ( II,"29" ) == 0 ) || ( strcmp ( II,"30" ) == 0 ) ||
            ( strcmp ( II,"31" ) == 0 ) || ( strcmp ( II,"32" ) == 0 ) || ( strcmp ( II,"38" ) == 0 ) ||
            ( strcmp ( II,"35" ) == 0 ) || ( strcmp ( II,"36" ) == 0 ) || ( strcmp ( II,"39" ) == 0 ) ||
            ( strcmp ( aux, "20200" ) >= 0 && strcmp ( aux, "20999" ) <= 0 ) ||
            ( strcmp ( aux, "40000" ) >= 0 && strcmp ( aux, "48599" ) <= 0 ) ||
            ( strcmp ( aux, "48800" ) >= 0 && strcmp ( aux, "49999" ) <= 0 ) )
    {
      // Reg 2. Asia
      A1[0] = '2';
      strcpy ( Reg,"II" );
    }
  else if ( strcmp ( aux, "80000" ) >= 0 && strcmp ( aux, "88999" ) <= 0 )
    {
      // Reg 3. South america
      A1[0] = '3';
      strcpy ( Reg,"III" );
    }
  else if ( II[0] == '7' || strstr ( aux,"042" ) == aux ||
            strstr ( aux,"043" ) == aux  || strstr ( aux,"044" ) == aux )
    {
      // Reg 4. North and central america
      A1[0] = '4';
      strcpy ( Reg,"IV" );
    }
  else if ( ( strcmp ( aux, "48600" ) >= 0 && strcmp ( aux, "48799" ) <= 0 ) ||
            ( strcmp ( aux, "90000" ) >= 0 && strcmp ( aux, "98999" ) <= 0 ) )
    {
      // Reg 5. Pacific South
      A1[0] = '5';
      strcpy ( Reg,"V" );
    }
  else if ( strcmp ( II,"89" ) == 0 )
    {
      // Reg 0. Antarctica
      A1[0] = '0';
      strcpy ( Reg,"0" );
    }
  return A1;
}

Referenced by guess_WMO_region_synop(), guess_WMO_region_temp(), and syn_parse_x01().

Here is the caller graph for this function:

◆ integer_to_descriptor()

int integer_to_descriptor	(	struct bufr_descriptor *	d,
		int	id
	)

parse an integer with a descriptor fom bufr ECWMF libary

Parameters

d	pointer to a struct bufr_descriptor where to set the result on output
id	integer with the descriptor from ewcwf

Definition at line 41 of file bufr2tac_utils.c.

{
  if ( d == NULL )
    return 1;
  d->f = id / 100000;
  d->x = ( id % 100000 ) / 1000;
  d->y = id % 1000;
  sprintf ( d->c, "%06d", id );
  return 0;
}

References bufr_descriptor::c, bufr_descriptor::f, bufr_descriptor::x, and bufr_descriptor::y.

◆ met_datetime_to_YYGG()

char * met_datetime_to_YYGG	(	char *	target,
		struct met_datetime *	t
	)

Get YYGG from a struct met_datetime.

Parameters

target	string with result as output
t	pointer to source struct met_datetime

Definition at line 180 of file bufr2tac_utils.c.

{
  time_t tx;
  struct tm tim;
 
  tx = ( ( t->t + 1800 ) / 3600 ) * 3600 ; // rounding to next whole hour
  memset ( &tim, 0, sizeof ( struct tm ) );
  gmtime_r ( &tx, &tim );
 
  strftime ( target, 8, "%d%H", &tim );
 
  return target;
}

References met_datetime::t.

Referenced by parse_subset_as_temp().

Here is the caller graph for this function:

◆ round_met_datetime_to_hour()

int round_met_datetime_to_hour	(	struct met_datetime *	target,
		struct met_datetime *	source
	)

Definition at line 194 of file bufr2tac_utils.c.

{
  target->t = ( ( source->t + 1800 ) / 3600 ) * 3600 ; // rounding to next whole hour
  memset ( &target->tim, 0, sizeof ( struct tm ) );
  gmtime_r ( &target->t, &target->tim );
  strftime ( target->datime, 16, "%Y%m%d%H%M", &target->tim );
  return 0;
}

References met_datetime::datime, met_datetime::t, and met_datetime::tim.

Referenced by parse_subset_as_temp().

Here is the caller graph for this function:

◆ three_bytes_to_uint()

unsigned int three_bytes_to_uint ( const unsigned char * source )

returns the integer value from an array of three bytes, most significant first

Definition at line 30 of file bufr2tac_utils.c.

{
  return ( source[2] + source[1] * 256 + source[0] * 65536 );
}

Referenced by read_bufr().

Here is the caller graph for this function:

◆ tokenize_string()

int tokenize_string	(	char *	tk[],
		size_t	ntk,
		char *	target,
		size_t	len,
		char *	blanks
	)

Split the report string into tokens.

Parameters

tk	array of strings. Memory have to be allocated previously by caller
ntk	max amount of elements in tk array.
target	string which is the report to split
len	lenght of target string
blanks	string with the character considered as blanks. If null the default " =\n\r\v\t" is considered Returns the number of tokens target has been splitted into. Retuns 0 in case of a void or too large target. NOTE: target is changed after calling this routine. In fact, the pointers in tk[] are linking to some char in string target

Definition at line 121 of file bufr2tac_utils.c.

{
  size_t i = 1, n;
  char d[] = " =\n\r\v\t", *b, *aux;
 
  // set the blanks array
  if ( blanks == NULL )
    b = &d[0];
  else
    b = blanks;
 
  // check target string limits
  n = strlen ( target );
  if ( n == 0 || n > len )
    return 0;
 
  // the split loop
  tk[0] = strtok_r ( target, b, &aux );
  while ( i < ntk &&
          ( ( tk[i] = strtok_r ( NULL, b, &aux ) ) != NULL ) &&
          strlen ( tk[i] ) > 2 &&
          strlen ( tk[i] ) < 10 )
    i++;
  if ( i < ntk )
    return i;
  else
    return ntk - 1;
}

Referenced by guess_gts_header().

Here is the caller graph for this function:

◆ YYYYMMDDHHmm_to_met_datetime()

int YYYYMMDDHHmm_to_met_datetime	(	struct met_datetime *	t,
		const char *	source
	)

Parse the string YYYYMMDDHHmm[ss] and set a struct met_datetime.

Parameters

source	string with date in YYYYMMDDHHmm[ss] format
t	pointer to a struct met_datetime where to set the results

Definition at line 156 of file bufr2tac_utils.c.

{
  if ( strlen ( source ) != 12  && strlen ( source ) != 14 )
    return 1;
  memset ( &t->tim, 0, sizeof ( struct tm ) );
  if ( strlen ( source ) == 12 )
    {
      strptime ( source, "%Y%m%d%H%M", &t->tim );
    }
  else
    {
      strptime ( source, "%Y%m%d%H%M%S", &t->tim );
    }
  strcpy ( t->datime, source );
  t->t = mktime ( &t->tim );
  return 0;
}

References met_datetime::datime, met_datetime::t, and met_datetime::tim.

Referenced by parse_subset_as_buoy(), parse_subset_as_climat(), parse_subset_as_synop(), and parse_subset_as_temp().

Here is the caller graph for this function:

Functions

Detailed Description

Function Documentation

◆ adjust_string()

◆ charray_to_string()

◆ check_date_from_future()

◆ descriptor_to_integer()

◆ get_flag_value()

◆ guess_gts_header()

◆ guess_WMO_region()

◆ integer_to_descriptor()

◆ met_datetime_to_YYGG()

◆ round_met_datetime_to_hour()

◆ three_bytes_to_uint()

◆ tokenize_string()

◆ YYYYMMDDHHmm_to_met_datetime()