Sophie

Sophie

distrib > Mandriva > 2007.0 > i586 > by-pkgid > ad1ba1135a9c9eeffc2e538163e00373 > files > 194

libCommonC++2_1.4-devel-1.4.1-1mdv2007.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::LinkedSingle Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<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 id="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
    <li><a href="examples.html"><span>Examples</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</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="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a></div>
<h1>ost::LinkedSingle Class Reference</h1><!-- doxytag: class="ost::LinkedSingle" -->Self managed single linked list object chain.Accumulating single linked list.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="object_8h-source.html">object.h</a>&gt;</code>
<p>
<a href="classost_1_1_linked_single-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap 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#4974c1248c6225cc5f7f6e0ca84590d6">getFirst</a> (void)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get first linked object in list.  <a href="#4974c1248c6225cc5f7f6e0ca84590d6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#6b466a67a5c6273afe855fbe3999d147">getLast</a> (void)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the last object in the list.  <a href="#6b466a67a5c6273afe855fbe3999d147"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#4b8a6fc0cdb5dfc17a3180d616a7da08">getNext</a> (void)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get next object, for convenience.  <a href="#4b8a6fc0cdb5dfc17a3180d616a7da08"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#00b7d9a117394055260402a3baf0b9a1">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="#00b7d9a117394055260402a3baf0b9a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#4acd01bea04106a4b7013c1f2caa2e65">operator+=</a> (<a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> &amp;obj)</td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#61f80761bc11c58afaeab3c6b5fb0ca8">LinkedSingle</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#441f97dee9fbcceba79972850249751d">~LinkedSingle</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap 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#db851ec849109c71ad1b664452e3320a">nextObject</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Self managed single linked list object chain.Accumulating single linked list. 
<p>
This is used for accumulating lists by using as a base class for a derived subclass.<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; </dd></dl>

<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="61f80761bc11c58afaeab3c6b5fb0ca8"></a><!-- doxytag: member="ost::LinkedSingle::LinkedSingle" ref="61f80761bc11c58afaeab3c6b5fb0ca8" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">ost::LinkedSingle::LinkedSingle           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline, protected]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a class="anchor" name="441f97dee9fbcceba79972850249751d"></a><!-- doxytag: member="ost::LinkedSingle::~LinkedSingle" ref="441f97dee9fbcceba79972850249751d" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual ost::LinkedSingle::~LinkedSingle           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [protected, virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4974c1248c6225cc5f7f6e0ca84590d6"></a><!-- doxytag: member="ost::LinkedSingle::getFirst" ref="4974c1248c6225cc5f7f6e0ca84590d6" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual <a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a>* ost::LinkedSingle::getFirst           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get first linked object in list. 
<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 compact><dt><b>Returns:</b></dt><dd>pointer to first object in list. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="6b466a67a5c6273afe855fbe3999d147"></a><!-- doxytag: member="ost::LinkedSingle::getLast" ref="6b466a67a5c6273afe855fbe3999d147" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual <a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a>* ost::LinkedSingle::getLast           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets the last object in the list. 
<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 compact><dt><b>Returns:</b></dt><dd>pointer to last object in list. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="4b8a6fc0cdb5dfc17a3180d616a7da08"></a><!-- doxytag: member="ost::LinkedSingle::getNext" ref="4b8a6fc0cdb5dfc17a3180d616a7da08" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a>* ost::LinkedSingle::getNext           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get next object, for convenience. 
<p>
Derived class may use this with a dynamic cast.<p>
<dl compact><dt><b>Returns:</b></dt><dd>next object in list. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="00b7d9a117394055260402a3baf0b9a1"></a><!-- doxytag: member="ost::LinkedSingle::insert" ref="00b7d9a117394055260402a3baf0b9a1" args="(LinkedSingle &amp;obj)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">virtual void ost::LinkedSingle::insert           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>obj</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Insert object into chain. 
<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 compact><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>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="4acd01bea04106a4b7013c1f2caa2e65"></a><!-- doxytag: member="ost::LinkedSingle::operator+=" ref="4acd01bea04106a4b7013c1f2caa2e65" args="(LinkedSingle &amp;obj)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a>&amp; ost::LinkedSingle::operator+=           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>obj</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="db851ec849109c71ad1b664452e3320a"></a><!-- doxytag: member="ost::LinkedSingle::nextObject" ref="db851ec849109c71ad1b664452e3320a" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a>* <a class="el" href="classost_1_1_linked_single.html#db851ec849109c71ad1b664452e3320a">ost::LinkedSingle::nextObject</a><code> [protected]</code>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:56 2006 for GNU CommonC++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>