/usr/share/doc/libucommon-dev/a00044.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 | <!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::counter 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="a00044.html">counter</a>
</div>
</div>
<div class="contents">
<h1>ucc::counter Class Reference</h1><!-- doxytag: class="ucc::counter" -->
<p>Automatic integer counting class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00190_source.html">counter.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::counter:</div>
<div class="dynsection">
<div class="center"><img src="a00379.png" border="0" usemap="#ucc_1_1counter_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1counter_inherit__map" id="ucc_1_1counter_inherit__map">
<area shape="rect" id="node3" href="a00133.html" title="Automatically return a sequence of untyped objects." alt="" coords="16,83,144,112"/><area shape="rect" id="node5" href="a00134.html" title="A template to return a sequence of objects of a specified type." alt="" coords="5,160,155,189"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<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="a00044.html#a514dad3df4c425f93c38d9f05d0e9b5a">counter</a> (unsigned limit)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize integer counter for a range of values. <a href="#a514dad3df4c425f93c38d9f05d0e9b5a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65de621abcc5ec528f1230031793b2b8"></a><!-- doxytag: member="ucc::counter::counter" ref="a65de621abcc5ec528f1230031793b2b8" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a65de621abcc5ec528f1230031793b2b8">counter</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize integer counter of unknown size. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ae0adbc74c3f99c0a00d03f23d59cfb0c">get</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next counter value. <a href="#ae0adbc74c3f99c0a00d03f23d59cfb0c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#af55807f889e554886eeaa7111a6206ea">operator unsigned</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference next counter value by casting to integer. <a href="#af55807f889e554886eeaa7111a6206ea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#aba86ea63fcf9c4116dec6658d6b40670">operator*</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference next counter value through pointer operation. <a href="#aba86ea63fcf9c4116dec6658d6b40670"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a3a3257238aacea56cf02492a440e79ed">operator=</a> (unsigned value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign the value of the counter. <a href="#a3a3257238aacea56cf02492a440e79ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#a3c0301be35aeb632cf6eea921b2614ce">range</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the range of values before recycling. <a href="#a3c0301be35aeb632cf6eea921b2614ce"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Automatic integer counting class. </p>
<p>This is an automatic counting object that is used to retrieve a new integer value between 0 and n each time the object is referenced. When reaching the last n value, the object restarts at 0, and so is used to retrieve a sequence of values in order. </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="a00190_source.html#l00042">42</a> of file <a class="el" href="a00190_source.html">counter.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a514dad3df4c425f93c38d9f05d0e9b5a"></a><!-- doxytag: member="ucc::counter::counter" ref="a514dad3df4c425f93c38d9f05d0e9b5a" args="(unsigned limit)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::counter::counter </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>limit</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize integer counter for a range of values. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>limit</em> </td><td>before recycling to zero. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae0adbc74c3f99c0a00d03f23d59cfb0c"></a><!-- doxytag: member="ucc::counter::get" ref="ae0adbc74c3f99c0a00d03f23d59cfb0c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ucc::counter::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the next counter value. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>next counter value. </dd></dl>
<p>Reimplemented in <a class="el" href="a00133.html#a2b719ff274df945d7ae4569ac74e2e41">ucc::SeqCounter</a>, and <a class="el" href="a00134.html#a079baf7abab8e81858f78e476208388c">ucc::sequence< T ></a>.</p>
</div>
</div>
<a class="anchor" id="af55807f889e554886eeaa7111a6206ea"></a><!-- doxytag: member="ucc::counter::operator unsigned" ref="af55807f889e554886eeaa7111a6206ea" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::counter::operator unsigned </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reference next counter value by casting to integer. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>next counter value. </dd></dl>
<p>Definition at line <a class="el" href="a00190_source.html#l00083">83</a> of file <a class="el" href="a00190_source.html">counter.h</a>.</p>
</div>
</div>
<a class="anchor" id="aba86ea63fcf9c4116dec6658d6b40670"></a><!-- doxytag: member="ucc::counter::operator*" ref="aba86ea63fcf9c4116dec6658d6b40670" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ucc::counter::operator* </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reference next counter value through pointer operation. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>next counter value. </dd></dl>
<p>Reimplemented in <a class="el" href="a00134.html#aedd0a5ac46dfaa4648665efa606a7e8b">ucc::sequence< T ></a>.</p>
<p>Definition at line <a class="el" href="a00190_source.html#l00076">76</a> of file <a class="el" href="a00190_source.html">counter.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3a3257238aacea56cf02492a440e79ed"></a><!-- doxytag: member="ucc::counter::operator=" ref="a3a3257238aacea56cf02492a440e79ed" args="(unsigned value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::counter::operator= </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign the value of the counter. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>to assign. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="a00133.html#a7738e422e207213ecad0ad07511e04bb">ucc::SeqCounter</a>.</p>
</div>
</div>
<a class="anchor" id="a3c0301be35aeb632cf6eea921b2614ce"></a><!-- doxytag: member="ucc::counter::range" ref="a3c0301be35aeb632cf6eea921b2614ce" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ucc::counter::range </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the range of values before recycling. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>counter limit. </dd></dl>
<p>Definition at line <a class="el" href="a00190_source.html#l00069">69</a> of file <a class="el" href="a00190_source.html">counter.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00190_source.html">counter.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:28 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>
|