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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>BitMagic: bm::decoder Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="examples.html">Examples</a></div>
<div class="nav">
<a class="el" href="a00129.html">bm</a>::<a class="el" href="a00098.html">decoder</a></div>
<h1>bm::decoder Class Reference</h1>Class for decoding data from memory buffer.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="a00145.html">encoding.h</a>></code>
<p>
Inheritance diagram for bm::decoder:<p><center><img src="a00225.png" border="0" usemap="#a00226" alt="Inheritance graph"></center>
<map name="a00226">
<area href="a00099.html" shape="rect" coords="7,16,124,37" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for bm::decoder:<p><center><img src="a00227.png" border="0" usemap="#a00228" alt="Collaboration graph"></center>
<map name="a00228">
<area href="a00099.html" shape="rect" coords="7,16,124,37" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a0">decoder</a> (const unsigned char *buf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construction. <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00129.html#a28">bm::short_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a1">get_16</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads 16bit word from the decoding buffer. <a href="#a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00129.html#a27">bm::word_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a2">get_32</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads 32 bit word from the decoding buffer. <a href="#a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a3">get_32</a> (<a class="el" href="a00129.html#a27">bm::word_t</a> *w, unsigned count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads block of 32-bit words from the decoding buffer. <a href="#a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#a4">get_16</a> (<a class="el" href="a00129.html#a28">bm::short_t</a> *s, unsigned count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads block of 32-bit words from the decoding buffer. <a href="#a4"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class for decoding data from memory buffer.
<p>
Properly handles aligment issues with integer data types.
<p>
<p>
Definition at line <a class="el" href="a00145.html#l00087">87</a> of file <a class="el" href="a00145.html">encoding.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="bm::decoder::decoder"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bm::decoder::decoder </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const unsigned char * </td>
<td class="mdname1" valign="top" nowrap> <em>buf</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Construction.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>- pointer to the decoding memory. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="a00145.html#l00240">240</a> of file <a class="el" href="a00145.html">encoding.h</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a4" doxytag="bm::decoder::get_16"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void bm::decoder::get_16 </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="a00129.html#a28">bm::short_t</a> * </td>
<td class="mdname" nowrap> <em>s</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>count</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Reads block of 32-bit words from the decoding buffer.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>- pointer on memory block to read into. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>- size of memory block in words. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="a00145.html#l00300">300</a> of file <a class="el" href="a00145.html">encoding.h</a>.
<p>
References <a class="el" href="a00145.html#l00075">bm::decoder_base::seek()</a>. </td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="bm::decoder::get_16"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">BMFORCEINLINE <a class="el" href="a00129.html#a28">bm::short_t</a> bm::decoder::get_16 </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Reads 16bit word from the decoding buffer.
<p>
<p>
Definition at line <a class="el" href="a00145.html#l00249">249</a> of file <a class="el" href="a00145.html">encoding.h</a>.
<p>
References <a class="el" href="a00140.html#l00079">BMFORCEINLINE</a>. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="bm::decoder::get_32"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void bm::decoder::get_32 </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="a00129.html#a27">bm::word_t</a> * </td>
<td class="mdname" nowrap> <em>w</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>count</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Reads block of 32-bit words from the decoding buffer.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>w</em> </td><td>- pointer on memory block to read into. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>- size of memory block in words. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="a00145.html#l00275">275</a> of file <a class="el" href="a00145.html">encoding.h</a>.
<p>
References <a class="el" href="a00145.html#l00075">bm::decoder_base::seek()</a>. </td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="bm::decoder::get_32"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">BMFORCEINLINE <a class="el" href="a00129.html#a27">bm::word_t</a> bm::decoder::get_32 </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Reads 32 bit word from the decoding buffer.
<p>
<p>
Definition at line <a class="el" href="a00145.html#l00260">260</a> of file <a class="el" href="a00145.html">encoding.h</a>.
<p>
References <a class="el" href="a00140.html#l00079">BMFORCEINLINE</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00145.html">encoding.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Aug 5 14:12:41 2007 for BitMagic by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.1 </small></address>
</body>
</html>
|