← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/a00056.html

  • Committer: Bazaar Package Importer
  • Author(s): Roberto C. Sanchez
  • Date: 2010-01-24 14:45:39 UTC
  • mfrom: (4.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20100124144539-4ipk5rt64dpp38hl
Tags: 3.6.3-1
* New upstream release
* debian/patches/config.guess.patch: drop obsolete patch
* Add ${misc:Depends} as requested by lintian

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/a00056.html
2
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
 
<title>BitMagic: bm::decoder_range_adapter&lt; DEC &gt; Class Template Reference</title>
 
5
<title>BitMagic: bm::decoder_little_endian Class Reference</title>
6
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8
8
</head>
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="a00110.html">bm</a>::<a class="el" href="a00056.html">decoder_range_adapter</a>
 
30
  <div class="navpath"><a class="el" href="a00115.html">bm</a>::<a class="el" href="a00056.html">decoder_little_endian</a>
31
31
  </div>
32
32
</div>
33
33
<div class="contents">
34
 
<h1>bm::decoder_range_adapter&lt; DEC &gt; Class Template Reference</h1><!-- doxytag: class="bm::decoder_range_adapter" -->
35
 
<p>Adapter to get words from a range stream (see range serialized bit-block).  
 
34
<h1>bm::decoder_little_endian Class Reference</h1><!-- doxytag: class="bm::decoder_little_endian" --><!-- doxytag: inherits="bm::decoder_base" -->
 
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="a00090_source.html">bmfunc.h</a>&gt;</code></p>
 
38
<p><code>#include &lt;<a class="el" href="a00104_source.html">encoding.h</a>&gt;</code></p>
 
39
<div class="dynheader">
 
40
Inheritance diagram for bm::decoder_little_endian:</div>
 
41
<div class="dynsection">
 
42
<div class="center"><img src="a00251.png" border="0" usemap="#bm_1_1decoder__little__endian_inherit__map" alt="Inheritance graph"/></div>
 
43
<map name="bm_1_1decoder__little__endian_inherit__map" id="bm_1_1decoder__little__endian_inherit__map">
 
44
<area shape="rect" href="a00055.html" title="Base class for all decoding functionality." alt="" coords="25,5,153,35"/></map>
 
45
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
 
46
<div class="dynheader">
 
47
Collaboration diagram for bm::decoder_little_endian:</div>
 
48
<div class="dynsection">
 
49
<div class="center"><img src="a00252.png" border="0" usemap="#bm_1_1decoder__little__endian_coll__map" alt="Collaboration graph"/></div>
 
50
<map name="bm_1_1decoder__little__endian_coll__map" id="bm_1_1decoder__little__endian_coll__map">
 
51
<area shape="rect" href="a00055.html" title="Base class for all decoding functionality." alt="" coords="25,5,153,35"/></map>
 
52
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
39
53
<table border="0" cellpadding="0" cellspacing="0">
40
54
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
41
 
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00056.html#acef081bdb43b428cb65663ad422b2bd3">decoder_range_adapter</a> (DEC &amp;dec, unsigned from_idx, unsigned to_idx)</td></tr>
42
 
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00110.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00056.html#a42cd4bd363dec579dab6c0f5b2939562">get_32</a> ()</td></tr>
 
55
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00056.html#a1aee284359f10343a5d1ade55989d15f">decoder_little_endian</a> (const unsigned char *buf)</td></tr>
 
56
<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="a00056.html#a31c8948b643386f31a5fe746ad4a6aff">get_16</a> ()</td></tr>
 
57
<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="a00056.html#a24bb08a1d40e448fbf5152967da33ed3">get_32</a> ()</td></tr>
 
58
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00056.html#a3326441838c8da6df923f0a9de26406d">get_32</a> (<a class="el" href="a00115.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> *w, unsigned count)</td></tr>
 
59
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00056.html#acd341677f0b429337cebd4e1ead10561">get_16</a> (<a class="el" href="a00115.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a> *s, unsigned count)</td></tr>
43
60
</table>
44
61
<hr/><a name="_details"></a><h2>Detailed Description</h2>
45
 
<h3>template&lt;class DEC&gt;<br/>
46
 
 class bm::decoder_range_adapter&lt; DEC &gt;</h3>
47
 
 
48
 
<p>Adapter to get words from a range stream (see range serialized bit-block). </p>
49
 
 
50
 
<p>Definition at line <a class="el" href="a00090_source.html#l04598">4598</a> of file <a class="el" href="a00090_source.html">bmfunc.h</a>.</p>
 
62
<p>Class for decoding data from memory buffer. </p>
 
63
<p>Properly handles aligment issues with integer data types. Converts data to little endian architecture (presumed it was encoded as big endian) </p>
 
64
 
 
65
<p>Definition at line <a class="el" href="a00104_source.html#l00124">124</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
51
66
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
52
 
<a class="anchor" id="acef081bdb43b428cb65663ad422b2bd3"></a><!-- doxytag: member="bm::decoder_range_adapter::decoder_range_adapter" ref="acef081bdb43b428cb65663ad422b2bd3" args="(DEC &amp;dec, unsigned from_idx, unsigned to_idx)" -->
 
67
<a class="anchor" id="a1aee284359f10343a5d1ade55989d15f"></a><!-- doxytag: member="bm::decoder_little_endian::decoder_little_endian" ref="a1aee284359f10343a5d1ade55989d15f" args="(const unsigned char *buf)" -->
53
68
<div class="memitem">
54
69
<div class="memproto">
55
 
<div class="memtemplate">
56
 
template&lt;class DEC &gt; </div>
57
70
      <table class="memname">
58
71
        <tr>
59
 
          <td class="memname"><a class="el" href="a00056.html">bm::decoder_range_adapter</a>&lt; DEC &gt;::<a class="el" href="a00056.html">decoder_range_adapter</a> </td>
 
72
          <td class="memname">bm::decoder_little_endian::decoder_little_endian </td>
60
73
          <td>(</td>
61
 
          <td class="paramtype">DEC &amp;&nbsp;</td>
62
 
          <td class="paramname"> <em>dec</em>, </td>
63
 
        </tr>
64
 
        <tr>
65
 
          <td class="paramkey"></td>
66
 
          <td></td>
67
 
          <td class="paramtype">unsigned&nbsp;</td>
68
 
          <td class="paramname"> <em>from_idx</em>, </td>
69
 
        </tr>
70
 
        <tr>
71
 
          <td class="paramkey"></td>
72
 
          <td></td>
73
 
          <td class="paramtype">unsigned&nbsp;</td>
74
 
          <td class="paramname"> <em>to_idx</em></td><td>&nbsp;</td>
75
 
        </tr>
76
 
        <tr>
77
 
          <td></td>
78
 
          <td>)</td>
79
 
          <td></td><td></td><td><code> [inline]</code></td>
 
74
          <td class="paramtype">const unsigned char *&nbsp;</td>
 
75
          <td class="paramname"> <em>buf</em></td>
 
76
          <td>&nbsp;)&nbsp;</td>
 
77
          <td><code> [inline]</code></td>
80
78
        </tr>
81
79
      </table>
82
80
</div>
83
81
<div class="memdoc">
84
82
 
85
 
<p>Definition at line <a class="el" href="a00090_source.html#l04601">4601</a> of file <a class="el" href="a00090_source.html">bmfunc.h</a>.</p>
 
83
<p>Definition at line <a class="el" href="a00104_source.html#l00795">795</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
86
84
 
87
85
</div>
88
86
</div>
89
87
<hr/><h2>Member Function Documentation</h2>
90
 
<a class="anchor" id="a42cd4bd363dec579dab6c0f5b2939562"></a><!-- doxytag: member="bm::decoder_range_adapter::get_32" ref="a42cd4bd363dec579dab6c0f5b2939562" args="()" -->
91
 
<div class="memitem">
92
 
<div class="memproto">
93
 
<div class="memtemplate">
94
 
template&lt;class DEC &gt; </div>
95
 
      <table class="memname">
96
 
        <tr>
97
 
          <td class="memname"><a class="el" href="a00110.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> <a class="el" href="a00056.html">bm::decoder_range_adapter</a>&lt; DEC &gt;::get_32 </td>
98
 
          <td>(</td>
99
 
          <td class="paramname"></td>
100
 
          <td>&nbsp;)&nbsp;</td>
101
 
          <td><code> [inline]</code></td>
102
 
        </tr>
103
 
      </table>
104
 
</div>
105
 
<div class="memdoc">
106
 
 
107
 
<p>Definition at line <a class="el" href="a00090_source.html#l04608">4608</a> of file <a class="el" href="a00090_source.html">bmfunc.h</a>.</p>
 
88
<a class="anchor" id="acd341677f0b429337cebd4e1ead10561"></a><!-- doxytag: member="bm::decoder_little_endian::get_16" ref="acd341677f0b429337cebd4e1ead10561" args="(bm::short_t *s, unsigned count)" -->
 
89
<div class="memitem">
 
90
<div class="memproto">
 
91
      <table class="memname">
 
92
        <tr>
 
93
          <td class="memname">void bm::decoder_little_endian::get_16 </td>
 
94
          <td>(</td>
 
95
          <td class="paramtype"><a class="el" href="a00115.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a> *&nbsp;</td>
 
96
          <td class="paramname"> <em>s</em>, </td>
 
97
        </tr>
 
98
        <tr>
 
99
          <td class="paramkey"></td>
 
100
          <td></td>
 
101
          <td class="paramtype">unsigned&nbsp;</td>
 
102
          <td class="paramname"> <em>count</em></td><td>&nbsp;</td>
 
103
        </tr>
 
104
        <tr>
 
105
          <td></td>
 
106
          <td>)</td>
 
107
          <td></td><td></td><td><code> [inline]</code></td>
 
108
        </tr>
 
109
      </table>
 
110
</div>
 
111
<div class="memdoc">
 
112
 
 
113
<p>Definition at line <a class="el" href="a00104_source.html#l00835">835</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
114
 
 
115
<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>
 
116
 
 
117
</div>
 
118
</div>
 
119
<a class="anchor" id="a31c8948b643386f31a5fe746ad4a6aff"></a><!-- doxytag: member="bm::decoder_little_endian::get_16" ref="a31c8948b643386f31a5fe746ad4a6aff" args="()" -->
 
120
<div class="memitem">
 
121
<div class="memproto">
 
122
      <table class="memname">
 
123
        <tr>
 
124
          <td class="memname">BMFORCEINLINE <a class="el" href="a00115.html#ae64960202b691ae1b6efe5fec12cb5af">bm::short_t</a> bm::decoder_little_endian::get_16 </td>
 
125
          <td>(</td>
 
126
          <td class="paramname"></td>
 
127
          <td>&nbsp;)&nbsp;</td>
 
128
          <td></td>
 
129
        </tr>
 
130
      </table>
 
131
</div>
 
132
<div class="memdoc">
 
133
 
 
134
<p>Definition at line <a class="el" href="a00104_source.html#l00800">800</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
135
 
 
136
<p>References <a class="el" href="a00104_source.html#l00087">bm::decoder_base::buf_</a>.</p>
 
137
 
 
138
</div>
 
139
</div>
 
140
<a class="anchor" id="a3326441838c8da6df923f0a9de26406d"></a><!-- doxytag: member="bm::decoder_little_endian::get_32" ref="a3326441838c8da6df923f0a9de26406d" args="(bm::word_t *w, unsigned count)" -->
 
141
<div class="memitem">
 
142
<div class="memproto">
 
143
      <table class="memname">
 
144
        <tr>
 
145
          <td class="memname">void bm::decoder_little_endian::get_32 </td>
 
146
          <td>(</td>
 
147
          <td class="paramtype"><a class="el" href="a00115.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> *&nbsp;</td>
 
148
          <td class="paramname"> <em>w</em>, </td>
 
149
        </tr>
 
150
        <tr>
 
151
          <td class="paramkey"></td>
 
152
          <td></td>
 
153
          <td class="paramtype">unsigned&nbsp;</td>
 
154
          <td class="paramname"> <em>count</em></td><td>&nbsp;</td>
 
155
        </tr>
 
156
        <tr>
 
157
          <td></td>
 
158
          <td>)</td>
 
159
          <td></td><td></td><td><code> [inline]</code></td>
 
160
        </tr>
 
161
      </table>
 
162
</div>
 
163
<div class="memdoc">
 
164
 
 
165
<p>Definition at line <a class="el" href="a00104_source.html#l00815">815</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
166
 
 
167
<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>
 
168
 
 
169
</div>
 
170
</div>
 
171
<a class="anchor" id="a24bb08a1d40e448fbf5152967da33ed3"></a><!-- doxytag: member="bm::decoder_little_endian::get_32" ref="a24bb08a1d40e448fbf5152967da33ed3" args="()" -->
 
172
<div class="memitem">
 
173
<div class="memproto">
 
174
      <table class="memname">
 
175
        <tr>
 
176
          <td class="memname">BMFORCEINLINE <a class="el" href="a00115.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> bm::decoder_little_endian::get_32 </td>
 
177
          <td>(</td>
 
178
          <td class="paramname"></td>
 
179
          <td>&nbsp;)&nbsp;</td>
 
180
          <td></td>
 
181
        </tr>
 
182
      </table>
 
183
</div>
 
184
<div class="memdoc">
 
185
 
 
186
<p>Definition at line <a class="el" href="a00104_source.html#l00807">807</a> of file <a class="el" href="a00104_source.html">encoding.h</a>.</p>
 
187
 
 
188
<p>References <a class="el" href="a00104_source.html#l00087">bm::decoder_base::buf_</a>.</p>
108
189
 
109
190
</div>
110
191
</div>
111
192
<hr/>The documentation for this class was generated from the following file:<ul>
112
 
<li><a class="el" href="a00090_source.html">bmfunc.h</a></li>
 
193
<li><a class="el" href="a00104_source.html">encoding.h</a></li>
113
194
</ul>
114
195
</div>
115
 
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Nov 22 10:49:46 2009 for BitMagic by&nbsp;
 
196
<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Jan 8 20:09:20 2010 for BitMagic by&nbsp;
116
197
<a href="http://www.doxygen.org/index.html">
117
198
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
118
199
</body>