/usr/share/doc/libwreport-doc/apidocs/classwreport_1_1bulletin_1_1BufrInput.html is in libwreport-doc 2.1-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 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 | <!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"/>
<title>libwreport: wreport::bulletin::BufrInput Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libwreport <span id="projectnumber">2.1</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data 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 Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data 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="namespacewreport_1_1bulletin.html">bulletin</a> </li>
<li class="navelem"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html">BufrInput</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Data Fields</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">wreport::bulletin::BufrInput Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="wreport::bulletin::BufrInput" -->
<p>Binary buffer with bit-level read operations.
<a href="classwreport_1_1bulletin_1_1BufrInput.html#details">More...</a></p>
<p><code>#include <<a class="el" href="buffers_8h_source.html">buffers.h</a>></code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#ab139078dc09c73427c4b1158654bc026">BufrInput</a> (const std::string &in)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrap a string iinto a <a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html" title="Binary buffer with bit-level read operations.">BufrInput</a>. <a href="#ab139078dc09c73427c4b1158654bc026"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a87b7c5622fc08b0f062ec1d654337b50"></a><!-- doxytag: member="wreport::bulletin::BufrInput::reset" ref="a87b7c5622fc08b0f062ec1d654337b50" args="(const std::string &in)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a87b7c5622fc08b0f062ec1d654337b50">reset</a> (const std::string &in)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start decoding a different buffer. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#ad3f90a84734d1c5f2a12cfc7b1bcd63a">scan_lead_sections</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Scan the message filling in the sec[] array of start offsets of sections 0 and 1. <a href="#ad3f90a84734d1c5f2a12cfc7b1bcd63a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#acdd2108497d9652c71f0eb2c65e18c6e">scan_other_sections</a> (bool has_optional)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Scan the message filling in the sec[] array of section start offsets of all sections from 2 on. <a href="#acdd2108497d9652c71f0eb2c65e18c6e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38a5c79139192253489a3e208694afd0"></a><!-- doxytag: member="wreport::bulletin::BufrInput::offset" ref="a38a5c79139192253489a3e208694afd0" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a38a5c79139192253489a3e208694afd0">offset</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current decoding byte offset. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76b4c7911b72b57db90b268349102cce"></a><!-- doxytag: member="wreport::bulletin::BufrInput::bits_left" ref="a76b4c7911b72b57db90b268349102cce" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a76b4c7911b72b57db90b268349102cce">bits_left</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of bits left in the message to be decoded. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7ec4061ec68f25fe6362b9e5af547ac"></a><!-- doxytag: member="wreport::bulletin::BufrInput::read_byte" ref="ab7ec4061ec68f25fe6362b9e5af547ac" args="(unsigned pos) const " -->
unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#ab7ec4061ec68f25fe6362b9e5af547ac">read_byte</a> (unsigned pos) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a byte value at offset <em>pos</em>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6b1c09cc4ed696e0a796e16527a471d"></a><!-- doxytag: member="wreport::bulletin::BufrInput::read_byte" ref="aa6b1c09cc4ed696e0a796e16527a471d" args="(unsigned section, unsigned pos) const " -->
unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#aa6b1c09cc4ed696e0a796e16527a471d">read_byte</a> (unsigned section, unsigned pos) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a byte value at offset <em>pos</em> inside section <em>section</em>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3cd101e0918a5789d2d96c239f8179e2"></a><!-- doxytag: member="wreport::bulletin::BufrInput::read_number" ref="a3cd101e0918a5789d2d96c239f8179e2" args="(unsigned pos, unsigned byte_len) const " -->
unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a3cd101e0918a5789d2d96c239f8179e2">read_number</a> (unsigned pos, unsigned byte_len) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a big endian integer value <em>byte_len</em> bytes long, at offset <em>pos</em>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a040c6f47aef0fefd9dc97cedc1e3fe37"></a><!-- doxytag: member="wreport::bulletin::BufrInput::read_number" ref="a040c6f47aef0fefd9dc97cedc1e3fe37" args="(unsigned section, unsigned pos, unsigned byte_len) const " -->
unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a040c6f47aef0fefd9dc97cedc1e3fe37">read_number</a> (unsigned section, unsigned pos, unsigned byte_len) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a big endian integer value <em>byte_len</em> bytes long, at offset <em>pos</em> inside section <em>section</em>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29306b777984b9f042f400c00e4ba539"></a><!-- doxytag: member="wreport::bulletin::BufrInput::get_bits" ref="a29306b777984b9f042f400c00e4ba539" args="(unsigned n)" -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a29306b777984b9f042f400c00e4ba539">get_bits</a> (unsigned n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the integer value of the next 'n' bits from the decode input n must be <= 32. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae94430ac1fdc2bf4bda45aa8284ff34d"></a><!-- doxytag: member="wreport::bulletin::BufrInput::debug_dump_next_bits" ref="ae94430ac1fdc2bf4bda45aa8284ff34d" args="(int count) const " -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#ae94430ac1fdc2bf4bda45aa8284ff34d">debug_dump_next_bits</a> (int count) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dump to stderr 'count' bits of 'buf', starting at the 'ofs-th' bit. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a577be0f7e2a40d65e5241c57eda0871a"></a><!-- doxytag: member="wreport::bulletin::BufrInput::parse_error" ref="a577be0f7e2a40d65e5241c57eda0871a" args="(const char *fmt,...) const WREPORT_THROWF_ATTRS(2" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a577be0f7e2a40d65e5241c57eda0871a">parse_error</a> (const char *fmt,...) const WREPORT_THROWF_ATTRS(2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Throw an <a class="el" href="structwreport_1_1error__parse.html" title="Report an error when parsing informations.">error_parse</a> at the current decoding location. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad83e6344d32dc8e08e33e99bf39f044"></a><!-- doxytag: member="wreport::bulletin::BufrInput::parse_error" ref="aad83e6344d32dc8e08e33e99bf39f044" args="(unsigned pos, const char *fmt,...) const WREPORT_THROWF_ATTRS(3" -->
void void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#aad83e6344d32dc8e08e33e99bf39f044">parse_error</a> (unsigned pos, const char *fmt,...) const WREPORT_THROWF_ATTRS(3</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Throw an <a class="el" href="structwreport_1_1error__parse.html" title="Report an error when parsing informations.">error_parse</a> at the given decoding location. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82bfac7244d35d76ba03ca68a1405d66"></a><!-- doxytag: member="wreport::bulletin::BufrInput::parse_error" ref="a82bfac7244d35d76ba03ca68a1405d66" args="(unsigned section, unsigned pos, const char *fmt,...) const WREPORT_THROWF_ATTRS(4" -->
void void void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a82bfac7244d35d76ba03ca68a1405d66">parse_error</a> (unsigned section, unsigned pos, const char *fmt,...) const WREPORT_THROWF_ATTRS(4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Throw an <a class="el" href="structwreport_1_1error__parse.html" title="Report an error when parsing informations.">error_parse</a> at the given decoding location inside the given section. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void void void void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#aafd548a92611da5f9f85bb08bc50dd95">check_available_data</a> (unsigned pos, size_t datalen, const char *expected)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check that the input buffer contains at least <em>datalen</em> characters after offset <em>pos</em>; throw <a class="el" href="structwreport_1_1error__parse.html" title="Report an error when parsing informations.">error_parse</a> otherwise. <a href="#aafd548a92611da5f9f85bb08bc50dd95"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a11dae403610da88fe3ee24922535750e">check_available_data</a> (unsigned section, unsigned pos, size_t datalen, const char *expected)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check that the input buffer contains at least <em>datalen</em> characters after offset <em>pos</em> in section <em>section</em>; throw <a class="el" href="structwreport_1_1error__parse.html" title="Report an error when parsing informations.">error_parse</a> otherwise. <a href="#a11dae403610da88fe3ee24922535750e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a072680dc21dba1822f3cca8cf73255a3">decode_number</a> (<a class="el" href="classwreport_1_1Var.html">Var</a> &dest, uint32_t base, unsigned diffbits)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode a compressed number as described by dest.info(), ad set it as value for <em>dest</em>. <a href="#a072680dc21dba1822f3cca8cf73255a3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a385af8f1a2ac0e8982b7398c1dfe1688">decode_number</a> (<a class="el" href="classwreport_1_1Var.html">Var</a> &dest)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode a number as described by dest.info(), and set it as value for <em>dest</em>. <a href="#a385af8f1a2ac0e8982b7398c1dfe1688"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7394bba0210a712f0f4c0e9e4d28c93"></a><!-- doxytag: member="wreport::bulletin::BufrInput::decode_number" ref="ab7394bba0210a712f0f4c0e9e4d28c93" args="(Varinfo info, unsigned subsets, CompressedVarSink &dest)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#ab7394bba0210a712f0f4c0e9e4d28c93">decode_number</a> (<a class="el" href="classwreport_1_1Varinfo.html">Varinfo</a> info, unsigned subsets, <a class="el" href="structwreport_1_1bulletin_1_1CompressedVarSink.html">CompressedVarSink</a> &dest)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode a number as described by <em>info</em> from a compressed bufr with <em>subsets</em> subsets, and send the resulting variables to <em>dest</em>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a4c34a7d74c1efd1ba7c44a5355f2bea0">decode_number</a> (<a class="el" href="classwreport_1_1Var.html">Var</a> &dest, unsigned subsets)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode a number as described by dest.info(), and set it as value for <em>dest</em>. <a href="#a4c34a7d74c1efd1ba7c44a5355f2bea0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a029b8591bf1213e197bb57932724637f">decode_string</a> (unsigned bit_len, char *str, size_t &len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a string from the data section. <a href="#a029b8591bf1213e197bb57932724637f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#ad1e63aab63025601c73ee6599979070e">decode_string</a> (<a class="el" href="classwreport_1_1Var.html">Var</a> &dest)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode a string as described by dest.info(), ad set it as value for <em>dest</em>. <a href="#ad1e63aab63025601c73ee6599979070e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a7ec8a29b66756acc49d2d88ab633c7de">decode_string</a> (<a class="el" href="classwreport_1_1Var.html">Var</a> &dest, unsigned subsets)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode a string as described by dest.info(), and set it as value for <em>dest</em>. <a href="#a7ec8a29b66756acc49d2d88ab633c7de"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c6908057a468552e601cd051ff97bac"></a><!-- doxytag: member="wreport::bulletin::BufrInput::decode_string" ref="a3c6908057a468552e601cd051ff97bac" args="(Varinfo info, unsigned subsets, CompressedVarSink &dest)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a3c6908057a468552e601cd051ff97bac">decode_string</a> (<a class="el" href="classwreport_1_1Varinfo.html">Varinfo</a> info, unsigned subsets, <a class="el" href="structwreport_1_1bulletin_1_1CompressedVarSink.html">CompressedVarSink</a> &dest)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode a string as described by <em>info</em> from a compressed bufr with <em>subsets</em> subsets, and send the resulting variables to <em>dest</em>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a038247a66e1ab2203cdea16e4b605c1b">decode_binary</a> (<a class="el" href="classwreport_1_1Var.html">Var</a> &dest)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode a generic binary value as-is, as described by dest.info(), ad set it as value for <em>dest</em>. <a href="#a038247a66e1ab2203cdea16e4b605c1b"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37a02039fb65880473c0c0c7de8cc7ef"></a><!-- doxytag: member="wreport::bulletin::BufrInput::data" ref="a37a02039fb65880473c0c0c7de8cc7ef" args="" -->
const unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a37a02039fb65880473c0c0c7de8cc7ef">data</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Input buffer. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59dcbf021365c61228acea9c2a2e6a3f"></a><!-- doxytag: member="wreport::bulletin::BufrInput::data_len" ref="a59dcbf021365c61228acea9c2a2e6a3f" args="" -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a59dcbf021365c61228acea9c2a2e6a3f">data_len</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Input buffer size. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a896c8c05fc9af52a55580abe79f3a618">fname</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Input file name (optional). <a href="#a896c8c05fc9af52a55580abe79f3a618"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a307187c5406bc39d674b10e00f0572c4">start_offset</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">File offset of the start of the message. <a href="#a307187c5406bc39d674b10e00f0572c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20c54071b6655cf4a5258314cb13145e"></a><!-- doxytag: member="wreport::bulletin::BufrInput::s4_cursor" ref="a20c54071b6655cf4a5258314cb13145e" args="" -->
unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a20c54071b6655cf4a5258314cb13145e">s4_cursor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Offset of the byte we are currently decoding. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4785d814ef0fd797452f1a9e1a7460e6"></a><!-- doxytag: member="wreport::bulletin::BufrInput::pbyte" ref="a4785d814ef0fd797452f1a9e1a7460e6" args="" -->
unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a4785d814ef0fd797452f1a9e1a7460e6">pbyte</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Byte we are currently decoding. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5956242accb063f9ff5d3b578928552"></a><!-- doxytag: member="wreport::bulletin::BufrInput::pbyte_len" ref="af5956242accb063f9ff5d3b578928552" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#af5956242accb063f9ff5d3b578928552">pbyte_len</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bits left in pbyte to decode. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a606019a90e21755b3bdc5c660657bd05"></a><!-- doxytag: member="wreport::bulletin::BufrInput::sec" ref="a606019a90e21755b3bdc5c660657bd05" args="[6]" -->
unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a606019a90e21755b3bdc5c660657bd05">sec</a> [6]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Offsets of the start of BUFR sections. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3d07917bb28a6c6b7c61af4356e447b"></a><!-- doxytag: member="wreport::bulletin::BufrInput::scan_section_length" ref="aa3d07917bb28a6c6b7c61af4356e447b" args="(unsigned sec_no)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#aa3d07917bb28a6c6b7c61af4356e447b">scan_section_length</a> (unsigned sec_no)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Scan length of section <em>sec_no</em>, filling in the start of the next section in sec[sec_no + 1]. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Binary buffer with bit-level read operations. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab139078dc09c73427c4b1158654bc026"></a><!-- doxytag: member="wreport::bulletin::BufrInput::BufrInput" ref="ab139078dc09c73427c4b1158654bc026" args="(const std::string &in)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wreport::bulletin::BufrInput::BufrInput </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>in</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Wrap a string iinto a <a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html" title="Binary buffer with bit-level read operations.">BufrInput</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">in</td><td>String with the data to read </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aafd548a92611da5f9f85bb08bc50dd95"></a><!-- doxytag: member="wreport::bulletin::BufrInput::check_available_data" ref="aafd548a92611da5f9f85bb08bc50dd95" args="(unsigned pos, size_t datalen, const char *expected)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void void void void wreport::bulletin::BufrInput::check_available_data </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>datalen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>expected</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check that the input buffer contains at least <em>datalen</em> characters after offset <em>pos</em>; throw <a class="el" href="structwreport_1_1error__parse.html" title="Report an error when parsing informations.">error_parse</a> otherwise. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pos</td><td>Starting offset of the required data </td></tr>
<tr><td class="paramname">datalen</td><td>Required amount of data expected starting from <em>pos</em> </td></tr>
<tr><td class="paramname">expected</td><td>name of what we are about to decode, used for generating nice error messages </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a11dae403610da88fe3ee24922535750e"></a><!-- doxytag: member="wreport::bulletin::BufrInput::check_available_data" ref="a11dae403610da88fe3ee24922535750e" args="(unsigned section, unsigned pos, size_t datalen, const char *expected)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wreport::bulletin::BufrInput::check_available_data </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>section</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>datalen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>expected</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check that the input buffer contains at least <em>datalen</em> characters after offset <em>pos</em> in section <em>section</em>; throw <a class="el" href="structwreport_1_1error__parse.html" title="Report an error when parsing informations.">error_parse</a> otherwise. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">section</td><td>Number of the section to check </td></tr>
<tr><td class="paramname">pos</td><td>Starting offset inside the section of the required data </td></tr>
<tr><td class="paramname">datalen</td><td>Required amount of data expected starting from <em>pos</em> </td></tr>
<tr><td class="paramname">expected</td><td>Name of what we are about to decode, used for generating nice error messages </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a038247a66e1ab2203cdea16e4b605c1b"></a><!-- doxytag: member="wreport::bulletin::BufrInput::decode_binary" ref="a038247a66e1ab2203cdea16e4b605c1b" args="(Var &dest)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wreport::bulletin::BufrInput::decode_binary </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwreport_1_1Var.html">Var</a> & </td>
<td class="paramname"><em>dest</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decode a generic binary value as-is, as described by dest.info(), ad set it as value for <em>dest</em>. </p>
<p>It is assumed that <em>dest</em> is not set, therefore in case we decode a missing value, <em>dest</em> will not be touched.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>Variable which holds the decoding information and that will hold the decoded value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a072680dc21dba1822f3cca8cf73255a3"></a><!-- doxytag: member="wreport::bulletin::BufrInput::decode_number" ref="a072680dc21dba1822f3cca8cf73255a3" args="(Var &dest, uint32_t base, unsigned diffbits)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wreport::bulletin::BufrInput::decode_number </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwreport_1_1Var.html">Var</a> & </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>diffbits</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decode a compressed number as described by dest.info(), ad set it as value for <em>dest</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>Variable which holds the decoding information and that will hold the decoded value </td></tr>
<tr><td class="paramname">base</td><td>The base value for the compressed number </td></tr>
<tr><td class="paramname">diffbits</td><td>The number of bits used to encode the difference from <em>base</em> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a385af8f1a2ac0e8982b7398c1dfe1688"></a><!-- doxytag: member="wreport::bulletin::BufrInput::decode_number" ref="a385af8f1a2ac0e8982b7398c1dfe1688" args="(Var &dest)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wreport::bulletin::BufrInput::decode_number </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwreport_1_1Var.html">Var</a> & </td>
<td class="paramname"><em>dest</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decode a number as described by dest.info(), and set it as value for <em>dest</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>Variable which holds the decoding information and that will hold the decoded value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4c34a7d74c1efd1ba7c44a5355f2bea0"></a><!-- doxytag: member="wreport::bulletin::BufrInput::decode_number" ref="a4c34a7d74c1efd1ba7c44a5355f2bea0" args="(Var &dest, unsigned subsets)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wreport::bulletin::BufrInput::decode_number </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwreport_1_1Var.html">Var</a> & </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>subsets</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decode a number as described by dest.info(), and set it as value for <em>dest</em>. </p>
<p>The number is decoded for <em>subsets</em> compressed datasets, and an exception is thrown if the values differ.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>Variable which holds the decoding information and that will hold the decoded value </td></tr>
<tr><td class="paramname">subsets</td><td>Number of subsets in the compressed data section </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a029b8591bf1213e197bb57932724637f"></a><!-- doxytag: member="wreport::bulletin::BufrInput::decode_string" ref="a029b8591bf1213e197bb57932724637f" args="(unsigned bit_len, char *str, size_t &len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool wreport::bulletin::BufrInput::decode_string </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>bit_len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t & </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read a string from the data section. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">bit_len</td><td>Number of bits (not bytes) to read. It is normally a multiple of 8, and when it is not, the last character will contain the partial byte read. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">str</td><td>Buffer where the string is written. Must be big enough to contain the longest string described by info, plus 2 bytes </td></tr>
<tr><td class="paramname">len</td><td>The string length </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if we decoded a real string, false if we decoded a missing string value </dd></dl>
</div>
</div>
<a class="anchor" id="ad1e63aab63025601c73ee6599979070e"></a><!-- doxytag: member="wreport::bulletin::BufrInput::decode_string" ref="ad1e63aab63025601c73ee6599979070e" args="(Var &dest)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wreport::bulletin::BufrInput::decode_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwreport_1_1Var.html">Var</a> & </td>
<td class="paramname"><em>dest</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decode a string as described by dest.info(), ad set it as value for <em>dest</em>. </p>
<p>It is assumed that <em>dest</em> is not set, therefore in case we decode a missing value, <em>dest</em> will not be touched.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>Variable which holds the decoding information and that will hold the decoded value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7ec8a29b66756acc49d2d88ab633c7de"></a><!-- doxytag: member="wreport::bulletin::BufrInput::decode_string" ref="a7ec8a29b66756acc49d2d88ab633c7de" args="(Var &dest, unsigned subsets)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wreport::bulletin::BufrInput::decode_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwreport_1_1Var.html">Var</a> & </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>subsets</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decode a string as described by dest.info(), and set it as value for <em>dest</em>. </p>
<p>The string is decoded for <em>subsets</em> compressed datasets, and an exception is thrown if the values differ.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>Variable which holds the decoding information and that will hold the decoded value </td></tr>
<tr><td class="paramname">subsets</td><td>Number of subsets in the compressed data section </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad3f90a84734d1c5f2a12cfc7b1bcd63a"></a><!-- doxytag: member="wreport::bulletin::BufrInput::scan_lead_sections" ref="ad3f90a84734d1c5f2a12cfc7b1bcd63a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wreport::bulletin::BufrInput::scan_lead_sections </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Scan the message filling in the sec[] array of start offsets of sections 0 and 1. </p>
<p>We cannot scan past section 1 until we decode it, because we need to know if section 2 is present or not </p>
</div>
</div>
<a class="anchor" id="acdd2108497d9652c71f0eb2c65e18c6e"></a><!-- doxytag: member="wreport::bulletin::BufrInput::scan_other_sections" ref="acdd2108497d9652c71f0eb2c65e18c6e" args="(bool has_optional)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wreport::bulletin::BufrInput::scan_other_sections </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>has_optional</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Scan the message filling in the sec[] array of section start offsets of all sections from 2 on. </p>
<p>It also initialises points s4_cursor to the begin of the data in section 4.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">has_optional</td><td>True if the optional section is present, false if it should be skipped. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a896c8c05fc9af52a55580abe79f3a618"></a><!-- doxytag: member="wreport::bulletin::BufrInput::fname" ref="a896c8c05fc9af52a55580abe79f3a618" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a896c8c05fc9af52a55580abe79f3a618">wreport::bulletin::BufrInput::fname</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Input file name (optional). </p>
<p>If available, it will be used to generate better error messages.</p>
<p>If not available, it is NULL. </p>
</div>
</div>
<a class="anchor" id="a307187c5406bc39d674b10e00f0572c4"></a><!-- doxytag: member="wreport::bulletin::BufrInput::start_offset" ref="a307187c5406bc39d674b10e00f0572c4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classwreport_1_1bulletin_1_1BufrInput.html#a307187c5406bc39d674b10e00f0572c4">wreport::bulletin::BufrInput::start_offset</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>File offset of the start of the message. </p>
<p>If available, it will be used to generate better error messages.</p>
<p>If not available, it is 0. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="buffers_8h_source.html">buffers.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Jul 28 2011 00:13:15 for libwreport by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|