<!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: ucommon::objfifo< 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="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="a00208.html">ucommon</a>::<a class="el" href="a00097.html">objfifo</a>
</div>
</div>
<div class="contents">
<h1>ucommon::objfifo< T > Class Template Reference</h1><!-- doxytag: class="ucommon::objfifo" --><!-- doxytag: inherits="ucommon::OrderedIndex" -->
<p>Template for typesafe basic object fifo container.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00188_source.html">linked.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::objfifo< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00459.png" border="0" usemap="#ucommon_1_1objfifo_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1objfifo_3_01_t_01_4_inherit__map" id="ucommon_1_1objfifo_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00100.html" title="An index container for maintaining an ordered list of objects." alt="" coords="5,5,237,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::objfifo< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00460.png" border="0" usemap="#ucommon_1_1objfifo_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1objfifo_3_01_t_01_4_coll__map" id="ucommon_1_1objfifo_3_01_t_01_4_coll__map">
<area shape="rect" id="node2" href="a00100.html" title="An index container for maintaining an ordered list of objects." alt="" coords="15,280,247,307"/><area shape="rect" id="node4" href="a00101.html" title="A linked object base class for ordered objects." alt="" coords="9,176,252,203"/><area shape="rect" id="node6" href="a00067.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="15,91,247,117"/><area shape="rect" id="node8" href="a00095.html" title="A common base class for all managed objects." alt="" coords="5,5,256,32"/></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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#ae61f6c060963caf114cd07936a75aa8c">add</a> (T *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an object onto the object fifo. <a href="#ae61f6c060963caf114cd07936a75aa8c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d2149e36740ee2d9223b62260a62219"></a><!-- doxytag: member="ucommon::objfifo::objfifo" ref="a2d2149e36740ee2d9223b62260a62219" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#a2d2149e36740ee2d9223b62260a62219">objfifo</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new object stack. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#a00400fa58ef88606416c86a31a0d8827">pop</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pull (pop) an object from the object stack. <a href="#a00400fa58ef88606416c86a31a0d8827"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#a92c2022c6ac98684d153a0e272e9590b">pull</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pull an object from the object stack. <a href="#a92c2022c6ac98684d153a0e272e9590b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#a411103a216d38f9ac07e9780b6dce64d">push</a> (T *object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Push an object onto the object fifo. <a href="#a411103a216d38f9ac07e9780b6dce64d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br/>
class ucommon::objfifo< T ></h3>
<p>Template for typesafe basic object fifo container. </p>
<p>The object type, T, that is contained in the fifo must be derived from <a class="el" href="a00101.html" title="A linked object base class for ordered objects.">OrderedObject</a> or <a class="el" href="a00067.html" title="Common base class for all objects that can be formed into a linked list.">LinkedObject</a>. </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="a00188_source.html#l01189">1189</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae61f6c060963caf114cd07936a75aa8c"></a><!-- doxytag: member="ucommon::objfifo::add" ref="ae61f6c060963caf114cd07936a75aa8c" args="(T *object)" -->
<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="a00097.html">ucommon::objfifo</a>< T >::add </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add an object onto the object fifo. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>of specified type to push. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01208">1208</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00097_ae61f6c060963caf114cd07936a75aa8c_cgraph.png" border="0" usemap="#a00097_ae61f6c060963caf114cd07936a75aa8c_cgraph_map" alt=""></div>
<map name="a00097_ae61f6c060963caf114cd07936a75aa8c_cgraph_map" id="a00097_ae61f6c060963caf114cd07936a75aa8c_cgraph">
<area shape="rect" id="node3" href="a00208.html#a0a43af474b84d87df26aa4998bcebb02" title="Add a linked object onto a stack of linked objects." alt="" coords="287,5,428,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a00400fa58ef88606416c86a31a0d8827"></a><!-- doxytag: member="ucommon::objfifo::pop" ref="a00400fa58ef88606416c86a31a0d8827" args="(void)" -->
<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="a00097.html">ucommon::objfifo</a>< T >::pop </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>Pull (pop) an object from the object stack. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>object of specified type or NULL if empty. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01222">1222</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a92c2022c6ac98684d153a0e272e9590b"></a><!-- doxytag: member="ucommon::objfifo::pull" ref="a92c2022c6ac98684d153a0e272e9590b" args="(void)" -->
<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="a00097.html">ucommon::objfifo</a>< T >::pull </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>Pull an object from the object stack. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>object of specified type or NULL if empty. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01215">1215</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
</div>
</div>
<a class="anchor" id="a411103a216d38f9ac07e9780b6dce64d"></a><!-- doxytag: member="ucommon::objfifo::push" ref="a411103a216d38f9ac07e9780b6dce64d" args="(T *object)" -->
<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="a00097.html">ucommon::objfifo</a>< T >::push </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Push an object onto the object fifo. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>of specified type to push. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00188_source.html#l01201">1201</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00097_a411103a216d38f9ac07e9780b6dce64d_cgraph.png" border="0" usemap="#a00097_a411103a216d38f9ac07e9780b6dce64d_cgraph_map" alt=""></div>
<map name="a00097_a411103a216d38f9ac07e9780b6dce64d_cgraph_map" id="a00097_a411103a216d38f9ac07e9780b6dce64d_cgraph">
<area shape="rect" id="node3" href="a00208.html#a0a43af474b84d87df26aa4998bcebb02" title="Add a linked object onto a stack of linked objects." alt="" coords="297,5,439,32"/></map>
</div>
</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00188_source.html">linked.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:48 2011 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>
