Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > ed376d6842ea322c25405e7c23b3bc12 > files > 234

libcommoncpp-devel-1.8.0-5.1mdv2010.1.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>GNU CommonC++: ost::LinkedSingle 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="index.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>Classes</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>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</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 class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a>
  </div>
</div>
<div class="contents">
<h1>ost::LinkedSingle Class Reference</h1><!-- doxytag: class="ost::LinkedSingle" -->
<p>Self managed single linked list object chain.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="object_8h_source.html">object.h</a>&gt;</code></p>

<p><a href="classost_1_1_linked_single-members.html">List of all members.</a></p>
<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">virtual <a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#a4974c1248c6225cc5f7f6e0ca84590d6">getFirst</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get first linked object in list.  <a href="#a4974c1248c6225cc5f7f6e0ca84590d6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#a6b466a67a5c6273afe855fbe3999d147">getLast</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the last object in the list.  <a href="#a6b466a67a5c6273afe855fbe3999d147"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#a4b8a6fc0cdb5dfc17a3180d616a7da08">getNext</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get next object, for convenience.  <a href="#a4b8a6fc0cdb5dfc17a3180d616a7da08"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#a00b7d9a117394055260402a3baf0b9a1">insert</a> (<a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> &amp;obj)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Insert object into chain.  <a href="#a00b7d9a117394055260402a3baf0b9a1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#a4acd01bea04106a4b7013c1f2caa2e65">operator+=</a> (<a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> &amp;obj)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#a61f80761bc11c58afaeab3c6b5fb0ca8">LinkedSingle</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#a441f97dee9fbcceba79972850249751d">~LinkedSingle</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#adb851ec849109c71ad1b664452e3320a">nextObject</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Self managed single linked list object chain. </p>
<p>This is used for accumulating lists by using as a base class for a derived subclass.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; Accumulating single linked list. </dd></dl>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a61f80761bc11c58afaeab3c6b5fb0ca8"></a><!-- doxytag: member="ost::LinkedSingle::LinkedSingle" ref="a61f80761bc11c58afaeab3c6b5fb0ca8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ost::LinkedSingle::LinkedSingle </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a441f97dee9fbcceba79972850249751d"></a><!-- doxytag: member="ost::LinkedSingle::~LinkedSingle" ref="a441f97dee9fbcceba79972850249751d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual ost::LinkedSingle::~LinkedSingle </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4974c1248c6225cc5f7f6e0ca84590d6"></a><!-- doxytag: member="ost::LinkedSingle::getFirst" ref="a4974c1248c6225cc5f7f6e0ca84590d6" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a>* ost::LinkedSingle::getFirst </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get first linked object in list. </p>
<p>This may be dynamically recast, and may refer to a master static bookmark pointer in a derived class. Otherwise it simply returns the current object. In a "free" list, this may not only return the first object, but also set the first to next.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to first object in list. </dd></dl>

</div>
</div>
<a class="anchor" id="a6b466a67a5c6273afe855fbe3999d147"></a><!-- doxytag: member="ost::LinkedSingle::getLast" ref="a6b466a67a5c6273afe855fbe3999d147" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a>* ost::LinkedSingle::getLast </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets the last object in the list. </p>
<p>This normally follows the links to the end. This is a virtual because derived class may include a static member bookmark for the current end.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to last object in list. </dd></dl>

</div>
</div>
<a class="anchor" id="a4b8a6fc0cdb5dfc17a3180d616a7da08"></a><!-- doxytag: member="ost::LinkedSingle::getNext" ref="a4b8a6fc0cdb5dfc17a3180d616a7da08" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a>* ost::LinkedSingle::getNext </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get next object, for convenience. </p>
<p>Derived class may use this with a dynamic cast.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>next object in list. </dd></dl>

</div>
</div>
<a class="anchor" id="a00b7d9a117394055260402a3baf0b9a1"></a><!-- doxytag: member="ost::LinkedSingle::insert" ref="a00b7d9a117394055260402a3baf0b9a1" args="(LinkedSingle &amp;obj)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ost::LinkedSingle::insert </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>obj</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Insert object into chain. </p>
<p>This is a virtual because derived class may choose instead to perform an insert at head or tail, may manage bookmarks, and may add mutex lock.</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>being inserted. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a4acd01bea04106a4b7013c1f2caa2e65"></a><!-- doxytag: member="ost::LinkedSingle::operator+=" ref="a4acd01bea04106a4b7013c1f2caa2e65" args="(LinkedSingle &amp;obj)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a>&amp; ost::LinkedSingle::operator+= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>obj</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="adb851ec849109c71ad1b664452e3320a"></a><!-- doxytag: member="ost::LinkedSingle::nextObject" ref="adb851ec849109c71ad1b664452e3320a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a>* <a class="el" href="classost_1_1_linked_single.html#adb851ec849109c71ad1b664452e3320a">ost::LinkedSingle::nextObject</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="object_8h_source.html">object.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 2010 for GNU CommonC++ 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>