Files
assaultcube-/source/doxygen/html/structringbuf.html
T
driAn 44ef9c1cf8 added doxygen source code docs
git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@3951 e016b1c5-ed68-44aa-a2f7-31cac88cffde
2008-12-08 21:10:24 +00:00

338 lines
13 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>AssaultCube: ringbuf&lt; T, SIZE &gt; Struct Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>ringbuf&lt; T, SIZE &gt; Struct Template Reference</h1><!-- doxytag: class="ringbuf" --><code>#include &lt;tools.h&gt;</code>
<p>
<p>
<a href="structringbuf-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structringbuf.html#da02e16e61885721c0e74fa65d2cc029">ringbuf</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structringbuf.html#afc0b4ad26cb26ca24244aef79d4822a">clear</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structringbuf.html#575fd7a9b39b7a15061f08b3d7e26e24">empty</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structringbuf.html#611b0e27784266ff0fee1433c477a149">maxsize</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structringbuf.html#ac33edac207a3289bfd73276921532f0">length</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structringbuf.html#bca4dcb620ad265ed050d38f69c45d03">remove</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structringbuf.html#83d0bf483c930d452129a76a58af0f53">add</a> (const T &amp;e)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structringbuf.html#b16e45010d60a92f1a16f4ccc08ebaf4">add</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structringbuf.html#bfbda000a487f0af8a1625f323f72eb5">operator[]</a> (int i)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structringbuf.html#d81f66bcdf424c77f79ecd46c1d12ee4">operator[]</a> (int i) const </td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structringbuf.html#5193cbe16bcba3cf9aa39401cf192c80">index</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structringbuf.html#2a49fa7f0c217b786cc418cd81a02a50">len</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structringbuf.html#b22b6f06975f588d2f74008c6e34ceb0">data</a> [SIZE]</td></tr>
</table>
<h3>template&lt;class T, int SIZE&gt;<br>
struct ringbuf&lt; T, SIZE &gt;</h3>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="da02e16e61885721c0e74fa65d2cc029"></a><!-- doxytag: member="ringbuf::ringbuf" ref="da02e16e61885721c0e74fa65d2cc029" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , int SIZE&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structringbuf.html">ringbuf</a>&lt; T, SIZE &gt;::<a class="el" href="structringbuf.html">ringbuf</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b16e45010d60a92f1a16f4ccc08ebaf4"></a><!-- doxytag: member="ringbuf::add" ref="b16e45010d60a92f1a16f4ccc08ebaf4" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , int SIZE&gt; </div>
<table class="memname">
<tr>
<td class="memname">T&amp; <a class="el" href="structringbuf.html">ringbuf</a>&lt; T, SIZE &gt;::add </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="83d0bf483c930d452129a76a58af0f53"></a><!-- doxytag: member="ringbuf::add" ref="83d0bf483c930d452129a76a58af0f53" args="(const T &amp;e)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , int SIZE&gt; </div>
<table class="memname">
<tr>
<td class="memname">T&amp; <a class="el" href="structringbuf.html">ringbuf</a>&lt; T, SIZE &gt;::add </td>
<td>(</td>
<td class="paramtype">const T &amp;&nbsp;</td>
<td class="paramname"> <em>e</em> </td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="afc0b4ad26cb26ca24244aef79d4822a"></a><!-- doxytag: member="ringbuf::clear" ref="afc0b4ad26cb26ca24244aef79d4822a" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , int SIZE&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structringbuf.html">ringbuf</a>&lt; T, SIZE &gt;::clear </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="575fd7a9b39b7a15061f08b3d7e26e24"></a><!-- doxytag: member="ringbuf::empty" ref="575fd7a9b39b7a15061f08b3d7e26e24" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , int SIZE&gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="structringbuf.html">ringbuf</a>&lt; T, SIZE &gt;::empty </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ac33edac207a3289bfd73276921532f0"></a><!-- doxytag: member="ringbuf::length" ref="ac33edac207a3289bfd73276921532f0" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , int SIZE&gt; </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structringbuf.html">ringbuf</a>&lt; T, SIZE &gt;::length </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="611b0e27784266ff0fee1433c477a149"></a><!-- doxytag: member="ringbuf::maxsize" ref="611b0e27784266ff0fee1433c477a149" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , int SIZE&gt; </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structringbuf.html">ringbuf</a>&lt; T, SIZE &gt;::maxsize </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="d81f66bcdf424c77f79ecd46c1d12ee4"></a><!-- doxytag: member="ringbuf::operator[]" ref="d81f66bcdf424c77f79ecd46c1d12ee4" args="(int i) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , int SIZE&gt; </div>
<table class="memname">
<tr>
<td class="memname">const T&amp; <a class="el" href="structringbuf.html">ringbuf</a>&lt; T, SIZE &gt;::operator[] </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>i</em> </td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="bfbda000a487f0af8a1625f323f72eb5"></a><!-- doxytag: member="ringbuf::operator[]" ref="bfbda000a487f0af8a1625f323f72eb5" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , int SIZE&gt; </div>
<table class="memname">
<tr>
<td class="memname">T&amp; <a class="el" href="structringbuf.html">ringbuf</a>&lt; T, SIZE &gt;::operator[] </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>i</em> </td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="bca4dcb620ad265ed050d38f69c45d03"></a><!-- doxytag: member="ringbuf::remove" ref="bca4dcb620ad265ed050d38f69c45d03" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , int SIZE&gt; </div>
<table class="memname">
<tr>
<td class="memname">T&amp; <a class="el" href="structringbuf.html">ringbuf</a>&lt; T, SIZE &gt;::remove </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="b22b6f06975f588d2f74008c6e34ceb0"></a><!-- doxytag: member="ringbuf::data" ref="b22b6f06975f588d2f74008c6e34ceb0" args="[SIZE]" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , int SIZE&gt; </div>
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="structringbuf.html">ringbuf</a>&lt; T, SIZE &gt;::<a class="el" href="structringbuf.html#b22b6f06975f588d2f74008c6e34ceb0">data</a>[SIZE] </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="5193cbe16bcba3cf9aa39401cf192c80"></a><!-- doxytag: member="ringbuf::index" ref="5193cbe16bcba3cf9aa39401cf192c80" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , int SIZE&gt; </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structringbuf.html">ringbuf</a>&lt; T, SIZE &gt;::<a class="el" href="structringbuf.html#5193cbe16bcba3cf9aa39401cf192c80">index</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="2a49fa7f0c217b786cc418cd81a02a50"></a><!-- doxytag: member="ringbuf::len" ref="2a49fa7f0c217b786cc418cd81a02a50" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , int SIZE&gt; </div>
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structringbuf.html">ringbuf</a>&lt; T, SIZE &gt;::<a class="el" href="structringbuf.html#2a49fa7f0c217b786cc418cd81a02a50">len</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>R:/projects/actioncube/_svn/trunk/ac/source/src/<a class="el" href="tools_8h.html">tools.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 21:41:36 2008 for AssaultCube by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>