NCEPLIBS-bufr  11.7.0
 All Data Structures Files Functions Variables Pages
setbmiss.f
Go to the documentation of this file.
1 C> @file
2 C> @brief Define a customized placeholder value for "missing" data
3 
4 C> This subroutine allows the user to specify a customized value to
5 C> represent "missing" data when reading from or writing to BUFR files.
6 C>
7 C> @author J. Woollen
8 C> @date 2012-09-15
9 C>
10 C> @param[in] XMISS -- real*8: New placeholder value to represent
11 C> "missing" data
12 C>
13 C> <p>This subroutine can be called at any time from within an
14 C> application program, and the value XMISS will then be treated as
15 C> "missing" when reading or writing BUFR data during all future
16 C> calls to any of the other BUFRLIB
17 C> [values-reading subroutines](@ref hierarchy) or
18 C> [values-writing subroutines](@ref hierarchy).
19 C> Otherwise, if this subroutine is never called, a default
20 C> placeholder value of 10E10_8 is used for "missing".
21 C>
22 C> <p>Any data value can always be checked for equivalence to the
23 C> current "missing" value via a call to function ibfms(). See also
24 C> function getbmiss().
25 C>
26 C> @remarks
27 C> - The value XMISS is never actually encoded within a BUFR data
28 C> subset; rather, XMISS is a user-friendly placeholder value to
29 C> represent "missing" data values within the scope of the
30 C> application program. In any actual BUFR data subset, "missing"
31 C> values are always encoded as all bits set to 1, per WMO
32 C> regulations.
33 C>
34 C> <b>Program history log:</b>
35 C> | Date | Programmer | Comments |
36 C> | -----|------------|----------|
37 C> | 2012-09-15 | J. Woollen | Original author |
38 C>
39  SUBROUTINE setbmiss(XMISS)
40 
41  USE modv_bmiss
42 
43  REAL*8 xmiss
44 
45 c-----------------------------------------------------------------------
46 c-----------------------------------------------------------------------
47 
48  CALL openbf(0,'FIRST',0)
49 
50  bmiss = xmiss
51 
52  RETURN
53  END
subroutine setbmiss(XMISS)
This subroutine allows the user to specify a customized value to represent &quot;missing&quot; data when readin...
Definition: setbmiss.f:39
This module declares and initializes the BMISS variable.
Definition: modv_BMISS.f90:9
subroutine openbf(LUNIT, IO, LUNDX)
This subroutine connects a new file to the BUFRLIB software for input or output operations.
Definition: openbf.f:138