/usr/share/doc/libwreport-doc/apidocs/features.html is in libwreport-doc 3.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>libwreport: Library features</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libwreport
 <span id="projectnumber">3.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Library features </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="features_bufr_decoder"></a>
BUFR decoder features</h1>
<p>The decoder supports BUFR editions 2, 3 and 4, both uncompressed and compressed.</p>
<p>C operators supported are:</p>
<ul>
<li>1 change data width</li>
<li>2 change data scale</li>
<li>4 add associated field, limited to 32 bits of associated fields and to associated field significances 1, 2, and 6.</li>
<li>5 character data</li>
<li>6 local descriptor with explicit length</li>
<li>8 override length of character data</li>
<li>22 quality information matched via data present bitmap</li>
<li>23 substituted values matched via data present bitmap</li>
<li>24 first order statistical values matched via data present bitmap</li>
</ul>
<h1><a class="anchor" id="features_bufr_encoder"></a>
BUFR encoder features</h1>
<p>All features supported by the decoder are supported by the encoder, and tested via decode/reencode/decode runs.</p>
<p>The encoder however does not yet support compression of multisubset data sections.</p>
<h1><a class="anchor" id="features_crex_decoder"></a>
CREX decoder features</h1>
<p>The decoder supports CREX edition 1.</p>
<p>B, R and D opcodes are supported. Some C modifiers may be supported, but are untested due to lack of real-world samples.</p>
<h1><a class="anchor" id="features_crex_encoder"></a>
CREX encoder features</h1>
<p>All features supported by the decoder are supported by the encoder, and tested via decode/reencode/decode runs.</p>
<h1><a class="anchor" id="codec_details"></a>
Coding/decoding details</h1>
<p>BUFR and CREX header information is stored in member variables of <a class="el" href="structwreport_1_1Bulletin.html" title="Storage for the decoded data of a BUFR or CREX message. ">wreport::Bulletin</a> or, for encoding-specific cases, <a class="el" href="structwreport_1_1BufrBulletin.html" title="BUFR bulletin implementation. ">wreport::BufrBulletin</a> and wreport::Crexbulletin.</p>
<p>The contents of the data descriptor section are stored in <a class="el" href="structwreport_1_1Bulletin.html#a91f2fe233798c17e2252fdc45c078f20" title="Parsed data descriptor section. ">wreport::Bulletin::datadesc</a>.</p>
<p>The data section is split in 1 or more <a class="el" href="structwreport_1_1Subset.html" title="Represent a BUFR/CREX data subset as a list of decoded variables. ">wreport::Subset</a> objects, stored in <a class="el" href="structwreport_1_1Bulletin.html#a544f248fc72a7c75e48ed6835bb22e62" title="Decoded variables. ">wreport::Bulletin::subsets</a>.</p>
<p>BUFR decoding details (such as pointers to beginning and end of the various message sections) are stored in wreport::BufrBulletin::raw_details.</p>
<p>Decoded values are stored as <a class="el" href="classwreport_1_1Var.html" title="A physical variable. ">wreport::Var</a> inside <a class="el" href="structwreport_1_1Subset.html" title="Represent a BUFR/CREX data subset as a list of decoded variables. ">wreport::Subset</a> objects. Values that refer to other values (such as associated fields, quality information, substituted values and so on) are stored as attributes of the variable they refer to.</p>
<p>Data Present Bitmaps and other C modifier parameters are stored as special <a class="el" href="classwreport_1_1Var.html" title="A physical variable. ">wreport::Var</a> objects, using ad-hoc <a class="el" href="namespacewreport.html#acfcbb1367ca9f4166d76f13fbd910be7" title="Varinfo reference. ">wreport::Varinfo</a> information that is not found in the usual tables:</p>
<ul>
<li>Data Present Bitmaps are stored as string variables, where "+" means "data
present" and "-" means "data not present".</li>
<li>Associated fields are stored as attributes to the <a class="el" href="classwreport_1_1Var.html" title="A physical variable. ">wreport::Var</a> object they refer to, according to their Associate Field Significance:<ul>
<li>significance code 1: stored as a B33002 attribute</li>
<li>significance code 2: stored as a B33003 attribute</li>
<li>significance code 6: stored as a B33050 attribute</li>
</ul>
</li>
<li>Quality information is stored as attributes of the variable they refer to, using the appropriate B33YYY descriptor for the attribute values.</li>
<li>Substituted fields are stored as attributes of the variables they substitute; the attributes will have the same <a class="el" href="namespacewreport.html#af9fa16e12fde1ccfb4ce11b3988f5b05" title="Holds the WMO variable code of a variable. ">wreport::Varcode</a> as the variable. </li>
</ul>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Aug 18 2016 13:32:18 for libwreport by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
|