Sophie

Sophie

distrib > Mandriva > 2010.2 > i586 > media > contrib-backports > by-pkgid > 4f5f2dc0f55b453456458df885792b0b > files > 194

ucommon-doc-5.0.4-1mdv2010.2.i586.rpm

<!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::ObjectQueue Class 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&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;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&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00096.html">ObjectQueue</a>
  </div>
</div>
<div class="contents">
<h1>ucommon::ObjectQueue Class Reference</h1><!-- doxytag: class="ucommon::ObjectQueue" --><!-- doxytag: inherits="ucommon::OrderedIndex" -->
<p>A queue of double linked object.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00188_source.html">linked.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ucommon::ObjectQueue:</div>
<div class="dynsection">
<div class="center"><img src="a00457.png" border="0" usemap="#ucommon_1_1_object_queue_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1_object_queue_inherit__map" id="ucommon_1_1_object_queue_inherit__map">
<area shape="rect" id="node5" href="a00098.html" title="Template for typesafe basic object queue container." alt="" coords="5,155,248,181"/><area shape="rect" id="node2" 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::ObjectQueue:</div>
<div class="dynsection">
<div class="center"><img src="a00458.png" border="0" usemap="#ucommon_1_1_object_queue_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1_object_queue_coll__map" id="ucommon_1_1_object_queue_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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00096.html#ad7d1038e5be6651830b00b0dc030545d">add</a> (<a class="el" href="a00047.html">DLinkedObject</a> *object)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add an object to the end of the queue.  <a href="#ad7d1038e5be6651830b00b0dc030545d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ebe82c800ad122b366d3dd8fe5eb32a"></a><!-- doxytag: member="ucommon::ObjectQueue::ObjectQueue" ref="a9ebe82c800ad122b366d3dd8fe5eb32a" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00096.html#a9ebe82c800ad122b366d3dd8fe5eb32a">ObjectQueue</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an empty object queue. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00047.html">DLinkedObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00096.html#a677bb76ed3d2ebd331e3021a19e06fc0">pop</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pop an object from the end of the queue.  <a href="#a677bb76ed3d2ebd331e3021a19e06fc0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00047.html">DLinkedObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00096.html#a861ce475b63a60f0af31d0c5475c5df4">pull</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pull an object from the front of the queue.  <a href="#a861ce475b63a60f0af31d0c5475c5df4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00096.html#ae470d5af99082f53125b79a2efabe12e">push</a> (<a class="el" href="a00047.html">DLinkedObject</a> *object)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Push an object to the front of the queue.  <a href="#ae470d5af99082f53125b79a2efabe12e"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A queue of double linked object. </p>
<p>This uses the linkedlist class to form a basic queue of objects. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="a00188_source.html#l00882">882</a> of file <a class="el" href="a00188_source.html">linked.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad7d1038e5be6651830b00b0dc030545d"></a><!-- doxytag: member="ucommon::ObjectQueue::add" ref="ad7d1038e5be6651830b00b0dc030545d" args="(DLinkedObject *object)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucommon::ObjectQueue::add </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00047.html">DLinkedObject</a> *&nbsp;</td>
          <td class="paramname"> <em>object</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Add an object to the end of the 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>&nbsp;</td><td>to add. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a677bb76ed3d2ebd331e3021a19e06fc0"></a><!-- doxytag: member="ucommon::ObjectQueue::pop" ref="a677bb76ed3d2ebd331e3021a19e06fc0" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00047.html">DLinkedObject</a>* ucommon::ObjectQueue::pop </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Pop an object from the end of the queue. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>object popped or NULL if empty. </dd></dl>

<p>Reimplemented in <a class="el" href="a00098.html#ae90b5ae6fb29b765d43c5c5f68a01a1c">ucommon::objqueue&lt; T &gt;</a>.</p>

</div>
</div>
<a class="anchor" id="a861ce475b63a60f0af31d0c5475c5df4"></a><!-- doxytag: member="ucommon::ObjectQueue::pull" ref="a861ce475b63a60f0af31d0c5475c5df4" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00047.html">DLinkedObject</a>* ucommon::ObjectQueue::pull </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Pull an object from the front of the queue. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>object pulled or NULL if empty. </dd></dl>

<p>Reimplemented in <a class="el" href="a00098.html#ab95a0f5ab618822660792152e30f770a">ucommon::objqueue&lt; T &gt;</a>.</p>

</div>
</div>
<a class="anchor" id="ae470d5af99082f53125b79a2efabe12e"></a><!-- doxytag: member="ucommon::ObjectQueue::push" ref="ae470d5af99082f53125b79a2efabe12e" args="(DLinkedObject *object)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucommon::ObjectQueue::push </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00047.html">DLinkedObject</a> *&nbsp;</td>
          <td class="paramname"> <em>object</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Push an object to the front of the 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>&nbsp;</td><td>to push. </td></tr>
  </table>
  </dd>
</dl>

</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&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>