/usr/share/doc/libucommon-dev/a00033.html is in libucommon-doc 3.2.0-0ubuntu1.
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 | <!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>UCommon: ucc::bitmap 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.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</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 class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00033.html">bitmap</a>
</div>
</div>
<div class="contents">
<h1>ucc::bitmap Class Reference</h1><!-- doxytag: class="ucc::bitmap" -->
<p>A class to access bit fields in external bitmaps.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00188_source.html">bitmap.h</a>></code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#af48da17e516f6c6ab7e16021e38b4a54">bus_t</a> { <br/>
<a class="el" href="a00033.html#af48da17e516f6c6ab7e16021e38b4a54a94ec75f939aa806686aba6e0782a254b">BMALLOC</a>,
<a class="el" href="a00033.html#af48da17e516f6c6ab7e16021e38b4a54a72926c53349714f7464bba6721aa5288">B8</a>,
<a class="el" href="a00033.html#af48da17e516f6c6ab7e16021e38b4a54a995e771179d3ed4f4e445c55ec216d45">B16</a>,
<a class="el" href="a00033.html#af48da17e516f6c6ab7e16021e38b4a54a6f111e67bc523aca5d0b78efb4c832f8">B32</a>,
<br/>
<a class="el" href="a00033.html#af48da17e516f6c6ab7e16021e38b4a54acede684262a8eb67310f84e959f3f574">B64</a>,
<b>BMIN</b> = BMALLOC,
<b>BMAX</b> = B64
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Specify data word size to use in accessing a bitmap. </p>
<a href="a00033.html#af48da17e516f6c6ab7e16021e38b4a54">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#a55c0fa7726f9ab9d1b99886a9ff4d9ba">bitmap</a> (size_t length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a bitmap to manipulate locally. <a href="#a55c0fa7726f9ab9d1b99886a9ff4d9ba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#a638af7ee107be06ddd8ae05eaf16472c">bitmap</a> (void *addr, size_t length, <a class="el" href="a00033.html#af48da17e516f6c6ab7e16021e38b4a54">bus_t</a> size=B8)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an object to reference the specified bitmap. <a href="#a638af7ee107be06ddd8ae05eaf16472c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a095908ac38520a74d533b27042f1d838"></a><!-- doxytag: member="ucc::bitmap::clear" ref="a095908ac38520a74d533b27042f1d838" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#a095908ac38520a74d533b27042f1d838">clear</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear (zero) all the bits in the bitmap. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#ac37a87cc9b5914b0313508354f00601a">get</a> (size_t offset) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a "bit" in the bitmap. <a href="#ac37a87cc9b5914b0313508354f00601a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#ac3b92e662f457e7dcf3d8c9204e49d52">set</a> (size_t offset, bool value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an individual bit in the bitmask. <a href="#ac3b92e662f457e7dcf3d8c9204e49d52"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00033.html#a915783f6a5ba3f99f5af5887fada3623">~bitmap</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy bitmap manipulation object. <a href="#a915783f6a5ba3f99f5af5887fada3623"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5d7cfe30b446529b01d9bfabb268270"></a><!-- doxytag: member="ucc::bitmap::memsize" ref="ad5d7cfe30b446529b01d9bfabb268270" args="(void) const " -->
unsigned </td><td class="memItemRight" valign="bottom"><b>memsize</b> (void) const </td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0767c6d71ce0355c867e5f519b2907ca"></a><!-- doxytag: member="ucc::bitmap::addr" ref="a0767c6d71ce0355c867e5f519b2907ca" args="" -->
addr_t </td><td class="memItemRight" valign="bottom"><b>addr</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b7f1ac57612ac04db02f8513cbdd958"></a><!-- doxytag: member="ucc::bitmap::bus" ref="a7b7f1ac57612ac04db02f8513cbdd958" args="" -->
<a class="el" href="a00033.html#af48da17e516f6c6ab7e16021e38b4a54">bus_t</a> </td><td class="memItemRight" valign="bottom"><b>bus</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb1a4bc471d6b679c5976b6e450085db"></a><!-- doxytag: member="ucc::bitmap::size" ref="aeb1a4bc471d6b679c5976b6e450085db" args="" -->
size_t </td><td class="memItemRight" valign="bottom"><b>size</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A class to access bit fields in external bitmaps. </p>
<p>The actual bitmap this object manipulates may not be stored in the obect. Bitmaps may be referenced on special memory mapped or i/o bus based devices or other structures that have varying data word sizes which may differ from the default cpu bus size. The bitmap class can be set to the preferred memory bus size of the specific external bitmap being used. Bitmap size may also be relevant when accessing individual bits in memory mapped device registers where performing refence and manipulations may change the state of the device and hence must be aligned with the device register being effected.</p>
<p>This class offers only the most basic bit manipulations, getting and setting individual bits in the bitmap. More advanced bit manipulations and other operations can be created in derived classes. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00051">51</a> of file <a class="el" href="a00188_source.html">bitmap.h</a>.</p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="af48da17e516f6c6ab7e16021e38b4a54"></a><!-- doxytag: member="ucc::bitmap::bus_t" ref="af48da17e516f6c6ab7e16021e38b4a54" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00033.html#af48da17e516f6c6ab7e16021e38b4a54">ucc::bitmap::bus_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specify data word size to use in accessing a bitmap. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="af48da17e516f6c6ab7e16021e38b4a54a94ec75f939aa806686aba6e0782a254b"></a><!-- doxytag: member="BMALLOC" ref="af48da17e516f6c6ab7e16021e38b4a54a94ec75f939aa806686aba6e0782a254b" args="" -->BMALLOC</em> </td><td>
<p>Use default cpu size. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="af48da17e516f6c6ab7e16021e38b4a54a72926c53349714f7464bba6721aa5288"></a><!-- doxytag: member="B8" ref="af48da17e516f6c6ab7e16021e38b4a54a72926c53349714f7464bba6721aa5288" args="" -->B8</em> </td><td>
<p>Accessing a bitmap on 8 bit bus device. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="af48da17e516f6c6ab7e16021e38b4a54a995e771179d3ed4f4e445c55ec216d45"></a><!-- doxytag: member="B16" ref="af48da17e516f6c6ab7e16021e38b4a54a995e771179d3ed4f4e445c55ec216d45" args="" -->B16</em> </td><td>
<p>Accessing a bitmap on a 16 bit device. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="af48da17e516f6c6ab7e16021e38b4a54a6f111e67bc523aca5d0b78efb4c832f8"></a><!-- doxytag: member="B32" ref="af48da17e516f6c6ab7e16021e38b4a54a6f111e67bc523aca5d0b78efb4c832f8" args="" -->B32</em> </td><td>
<p>Accessing a bitmap on a 32 bit device. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="af48da17e516f6c6ab7e16021e38b4a54acede684262a8eb67310f84e959f3f574"></a><!-- doxytag: member="B64" ref="af48da17e516f6c6ab7e16021e38b4a54acede684262a8eb67310f84e959f3f574" args="" -->B64</em> </td><td>
<p>Accessing a bitmap on a 64 bit device. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00071">71</a> of file <a class="el" href="a00188_source.html">bitmap.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a638af7ee107be06ddd8ae05eaf16472c"></a><!-- doxytag: member="ucc::bitmap::bitmap" ref="a638af7ee107be06ddd8ae05eaf16472c" args="(void *addr, size_t length, bus_t size=B8)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::bitmap::bitmap </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00033.html#af48da17e516f6c6ab7e16021e38b4a54">bus_t</a> </td>
<td class="paramname"> <em>size</em> = <code>B8</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an object to reference the specified bitmap. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>of the bitmap in mapped memory. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>of the bitmap being accessed in bits. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of the memory bus or manipulation to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a55c0fa7726f9ab9d1b99886a9ff4d9ba"></a><!-- doxytag: member="ucc::bitmap::bitmap" ref="a55c0fa7726f9ab9d1b99886a9ff4d9ba" args="(size_t length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::bitmap::bitmap </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>length</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a bitmap to manipulate locally. </p>
<p>This bitmap is created as part of the object itself, and uses the BMALLOC bus mode. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>of bitmap to create in bits. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a915783f6a5ba3f99f5af5887fada3623"></a><!-- doxytag: member="ucc::bitmap::~bitmap" ref="a915783f6a5ba3f99f5af5887fada3623" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::bitmap::~bitmap </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy bitmap manipulation object. </p>
<p>If a bitmap was locally created with the alternate constructor, that bitmap will also be removed from memory. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac37a87cc9b5914b0313508354f00601a"></a><!-- doxytag: member="ucc::bitmap::get" ref="ac37a87cc9b5914b0313508354f00601a" args="(size_t offset) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::bitmap::get </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>offset</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the value of a "bit" in the bitmap. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>to bit in map to get. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if bit is set. </dd></dl>
</div>
</div>
<a class="anchor" id="ac3b92e662f457e7dcf3d8c9204e49d52"></a><!-- doxytag: member="ucc::bitmap::set" ref="ac3b92e662f457e7dcf3d8c9204e49d52" args="(size_t offset, bool value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::bitmap::set </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set an individual bit in the bitmask. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>to bit in map to change. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>to change specified bit to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00188_source.html">bitmap.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:26 2010 for UCommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|