<!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: counter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ucommon</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.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 id="navrow2" class="tabs2">
<ul class="tablist">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00038.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>counter Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="counter" -->
<p>Automatic integer counting class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00181_source.html">counter.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for counter:</div>
<div class="dyncontent">
<div class="center"><img src="a00300.png" border="0" usemap="#counter_inherit__map" alt="Inheritance graph"/></div>
<map name="counter_inherit__map" id="counter_inherit__map">
<area shape="rect" id="node3" href="a00121.html" title="Automatically return a sequence of untyped objects." alt="" coords="20,80,143,107"/><area shape="rect" id="node5" href="a00122.html" title="A template to return a sequence of objects of a specified type." alt="" coords="5,155,157,181"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf68422e2ecf60e236b21bc407d43f05"></a><!-- doxytag: member="counter::counter" ref="aaf68422e2ecf60e236b21bc407d43f05" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#aaf68422e2ecf60e236b21bc407d43f05">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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a91fae9927692205788190dad4313ab1a">counter</a> (unsigned limit)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize integer counter for a range of values. <a href="#a91fae9927692205788190dad4313ab1a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a9added33c5db1f5881e13f00970d1fe7">get</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next counter value. <a href="#a9added33c5db1f5881e13f00970d1fe7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#ae350dc17a19fbfcadc992fe7249c96ee">operator unsigned</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference next counter value by casting to integer. <a href="#ae350dc17a19fbfcadc992fe7249c96ee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a1f5b95ad79e15cfda9cd9730c90f4f82">operator*</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference next counter value through pointer operation. <a href="#a1f5b95ad79e15cfda9cd9730c90f4f82"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a9916dd2a21fadcdb0d87ea1716cec0e8">operator=</a> (unsigned value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign the value of the counter. <a href="#a9916dd2a21fadcdb0d87ea1716cec0e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00038.html#a4e3a2a469529d1c29e8a95e3ae3f06e8">range</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the range of values before recycling. <a href="#a4e3a2a469529d1c29e8a95e3ae3f06e8"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><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="a00181_source.html#l00042">42</a> of file <a class="el" href="a00181_source.html">counter.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a91fae9927692205788190dad4313ab1a"></a><!-- doxytag: member="counter::counter" ref="a91fae9927692205788190dad4313ab1a" args="(unsigned limit)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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 class="params">
<tr><td class="paramname">limit</td><td>before recycling to zero. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9added33c5db1f5881e13f00970d1fe7"></a><!-- doxytag: member="counter::get" ref="a9added33c5db1f5881e13f00970d1fe7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned 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="a00121.html#abbcf81005279ff881c543431abb78cbd">SeqCounter</a>, and <a class="el" href="a00122.html#a3f77f9827b29f5c43df5d5f847324a2f">sequence< T ></a>.</p>
</div>
</div>
<a class="anchor" id="ae350dc17a19fbfcadc992fe7249c96ee"></a><!-- doxytag: member="counter::operator unsigned" ref="ae350dc17a19fbfcadc992fe7249c96ee" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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="a00181_source.html#l00083">83</a> of file <a class="el" href="a00181_source.html">counter.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1f5b95ad79e15cfda9cd9730c90f4f82"></a><!-- doxytag: member="counter::operator*" ref="a1f5b95ad79e15cfda9cd9730c90f4f82" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned 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="a00122.html#a9f15029d9ef7dcae6834914a1e56680e">sequence< T ></a>.</p>
<p>Definition at line <a class="el" href="a00181_source.html#l00076">76</a> of file <a class="el" href="a00181_source.html">counter.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9916dd2a21fadcdb0d87ea1716cec0e8"></a><!-- doxytag: member="counter::operator=" ref="a9916dd2a21fadcdb0d87ea1716cec0e8" args="(unsigned value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void 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 class="params">
<tr><td class="paramname">value</td><td>to assign. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="a00121.html#ac2bf77e941f997b9123156e55ee0b95a">SeqCounter</a>.</p>
</div>
</div>
<a class="anchor" id="a4e3a2a469529d1c29e8a95e3ae3f06e8"></a><!-- doxytag: member="counter::range" ref="a4e3a2a469529d1c29e8a95e3ae3f06e8" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned 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="a00181_source.html#l00069">69</a> of file <a class="el" href="a00181_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="a00181_source.html">counter.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00038.html">counter</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:47 for ucommon by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
