libwreport-doc 3.6-1 / usr / share / doc / libwreport-doc / apidocs / structwreport_1_1Vartable.html

This file is indexed.

/usr/share/doc/libwreport-doc/apidocs/structwreport_1_1Vartable.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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
<!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: wreport::Vartable Struct Reference</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
   &#160;<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacewreport.html">wreport</a></li><li class="navelem"><a class="el" href="structwreport_1_1Vartable.html">Vartable</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">wreport::Vartable Struct Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Holds a variable information table.  
 <a href="structwreport_1_1Vartable.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="vartable_8h_source.html">vartable.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac6dbc240ad7a54b944fae79cbc870687"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6dbc240ad7a54b944fae79cbc870687"></a>
virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1Vartable.html#ac6dbc240ad7a54b944fae79cbc870687">pathname</a> () const =0</td></tr>
<tr class="memdesc:ac6dbc240ad7a54b944fae79cbc870687"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the pathname of the file from which this table has been loaded. <br /></td></tr>
<tr class="separator:ac6dbc240ad7a54b944fae79cbc870687"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a771570ad67d78fdde898070829e0b359"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacewreport.html#acfcbb1367ca9f4166d76f13fbd910be7">Varinfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1Vartable.html#a771570ad67d78fdde898070829e0b359">query</a> (<a class="el" href="namespacewreport.html#af9fa16e12fde1ccfb4ce11b3988f5b05">Varcode</a> code) const =0</td></tr>
<tr class="memdesc:a771570ad67d78fdde898070829e0b359"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query the <a class="el" href="structwreport_1_1Vartable.html" title="Holds a variable information table. ">Vartable</a>.  <a href="#a771570ad67d78fdde898070829e0b359">More...</a><br /></td></tr>
<tr class="separator:a771570ad67d78fdde898070829e0b359"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb44afe14c65bcceee080857c5762f40"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb44afe14c65bcceee080857c5762f40"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1Vartable.html#afb44afe14c65bcceee080857c5762f40">contains</a> (<a class="el" href="namespacewreport.html#af9fa16e12fde1ccfb4ce11b3988f5b05">Varcode</a> code) const =0</td></tr>
<tr class="memdesc:afb44afe14c65bcceee080857c5762f40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the code can be resolved to a varinfo. <br /></td></tr>
<tr class="separator:afb44afe14c65bcceee080857c5762f40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8fc18dc1f3f6062c8815c2829144b74"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacewreport.html#acfcbb1367ca9f4166d76f13fbd910be7">Varinfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1Vartable.html#ab8fc18dc1f3f6062c8815c2829144b74">query_altered</a> (<a class="el" href="namespacewreport.html#af9fa16e12fde1ccfb4ce11b3988f5b05">Varcode</a> code, int new_scale, unsigned new_bit_len) const =0</td></tr>
<tr class="memdesc:ab8fc18dc1f3f6062c8815c2829144b74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Query an altered version of the vartable.  <a href="#ab8fc18dc1f3f6062c8815c2829144b74">More...</a><br /></td></tr>
<tr class="separator:ab8fc18dc1f3f6062c8815c2829144b74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac695e35e38c5f67614f09514f8593de6"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1Vartable.html#ac695e35e38c5f67614f09514f8593de6">iterate</a> (std::function&lt; bool(<a class="el" href="namespacewreport.html#acfcbb1367ca9f4166d76f13fbd910be7">Varinfo</a>)&gt; dest) const =0</td></tr>
<tr class="memdesc:ac695e35e38c5f67614f09514f8593de6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterate the whole contents of the table.  <a href="#ac695e35e38c5f67614f09514f8593de6">More...</a><br /></td></tr>
<tr class="separator:ac695e35e38c5f67614f09514f8593de6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a34d0186c87bce3cf2e319ba2780dbc5c"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="structwreport_1_1Vartable.html">Vartable</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1Vartable.html#a34d0186c87bce3cf2e319ba2780dbc5c">load_bufr</a> (const std::string &amp;<a class="el" href="structwreport_1_1Vartable.html#ac6dbc240ad7a54b944fae79cbc870687">pathname</a>)</td></tr>
<tr class="memdesc:a34d0186c87bce3cf2e319ba2780dbc5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a BUFR vartable, by file name.  <a href="#a34d0186c87bce3cf2e319ba2780dbc5c">More...</a><br /></td></tr>
<tr class="separator:a34d0186c87bce3cf2e319ba2780dbc5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44959a807ee89a9bf3e4585c42e7dd1f"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="structwreport_1_1Vartable.html">Vartable</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1Vartable.html#a44959a807ee89a9bf3e4585c42e7dd1f">load_crex</a> (const std::string &amp;<a class="el" href="structwreport_1_1Vartable.html#ac6dbc240ad7a54b944fae79cbc870687">pathname</a>)</td></tr>
<tr class="memdesc:a44959a807ee89a9bf3e4585c42e7dd1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a CREX vartable, by file name.  <a href="#a44959a807ee89a9bf3e4585c42e7dd1f">More...</a><br /></td></tr>
<tr class="separator:a44959a807ee89a9bf3e4585c42e7dd1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84415c9aa2226382fd459995372f799f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84415c9aa2226382fd459995372f799f"></a>
static const <a class="el" href="structwreport_1_1Vartable.html">Vartable</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1Vartable.html#a84415c9aa2226382fd459995372f799f">get_bufr</a> (const <a class="el" href="structwreport_1_1BufrTableID.html">BufrTableID</a> &amp;id)</td></tr>
<tr class="memdesc:a84415c9aa2226382fd459995372f799f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find a BUFR table. <br /></td></tr>
<tr class="separator:a84415c9aa2226382fd459995372f799f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42b15e8f3fcb3ad66fcb775100783ef8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42b15e8f3fcb3ad66fcb775100783ef8"></a>
static const <a class="el" href="structwreport_1_1Vartable.html">Vartable</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1Vartable.html#a42b15e8f3fcb3ad66fcb775100783ef8">get_crex</a> (const <a class="el" href="structwreport_1_1CrexTableID.html">CrexTableID</a> &amp;id)</td></tr>
<tr class="memdesc:a42b15e8f3fcb3ad66fcb775100783ef8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find a CREX table. <br /></td></tr>
<tr class="separator:a42b15e8f3fcb3ad66fcb775100783ef8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a326bc3fa2d05ea27519b089635ac5584"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a326bc3fa2d05ea27519b089635ac5584"></a>
static const <a class="el" href="structwreport_1_1Vartable.html">Vartable</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1Vartable.html#a326bc3fa2d05ea27519b089635ac5584">get_bufr</a> (const std::string &amp;basename)</td></tr>
<tr class="memdesc:a326bc3fa2d05ea27519b089635ac5584"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find a BUFR table, by file name (without extension) <br /></td></tr>
<tr class="separator:a326bc3fa2d05ea27519b089635ac5584"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0505b124072313d80f530ff4735f9227"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0505b124072313d80f530ff4735f9227"></a>
static const <a class="el" href="structwreport_1_1Vartable.html">Vartable</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwreport_1_1Vartable.html#a0505b124072313d80f530ff4735f9227">get_crex</a> (const std::string &amp;basename)</td></tr>
<tr class="memdesc:a0505b124072313d80f530ff4735f9227"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find a CREX table, by file name (without extension) <br /></td></tr>
<tr class="separator:a0505b124072313d80f530ff4735f9227"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Holds a variable information table. </p>
<p>It never needs to be deallocated, as all the <a class="el" href="structwreport_1_1Vartable.html" title="Holds a variable information table. ">Vartable</a> returned by wreport are pointers to memory-cached versions that are guaranteed to exist for all the lifetime of the program.</p>
<p>There are many B tables with slight differences used by different meteorological centre or equipment. This module allows to access different vartables using Vartable::get().</p>
<p><a class="el" href="structwreport_1_1Vartable.html" title="Holds a variable information table. ">Vartable</a> and Varinfo have special memory management: they are never deallocated. This is an explicit design choice to speed up passing and copying Varinfo values, that are used very intensely as they accompany all the physical values processed by wreport. This behaviour should not be a cause of memory leaks, since a software would only need to access a limited amount of distinct variable informations during its lifetime. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac695e35e38c5f67614f09514f8593de6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool wreport::Vartable::iterate </td>
          <td>(</td>
          <td class="paramtype">std::function&lt; bool(<a class="el" href="namespacewreport.html#acfcbb1367ca9f4166d76f13fbd910be7">Varinfo</a>)&gt;&#160;</td>
          <td class="paramname"><em>dest</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Iterate the whole contents of the table. </p>
<p>Return false from dest to stop iteration.</p>
<dl class="section return"><dt>Returns</dt><dd>true if iteration ended normally, false if dest returned false. </dd></dl>

</div>
</div>
<a class="anchor" id="a34d0186c87bce3cf2e319ba2780dbc5c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static const <a class="el" href="structwreport_1_1Vartable.html">Vartable</a>* wreport::Vartable::load_bufr </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>pathname</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Return a BUFR vartable, by file name. </p>
<p>Once loaded, the table will be cached in memory for reuse, and further calls to <a class="el" href="structwreport_1_1Vartable.html#a34d0186c87bce3cf2e319ba2780dbc5c" title="Return a BUFR vartable, by file name. ">load_bufr()</a> will return the cached version. </p>

</div>
</div>
<a class="anchor" id="a44959a807ee89a9bf3e4585c42e7dd1f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static const <a class="el" href="structwreport_1_1Vartable.html">Vartable</a>* wreport::Vartable::load_crex </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>pathname</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Return a CREX vartable, by file name. </p>
<p>Once loaded, the table will be cached in memory for reuse, and further calls to <a class="el" href="structwreport_1_1Vartable.html#a44959a807ee89a9bf3e4585c42e7dd1f" title="Return a CREX vartable, by file name. ">load_crex()</a> will return the cached version. </p>

</div>
</div>
<a class="anchor" id="a771570ad67d78fdde898070829e0b359"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespacewreport.html#acfcbb1367ca9f4166d76f13fbd910be7">Varinfo</a> wreport::Vartable::query </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespacewreport.html#af9fa16e12fde1ccfb4ce11b3988f5b05">Varcode</a>&#160;</td>
          <td class="paramname"><em>code</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Query the <a class="el" href="structwreport_1_1Vartable.html" title="Holds a variable information table. ">Vartable</a>. </p>
<p>Throws an exception if not found.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">code</td><td><a class="el" href="namespacewreport.html#af9fa16e12fde1ccfb4ce11b3988f5b05" title="Holds the WMO variable code of a variable. ">wreport::Varcode</a> to query </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the wreport::varinfo with the results of the query. </dd></dl>

</div>
</div>
<a class="anchor" id="ab8fc18dc1f3f6062c8815c2829144b74"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="namespacewreport.html#acfcbb1367ca9f4166d76f13fbd910be7">Varinfo</a> wreport::Vartable::query_altered </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespacewreport.html#af9fa16e12fde1ccfb4ce11b3988f5b05">Varcode</a>&#160;</td>
          <td class="paramname"><em>code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>new_scale</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&#160;</td>
          <td class="paramname"><em>new_bit_len</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Query an altered version of the vartable. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">var</td><td><a class="el" href="namespacewreport.html#af9fa16e12fde1ccfb4ce11b3988f5b05" title="Holds the WMO variable code of a variable. ">wreport::Varcode</a> to query </td></tr>
    <tr><td class="paramname">scale</td><td>Scale to use instead of the default </td></tr>
    <tr><td class="paramname">bit_len</td><td>Bit length to use instead of the default </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the <a class="el" href="namespacewreport.html#acfcbb1367ca9f4166d76f13fbd910be7" title="Varinfo reference. ">wreport::Varinfo</a> with the results of the query. The resulting Varinfo is stored inside the <a class="el" href="structwreport_1_1Vartable.html" title="Holds a variable information table. ">Vartable</a>, can be freely copied around and does not need to be deallocated. </dd></dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="vartable_8h_source.html">vartable.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Aug 18 2016 13:32:18 for libwreport by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.