<!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>GNU CommonC++: ost::Counter< T > Class Template 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="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>Classes</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>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_counter.html">Counter</a> </div> </div> <div class="contents"> <h1>ost::Counter< T > Class Template Reference</h1><!-- doxytag: class="ost::Counter" --> <p>The counter template is used for generic objects which act as automatic counters. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="counter_8h_source.html">counter.h</a>></code></p> <p><a href="classost_1_1_counter-members.html">List of all members.</a></p> <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="classost_1_1_counter.html#a0ca3f00d6579ac58b73a3eefad7bd500">Counter</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct and initialize a counter to zero. <a href="#a0ca3f00d6579ac58b73a3eefad7bd500"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_counter.html#a72566efdf6945f365cf2cea829cfe8e6">Counter</a> (const <a class="el" href="classost_1_1_counter.html">Counter</a> &counter)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a counter with an initial value set for another counter. <a href="#a72566efdf6945f365cf2cea829cfe8e6"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_counter.html#a98e9b0cb62a7573bcd43c95603e9d68e">Counter</a> (T initial)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a counter with an initial value of the specified data type. <a href="#a98e9b0cb62a7573bcd43c95603e9d68e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_counter.html#a882ad1e55337322c5411df8ecd54760d">operator=</a> (T c)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_counter.html#a94c990fddd398cbfeeaff42cb08f0a61">operator T</a> ()</td></tr> <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_counter.html#a1bdf329c488d8c1e51bcfe859084998f">count</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <h3>template<typename T><br/> class ost::Counter< T ></h3> <p>The counter template is used for generic objects which act as automatic counters. </p> <p>Each time the object is accessed, the underlying counted data type is incremented.</p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> Automatic counter template class. </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a0ca3f00d6579ac58b73a3eefad7bd500"></a><!-- doxytag: member="ost::Counter::Counter" ref="a0ca3f00d6579ac58b73a3eefad7bd500" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T > </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classost_1_1_counter.html">ost::Counter</a>< T >::<a class="el" href="classost_1_1_counter.html">Counter</a> </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Construct and initialize a counter to zero. </p> <p>References <a class="el" href="counter_8h_source.html#l00061">ost::Counter< T >::count</a>.</p> </div> </div> <a class="anchor" id="a72566efdf6945f365cf2cea829cfe8e6"></a><!-- doxytag: member="ost::Counter::Counter" ref="a72566efdf6945f365cf2cea829cfe8e6" args="(const Counter &counter)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T > </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classost_1_1_counter.html">ost::Counter</a>< T >::<a class="el" href="classost_1_1_counter.html">Counter</a> </td> <td>(</td> <td class="paramtype">const <a class="el" href="classost_1_1_counter.html">Counter</a>< T > & </td> <td class="paramname"> <em>counter</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a counter with an initial value set for another 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>counter</em> </td><td>to copy from. </td></tr> </table> </dd> </dl> <p>References <a class="el" href="counter_8h_source.html#l00061">ost::Counter< T >::count</a>.</p> </div> </div> <a class="anchor" id="a98e9b0cb62a7573bcd43c95603e9d68e"></a><!-- doxytag: member="ost::Counter::Counter" ref="a98e9b0cb62a7573bcd43c95603e9d68e" args="(T initial)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T > </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classost_1_1_counter.html">ost::Counter</a>< T >::<a class="el" href="classost_1_1_counter.html">Counter</a> </td> <td>(</td> <td class="paramtype">T </td> <td class="paramname"> <em>initial</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a counter with an initial value of the specified data type. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>initial</em> </td><td>value to set. </td></tr> </table> </dd> </dl> <p>References <a class="el" href="counter_8h_source.html#l00061">ost::Counter< T >::count</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a94c990fddd398cbfeeaff42cb08f0a61"></a><!-- doxytag: member="ost::Counter::operator T" ref="a94c990fddd398cbfeeaff42cb08f0a61" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T > </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classost_1_1_counter.html">ost::Counter</a>< T >::operator T </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="counter_8h_source.html#l00061">ost::Counter< T >::count</a>.</p> </div> </div> <a class="anchor" id="a882ad1e55337322c5411df8ecd54760d"></a><!-- doxytag: member="ost::Counter::operator=" ref="a882ad1e55337322c5411df8ecd54760d" args="(T c)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T > </div> <table class="memname"> <tr> <td class="memname">T& <a class="el" href="classost_1_1_counter.html">ost::Counter</a>< T >::operator= </td> <td>(</td> <td class="paramtype">T </td> <td class="paramname"> <em>c</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a1bdf329c488d8c1e51bcfe859084998f"></a><!-- doxytag: member="ost::Counter::count" ref="a1bdf329c488d8c1e51bcfe859084998f" args="" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T > </div> <table class="memname"> <tr> <td class="memname">T <a class="el" href="classost_1_1_counter.html">ost::Counter</a>< T >::<a class="el" href="classost_1_1_counter.html#a1bdf329c488d8c1e51bcfe859084998f">count</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="counter_8h_source.html#l00067">ost::Counter< T >::Counter()</a>, and <a class="el" href="counter_8h_source.html#l00090">ost::Counter< T >::operator T()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="counter_8h_source.html">counter.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:46 2010 for GNU CommonC++ 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>