<!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::objqueue< 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="a00098.html">objqueue</a> </div> </div> <div class="contents"> <h1>ucommon::objqueue< T > Class Template Reference</h1><!-- doxytag: class="ucommon::objqueue" --><!-- doxytag: inherits="ucommon::ObjectQueue" --> <p>Template for typesafe basic object queue 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::objqueue< T >:</div> <div class="dynsection"> <div class="center"><img src="a00461.png" border="0" usemap="#ucommon_1_1objqueue_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div> <map name="ucommon_1_1objqueue_3_01_t_01_4_inherit__map" id="ucommon_1_1objqueue_3_01_t_01_4_inherit__map"> <area shape="rect" id="node2" href="a00096.html" title="A queue of double linked object." alt="" coords="16,80,237,107"/><area shape="rect" id="node4" href="a00100.html" title="An index container for maintaining an ordered list of objects." alt="" coords="11,5,243,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::objqueue< T >:</div> <div class="dynsection"> <div class="center"><img src="a00462.png" border="0" usemap="#ucommon_1_1objqueue_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div> <map name="ucommon_1_1objqueue_3_01_t_01_4_coll__map" id="ucommon_1_1objqueue_3_01_t_01_4_coll__map"> <area shape="rect" id="node2" href="a00096.html" title="A queue of double linked object." alt="" coords="20,357,241,384"/><area shape="rect" id="node4" href="a00100.html" title="An index container for maintaining an ordered list of objects." alt="" coords="15,280,247,307"/><area shape="rect" id="node6" href="a00101.html" title="A linked object base class for ordered objects." alt="" coords="9,176,252,203"/><area shape="rect" id="node8" 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="node10" 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="a00098.html#a8e248eb6dd6748c4f40eef2c0e480f98">add</a> (T *object)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add an object to the end of the object queue. <a href="#a8e248eb6dd6748c4f40eef2c0e480f98"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc604150992dba96a6320a546344298d"></a><!-- doxytag: member="ucommon::objqueue::objqueue" ref="abc604150992dba96a6320a546344298d" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#abc604150992dba96a6320a546344298d">objqueue</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="a00098.html#ae90b5ae6fb29b765d43c5c5f68a01a1c">pop</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Pop an object from the end of the object queue. <a href="#ae90b5ae6fb29b765d43c5c5f68a01a1c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#ab95a0f5ab618822660792152e30f770a">pull</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Pull an object from the start of the object queue. <a href="#ab95a0f5ab618822660792152e30f770a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00098.html#ab60df24a3467167b107eb266c024945a">push</a> (T *object)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Push an object to start of queue. <a href="#ab60df24a3467167b107eb266c024945a"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <h3>template<class T><br/> class ucommon::objqueue< T ></h3> <p>Template for typesafe basic object queue container. </p> <p>The object type, T, that is contained in the fifo must be derived from <a class="el" href="a00047.html" title="A double-linked Object, used for certain kinds of lists.">DLinkedObject</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#l01232">1232</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a8e248eb6dd6748c4f40eef2c0e480f98"></a><!-- doxytag: member="ucommon::objqueue::add" ref="a8e248eb6dd6748c4f40eef2c0e480f98" 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="a00098.html">ucommon::objqueue</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 to the end of the object queue. </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 add. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="a00188_source.html#l01251">1251</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="a00098_a8e248eb6dd6748c4f40eef2c0e480f98_cgraph.png" border="0" usemap="#a00098_a8e248eb6dd6748c4f40eef2c0e480f98_cgraph_map" alt=""></div> <map name="a00098_a8e248eb6dd6748c4f40eef2c0e480f98_cgraph_map" id="a00098_a8e248eb6dd6748c4f40eef2c0e480f98_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> <a class="anchor" id="ae90b5ae6fb29b765d43c5c5f68a01a1c"></a><!-- doxytag: member="ucommon::objqueue::pop" ref="ae90b5ae6fb29b765d43c5c5f68a01a1c" 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="a00098.html">ucommon::objqueue</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>Pop an object from the end of the object queue. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>object of specified type or NULL if empty. </dd></dl> <p>Reimplemented from <a class="el" href="a00096.html#a677bb76ed3d2ebd331e3021a19e06fc0">ucommon::ObjectQueue</a>.</p> <p>Definition at line <a class="el" href="a00188_source.html#l01265">1265</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="a00098_ae90b5ae6fb29b765d43c5c5f68a01a1c_cgraph.png" border="0" usemap="#a00098_ae90b5ae6fb29b765d43c5c5f68a01a1c_cgraph_map" alt=""></div> <map name="a00098_ae90b5ae6fb29b765d43c5c5f68a01a1c_cgraph_map" id="a00098_ae90b5ae6fb29b765d43c5c5f68a01a1c_cgraph"> <area shape="rect" id="node3" href="a00208.html#a8c39786e7fff8276be5ccaf1c962f1ce" title="Pop a linked object from a stack of linked objects." alt="" coords="297,5,439,32"/></map> </div> </p> </div> </div> <a class="anchor" id="ab95a0f5ab618822660792152e30f770a"></a><!-- doxytag: member="ucommon::objqueue::pull" ref="ab95a0f5ab618822660792152e30f770a" 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="a00098.html">ucommon::objqueue</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 start of the object queue. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>object of specified type or NULL if empty. </dd></dl> <p>Reimplemented from <a class="el" href="a00096.html#a861ce475b63a60f0af31d0c5475c5df4">ucommon::ObjectQueue</a>.</p> <p>Definition at line <a class="el" href="a00188_source.html#l01258">1258</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="a00098_ab95a0f5ab618822660792152e30f770a_cgraph.png" border="0" usemap="#a00098_ab95a0f5ab618822660792152e30f770a_cgraph_map" alt=""></div> <map name="a00098_ab95a0f5ab618822660792152e30f770a_cgraph_map" id="a00098_ab95a0f5ab618822660792152e30f770a_cgraph"> <area shape="rect" id="node3" href="a00208.html#a4aa076e73039e3c66ad07f7ca1827c8e" title="Convenience function to pull an object from a stack." alt="" coords="307,5,459,32"/><area shape="rect" id="node5" href="a00145.html#ace7b1d47a03ad947eb592033ae94aa1a" title="Get and remove last object pushed on the stack." alt="" coords="508,5,729,32"/></map> </div> </p> </div> </div> <a class="anchor" id="ab60df24a3467167b107eb266c024945a"></a><!-- doxytag: member="ucommon::objqueue::push" ref="ab60df24a3467167b107eb266c024945a" 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="a00098.html">ucommon::objqueue</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 to start of queue. </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#l01244">1244</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="a00098_ab60df24a3467167b107eb266c024945a_cgraph.png" border="0" usemap="#a00098_ab60df24a3467167b107eb266c024945a_cgraph_map" alt=""></div> <map name="a00098_ab60df24a3467167b107eb266c024945a_cgraph_map" id="a00098_ab60df24a3467167b107eb266c024945a_cgraph"> <area shape="rect" id="node3" href="a00208.html#a36870182251dc08e9a3eac56452d6218" title="Convenience function to push an object onto a stack." alt="" coords="307,5,459,32"/><area shape="rect" id="node5" href="a00145.html#a1e87ca85d0b8df573f706bb74cd337ca" title="Push an object into the stack by it's pointer." alt="" coords="508,5,729,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:49 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>