← Back to branch summary

~ubuntu-branches/ubuntu/trusty/bmagic/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/html/a00054.html

  • Committer: Bazaar Package Importer
  • Author(s): Roberto C. Sanchez
  • Date: 2010-04-08 16:47:58 UTC
  • mfrom: (4.1.7 sid)
  • Revision ID: james.westby@ubuntu.com-20100408164758-3vu6wmrk1dnzqnnj
Tags: 3.6.4-1
* New upstream release
* Update to Standards-Version 3.8.4 (no changes)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/a00054.html
27
27
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
28
28
    </ul>
29
29
  </div>
30
 
  <div class="navpath"><a class="el" href="a00115.html">bm</a>::<a class="el" href="a00054.html">decoder</a>
 
30
  <div class="navpath"><a class="el" href="a00116.html">bm</a>::<a class="el" href="a00054.html">decoder</a>
31
31
  </div>
32
32
</div>
33
33
<div class="contents">
35
35
<p>Class for decoding data from memory buffer.  
36
36
<a href="#_details">More...</a></p>
37
37
 
38
 
<p><code>#include &lt;<a class="el" href="a00104_source.html">encoding.h</a>&gt;</code></p>
 
38
<p><code>#include &lt;<a class="el" href="a00105_source.html">encoding.h</a>&gt;</code></p>
39
39
<div class="dynheader">
40
40
Inheritance diagram for bm::decoder:</div>
41
41
<div class="dynsection">
42
 
<div class="center"><img src="a00249.png" border="0" usemap="#bm_1_1decoder_inherit__map" alt="Inheritance graph"/></div>
 
42
<div class="center"><img src="a00251.png" border="0" usemap="#bm_1_1decoder_inherit__map" alt="Inheritance graph"/></div>
43
43
<map name="bm_1_1decoder_inherit__map" id="bm_1_1decoder_inherit__map">
44
44
<area shape="rect" href="a00055.html" title="Base class for all decoding functionality." alt="" coords="5,5,133,35"/></map>
45
45
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
46
46
<div class="dynheader">
47
47
Collaboration diagram for bm::decoder:</div>
48
48
<div class="dynsection">
49
 
<div class="center"><img src="a00250.png" border="0" usemap="#bm_1_1decoder_coll__map" alt="Collaboration graph"/></div>
 
49
<div class="center"><img src="a00252.png" border="0" usemap="#bm_1_1decoder_coll__map" alt="Collaboration graph"/></div>
50
50
<map name="bm_1_1decoder_coll__map" id="bm_1_1decoder_coll__map">
51
51
<area shape="rect" href="a00055.html" title="Base class for all decoding functionality." alt="" coords="5,5,133,35"/></map>
52
52
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
54
54
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
55
55
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a73bf9b02a979483dcb1b06f71191a358">decoder</a> (const unsigned char *buf)</td></tr>
56
56
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construction.  <a href="#a73bf9b02a979483dcb1b06f71191a358"></a><br/></td></tr>
57
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00115.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a870cab2b7facfd504cc094bcfcbe0fd5">get_16</a> ()</td></tr>
 
57
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00116.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a870cab2b7facfd504cc094bcfcbe0fd5">get_16</a> ()</td></tr>
58
58
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads 16bit word from the decoding buffer.  <a href="#a870cab2b7facfd504cc094bcfcbe0fd5"></a><br/></td></tr>
59
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00115.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a14e9ecc4a864b259ee445c2cf434df96">get_32</a> ()</td></tr>
 
59
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00116.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a14e9ecc4a864b259ee445c2cf434df96">get_32</a> ()</td></tr>
60
60
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads 32 bit word from the decoding buffer.  <a href="#a14e9ecc4a864b259ee445c2cf434df96"></a><br/></td></tr>
61
 
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a216e3cd09d77a216ded7038e676f79d5">get_32</a> (<a class="el" href="a00115.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> *w, unsigned count)</td></tr>
 
61
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a216e3cd09d77a216ded7038e676f79d5">get_32</a> (<a class="el" href="a00116.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> *w, unsigned count)</td></tr>
62
62
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads block of 32-bit words from the decoding buffer.  <a href="#a216e3cd09d77a216ded7038e676f79d5"></a><br/></td></tr>
63
 
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a053d500db2a141a8f29a8a1f5431434d">get_16</a> (<a class="el" href="a00115.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a> *s, unsigned count)</td></tr>
 
63
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a053d500db2a141a8f29a8a1f5431434d">get_16</a> (<a class="el" href="a00116.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a> *s, unsigned count)</td></tr>
64
64
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reads block of 32-bit words from the decoding buffer.  <a href="#a053d500db2a141a8f29a8a1f5431434d"></a><br/></td></tr>
65
65
</table>
66
66
<hr/><a name="_details"></a><h2>Detailed Description</h2>
67
67
<p>Class for decoding data from memory buffer. </p>
68
68
<p>Properly handles aligment issues with integer data types. </p>
69
69
 
70
 
<p>Definition at line <a class="el" href="a00104_source.html#l00097">97</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
70
<p>Definition at line <a class="el" href="a00105_source.html#l00097">97</a> of file <a class="el" href="a00105_source.html">encoding.h</a>.</p>
71
71
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
72
72
<a class="anchor" id="a73bf9b02a979483dcb1b06f71191a358"></a><!-- doxytag: member="bm::decoder::decoder" ref="a73bf9b02a979483dcb1b06f71191a358" args="(const unsigned char *buf)" -->
73
73
<div class="memitem">
93
93
  </dd>
94
94
</dl>
95
95
 
96
 
<p>Definition at line <a class="el" href="a00104_source.html#l00687">687</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
96
<p>Definition at line <a class="el" href="a00105_source.html#l00687">687</a> of file <a class="el" href="a00105_source.html">encoding.h</a>.</p>
97
97
 
98
98
</div>
99
99
</div>
105
105
        <tr>
106
106
          <td class="memname">void bm::decoder::get_16 </td>
107
107
          <td>(</td>
108
 
          <td class="paramtype"><a class="el" href="a00115.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a> *&nbsp;</td>
 
108
          <td class="paramtype"><a class="el" href="a00116.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a> *&nbsp;</td>
109
109
          <td class="paramname"> <em>s</em>, </td>
110
110
        </tr>
111
111
        <tr>
132
132
  </dd>
133
133
</dl>
134
134
 
135
 
<p>Definition at line <a class="el" href="a00104_source.html#l00764">764</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
135
<p>Definition at line <a class="el" href="a00105_source.html#l00761">761</a> of file <a class="el" href="a00105_source.html">encoding.h</a>.</p>
136
136
 
137
 
<p>References <a class="el" href="a00104_source.html#l00087">bm::decoder_base::buf_</a>, and <a class="el" href="a00104_source.html#l00085">bm::decoder_base::seek()</a>.</p>
 
137
<p>References <a class="el" href="a00105_source.html#l00087">bm::decoder_base::buf_</a>, and <a class="el" href="a00105_source.html#l00085">bm::decoder_base::seek()</a>.</p>
138
138
 
139
139
</div>
140
140
</div>
143
143
<div class="memproto">
144
144
      <table class="memname">
145
145
        <tr>
146
 
          <td class="memname">BMFORCEINLINE <a class="el" href="a00115.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a> bm::decoder::get_16 </td>
 
146
          <td class="memname">BMFORCEINLINE <a class="el" href="a00116.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a> bm::decoder::get_16 </td>
147
147
          <td>(</td>
148
148
          <td class="paramname"></td>
149
149
          <td>&nbsp;)&nbsp;</td>
155
155
 
156
156
<p>Reads 16bit word from the decoding buffer. </p>
157
157
 
158
 
<p>Definition at line <a class="el" href="a00104_source.html#l00696">696</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
158
<p>Definition at line <a class="el" href="a00105_source.html#l00696">696</a> of file <a class="el" href="a00105_source.html">encoding.h</a>.</p>
159
159
 
160
 
<p>References <a class="el" href="a00104_source.html#l00087">bm::decoder_base::buf_</a>.</p>
 
160
<p>References <a class="el" href="a00105_source.html#l00087">bm::decoder_base::buf_</a>.</p>
161
161
 
162
162
</div>
163
163
</div>
168
168
        <tr>
169
169
          <td class="memname">void bm::decoder::get_32 </td>
170
170
          <td>(</td>
171
 
          <td class="paramtype"><a class="el" href="a00115.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> *&nbsp;</td>
 
171
          <td class="paramtype"><a class="el" href="a00116.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> *&nbsp;</td>
172
172
          <td class="paramname"> <em>w</em>, </td>
173
173
        </tr>
174
174
        <tr>
195
195
  </dd>
196
196
</dl>
197
197
 
198
 
<p>Definition at line <a class="el" href="a00104_source.html#l00730">730</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
198
<p>Definition at line <a class="el" href="a00105_source.html#l00730">730</a> of file <a class="el" href="a00105_source.html">encoding.h</a>.</p>
199
199
 
200
 
<p>References <a class="el" href="a00104_source.html#l00087">bm::decoder_base::buf_</a>, and <a class="el" href="a00104_source.html#l00085">bm::decoder_base::seek()</a>.</p>
 
200
<p>References <a class="el" href="a00105_source.html#l00087">bm::decoder_base::buf_</a>, and <a class="el" href="a00105_source.html#l00085">bm::decoder_base::seek()</a>.</p>
201
201
 
202
202
</div>
203
203
</div>
206
206
<div class="memproto">
207
207
      <table class="memname">
208
208
        <tr>
209
 
          <td class="memname">BMFORCEINLINE <a class="el" href="a00115.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> bm::decoder::get_32 </td>
 
209
          <td class="memname">BMFORCEINLINE <a class="el" href="a00116.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> bm::decoder::get_32 </td>
210
210
          <td>(</td>
211
211
          <td class="paramname"></td>
212
212
          <td>&nbsp;)&nbsp;</td>
218
218
 
219
219
<p>Reads 32 bit word from the decoding buffer. </p>
220
220
 
221
 
<p>Definition at line <a class="el" href="a00104_source.html#l00711">711</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
221
<p>Definition at line <a class="el" href="a00105_source.html#l00711">711</a> of file <a class="el" href="a00105_source.html">encoding.h</a>.</p>
222
222
 
223
 
<p>References <a class="el" href="a00104_source.html#l00087">bm::decoder_base::buf_</a>.</p>
 
223
<p>References <a class="el" href="a00105_source.html#l00087">bm::decoder_base::buf_</a>.</p>
224
224
 
225
225
</div>
226
226
</div>
227
227
<hr/>The documentation for this class was generated from the following file:<ul>
228
 
<li><a class="el" href="a00104_source.html">encoding.h</a></li>
 
228
<li><a class="el" href="a00105_source.html">encoding.h</a></li>
229
229
</ul>
230
230
</div>
231
 
<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Jan 8 20:09:20 2010 for BitMagic by&nbsp;
 
231
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Mar 23 20:48:13 2010 for BitMagic by&nbsp;
232
232
<a href="http://www.doxygen.org/index.html">
233
233
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
234
234
</body>