<!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>ANTLR Support Libraries 2.7.1+: CircularQueue< T > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<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">ANTLR Support Libraries 2.7.1+</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="pages.html"><span>Related Pages</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 id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<h1>CircularQueue< T > Class Template Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="CircularQueue" -->
<p><code>#include <<a class="el" href="CircularQueue_8hpp_source.html">CircularQueue.hpp</a>></code></p>
<p><a href="classCircularQueue-members.html">List of all members.</a></p>
<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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCircularQueue.html#afb497745b3a1e472ec670345328301a3">CircularQueue</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCircularQueue.html#ae983345f91859f4d532749f0b44531df">~CircularQueue</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCircularQueue.html#ad7e561e9d933428f8192caeac1a08799">clear</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the queue. <a href="#ad7e561e9d933428f8192caeac1a08799"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classCircularQueue.html#a38caa093ffd155a2a1b44cdad175a159">elementAt</a> (size_t idx) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCircularQueue.html#a6cb5b4274276ba1f68c57d7fe5aa4564">removeFirst</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCircularQueue.html#a28c7ee9875555136b7fb9e45c62a1815">removeItems</a> (size_t nb)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCircularQueue.html#ae7f30d29129bd056a7117901c20be924">append</a> (const T &t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCircularQueue.html#af939afde7102473828ee9da6f7a10bd2">entries</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCircularQueue.html#a95fc3a7030f33d7b29567e126ca96cce">CircularQueue</a> (const <a class="el" href="classCircularQueue.html">CircularQueue</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCircularQueue.html">CircularQueue</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCircularQueue.html#ad823856222334015e141c0d057836622">operator=</a> (const <a class="el" href="classCircularQueue.html">CircularQueue</a> &)</td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::vector< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCircularQueue.html#aef165383492ff44aa130d7c44e4885ab">storage</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCircularQueue.html#af8dc3a77badf84dae16a324d771afdee">m_offset</a></td></tr>
</table>
<h3>template<class T><br/>
class CircularQueue< T ></h3>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="afb497745b3a1e472ec670345328301a3"></a><!-- doxytag: member="CircularQueue::CircularQueue" ref="afb497745b3a1e472ec670345328301a3" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCircularQueue.html">CircularQueue</a>< T >::<a class="el" href="classCircularQueue.html">CircularQueue</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae983345f91859f4d532749f0b44531df"></a><!-- doxytag: member="CircularQueue::~CircularQueue" ref="ae983345f91859f4d532749f0b44531df" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCircularQueue.html">CircularQueue</a>< T >::~<a class="el" href="classCircularQueue.html">CircularQueue</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a95fc3a7030f33d7b29567e126ca96cce"></a><!-- doxytag: member="CircularQueue::CircularQueue" ref="a95fc3a7030f33d7b29567e126ca96cce" args="(const CircularQueue &)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCircularQueue.html">CircularQueue</a>< T >::<a class="el" href="classCircularQueue.html">CircularQueue</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCircularQueue.html">CircularQueue</a>< T > & </td>
<td class="paramname"></td><td>)</td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae7f30d29129bd056a7117901c20be924"></a><!-- doxytag: member="CircularQueue::append" ref="ae7f30d29129bd056a7117901c20be924" args="(const T &t)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classCircularQueue.html">CircularQueue</a>< T >::append </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>t</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad7e561e9d933428f8192caeac1a08799"></a><!-- doxytag: member="CircularQueue::clear" ref="ad7e561e9d933428f8192caeac1a08799" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classCircularQueue.html">CircularQueue</a>< T >::clear </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>Clear the queue. </p>
</div>
</div>
<a class="anchor" id="a38caa093ffd155a2a1b44cdad175a159"></a><!-- doxytag: member="CircularQueue::elementAt" ref="a38caa093ffd155a2a1b44cdad175a159" args="(size_t idx) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="classCircularQueue.html">CircularQueue</a>< T >::elementAt </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>idx</em></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>this should use at or should have a check </dd></dl>
</div>
</div>
<a class="anchor" id="af939afde7102473828ee9da6f7a10bd2"></a><!-- doxytag: member="CircularQueue::entries" ref="af939afde7102473828ee9da6f7a10bd2" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classCircularQueue.html">CircularQueue</a>< T >::entries </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad823856222334015e141c0d057836622"></a><!-- doxytag: member="CircularQueue::operator=" ref="ad823856222334015e141c0d057836622" args="(const CircularQueue &)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCircularQueue.html">CircularQueue</a>& <a class="el" href="classCircularQueue.html">CircularQueue</a>< T >::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCircularQueue.html">CircularQueue</a>< T > & </td>
<td class="paramname"></td><td>)</td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6cb5b4274276ba1f68c57d7fe5aa4564"></a><!-- doxytag: member="CircularQueue::removeFirst" ref="a6cb5b4274276ba1f68c57d7fe5aa4564" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classCircularQueue.html">CircularQueue</a>< T >::removeFirst </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a28c7ee9875555136b7fb9e45c62a1815"></a><!-- doxytag: member="CircularQueue::removeItems" ref="a28c7ee9875555136b7fb9e45c62a1815" args="(size_t nb)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classCircularQueue.html">CircularQueue</a>< T >::removeItems </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>nb</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="af8dc3a77badf84dae16a324d771afdee"></a><!-- doxytag: member="CircularQueue::m_offset" ref="af8dc3a77badf84dae16a324d771afdee" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classCircularQueue.html">CircularQueue</a>< T >::<a class="el" href="classCircularQueue.html#af8dc3a77badf84dae16a324d771afdee">m_offset</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aef165383492ff44aa130d7c44e4885ab"></a><!-- doxytag: member="CircularQueue::storage" ref="aef165383492ff44aa130d7c44e4885ab" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T> </div>
<table class="memname">
<tr>
<td class="memname">std ::vector<T> <a class="el" href="classCircularQueue.html">CircularQueue</a>< T >::<a class="el" href="classCircularQueue.html#aef165383492ff44aa130d7c44e4885ab">storage</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>antlr/<a class="el" href="CircularQueue_8hpp_source.html">CircularQueue.hpp</a></li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Fri Mar 25 2011 for ANTLR Support Libraries 2.7.1+ by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
