<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>GNU CommonC++: ost::LinkedSingle Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">GNU CommonC++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.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>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 id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceost.html">ost</a></li><li class="navelem"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> | <a href="classost_1_1_linked_single-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">ost::LinkedSingle Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Self managed single linked list object chain. <a href="classost_1_1_linked_single.html#details">More...</a></p> <p><code>#include <<a class="el" href="object_8h_source.html">object.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a4974c1248c6225cc5f7f6e0ca84590d6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#a4974c1248c6225cc5f7f6e0ca84590d6">getFirst</a> (void)</td></tr> <tr class="memdesc:a4974c1248c6225cc5f7f6e0ca84590d6"><td class="mdescLeft"> </td><td class="mdescRight">Get first linked object in list. <a href="#a4974c1248c6225cc5f7f6e0ca84590d6">More...</a><br/></td></tr> <tr class="separator:a4974c1248c6225cc5f7f6e0ca84590d6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6b466a67a5c6273afe855fbe3999d147"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#a6b466a67a5c6273afe855fbe3999d147">getLast</a> (void)</td></tr> <tr class="memdesc:a6b466a67a5c6273afe855fbe3999d147"><td class="mdescLeft"> </td><td class="mdescRight">Gets the last object in the list. <a href="#a6b466a67a5c6273afe855fbe3999d147">More...</a><br/></td></tr> <tr class="separator:a6b466a67a5c6273afe855fbe3999d147"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4b8a6fc0cdb5dfc17a3180d616a7da08"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#a4b8a6fc0cdb5dfc17a3180d616a7da08">getNext</a> (void)</td></tr> <tr class="memdesc:a4b8a6fc0cdb5dfc17a3180d616a7da08"><td class="mdescLeft"> </td><td class="mdescRight">Get next object, for convenience. <a href="#a4b8a6fc0cdb5dfc17a3180d616a7da08">More...</a><br/></td></tr> <tr class="separator:a4b8a6fc0cdb5dfc17a3180d616a7da08"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a00b7d9a117394055260402a3baf0b9a1"><td class="memItemLeft" align="right" valign="top">virtual void </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> &obj)</td></tr> <tr class="memdesc:a00b7d9a117394055260402a3baf0b9a1"><td class="mdescLeft"> </td><td class="mdescRight">Insert object into chain. <a href="#a00b7d9a117394055260402a3baf0b9a1">More...</a><br/></td></tr> <tr class="separator:a00b7d9a117394055260402a3baf0b9a1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4acd01bea04106a4b7013c1f2caa2e65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> & </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> &obj)</td></tr> <tr class="separator:a4acd01bea04106a4b7013c1f2caa2e65"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:a61f80761bc11c58afaeab3c6b5fb0ca8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#a61f80761bc11c58afaeab3c6b5fb0ca8">LinkedSingle</a> ()</td></tr> <tr class="separator:a61f80761bc11c58afaeab3c6b5fb0ca8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a441f97dee9fbcceba79972850249751d"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#a441f97dee9fbcceba79972850249751d">~LinkedSingle</a> ()</td></tr> <tr class="separator:a441f97dee9fbcceba79972850249751d"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr class="memitem:adb851ec849109c71ad1b664452e3320a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_linked_single.html#adb851ec849109c71ad1b664452e3320a">nextObject</a></td></tr> <tr class="separator:adb851ec849109c71ad1b664452e3320a"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><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="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> Accumulating single linked list. </dd></dl> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a61f80761bc11c58afaeab3c6b5fb0ca8"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">ost::LinkedSingle::LinkedSingle </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a441f97dee9fbcceba79972850249751d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual ost::LinkedSingle::~LinkedSingle </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a4974c1248c6225cc5f7f6e0ca84590d6"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <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 </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </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="section return"><dt>Returns</dt><dd>pointer to first object in list. </dd></dl> </div> </div> <a class="anchor" id="a6b466a67a5c6273afe855fbe3999d147"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <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 </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </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="section return"><dt>Returns</dt><dd>pointer to last object in list. </dd></dl> </div> </div> <a class="anchor" id="a4b8a6fc0cdb5dfc17a3180d616a7da08"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <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 </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </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="section return"><dt>Returns</dt><dd>next object in list. </dd></dl> </div> </div> <a class="anchor" id="a00b7d9a117394055260402a3baf0b9a1"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <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> & </td> <td class="paramname"><em>obj</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">virtual</span></span> </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 class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">object</td><td>being inserted. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a4acd01bea04106a4b7013c1f2caa2e65"></a> <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::operator+= </td> <td>(</td> <td class="paramtype"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a> & </td> <td class="paramname"><em>obj</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a class="anchor" id="adb851ec849109c71ad1b664452e3320a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classost_1_1_linked_single.html">LinkedSingle</a>* ost::LinkedSingle::nextObject</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </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><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu Oct 17 2013 23:24:57 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>