<!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>RAUL: Raul::List< 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.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</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 class="navpath">
<ul>
<li><b>Raul</b> </li>
<li><a class="el" href="classRaul_1_1List.html">Raul::List< T ></a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Raul::List< T > Class Template Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Raul::List" --><!-- doxytag: inherits="Raul::Deletable" -->
<p>A realtime safe, (partially) thread safe doubly-linked list.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="List_8hpp_source.html">List.hpp</a>></code></p>
<p>Inherits <a class="el" href="classRaul_1_1Deletable.html">Raul::Deletable</a>.</p>
<div class="dynheader">
Collaboration diagram for Raul::List< T >:</div>
<div class="dyncontent">
<div class="center"><img src="classRaul_1_1List__coll__graph.png" border="0" usemap="#Raul_1_1List_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="Raul_1_1List_3_01T_01_4_coll__map" id="Raul_1_1List_3_01T_01_4_coll__map">
<area shape="rect" id="node2" href="classRaul_1_1Deletable.html" title="Something with a virtual destructor." alt="" coords="5,5,117,35"/><area shape="rect" id="node6" href="classRaul_1_1List_1_1Node.html" title="A node in a List." alt="" coords="81,85,231,115"/><area shape="rect" id="node4" href="classRaul_1_1List_1_1const__iterator.html" title="Realtime safe const iterator for a List." alt="" coords="57,181,255,211"/><area shape="rect" id="node9" href="classRaul_1_1List_1_1iterator.html" title="Realtime safe iterator for a List." alt="" coords="279,181,436,211"/></map>
</div>
<p><a href="classRaul_1_1List-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1List_1_1const__iterator.html">const_iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Realtime safe const iterator for a <a class="el" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List</a>. <a href="classRaul_1_1List_1_1const__iterator.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1List_1_1iterator.html">iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Realtime safe iterator for a <a class="el" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List</a>. <a href="classRaul_1_1List_1_1iterator.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1List_1_1Node.html">Node</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A node in a <a class="el" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List</a>. <a href="classRaul_1_1List_1_1Node.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2331fe278ea0113e9d3b9ff13d5c0499"></a><!-- doxytag: member="Raul::List::List" ref="a2331fe278ea0113e9d3b9ff13d5c0499" args="(size_t size=0, Node *head=NULL, Node *tail=NULL)" -->
</td><td class="memItemRight" valign="bottom"><b>List</b> (size_t size=0, <a class="el" href="classRaul_1_1List_1_1Node.html">Node</a> *head=NULL, <a class="el" href="classRaul_1_1List_1_1Node.html">Node</a> *tail=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1List.html#a20d904c950f9eb4208b19e6ebb690371">push_back</a> (<a class="el" href="classRaul_1_1List_1_1Node.html">Node</a> *elem)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Realtime Safe. <a href="#a20d904c950f9eb4208b19e6ebb690371"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1List.html#a937d7ce5da9552f8b1cfd71f5c7cb5e6">push_back</a> (T &elem)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">NOT Realtime Safe. <a href="#a937d7ce5da9552f8b1cfd71f5c7cb5e6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1List.html#ae37d799cafbab461d145bbf0f5aa8401">append</a> (<a class="el" href="classRaul_1_1List.html">List</a>< T > &list)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a list to this list. <a href="#ae37d799cafbab461d145bbf0f5aa8401"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1List.html#a96cb220e9d0bc81a5a40669f9f0a793b">clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the list, deleting all Nodes contained (but NOT their contents!). <a href="#a96cb220e9d0bc81a5a40669f9f0a793b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e77fcf7bff6532771334c067acc5977"></a><!-- doxytag: member="Raul::List::size" ref="a8e77fcf7bff6532771334c067acc5977" args="() const " -->
unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1List.html#a8e77fcf7bff6532771334c067acc5977">size</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Valid only in the write thread. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92a6732e5efee58a8c420189636f7d62"></a><!-- doxytag: member="Raul::List::empty" ref="a92a6732e5efee58a8c420189636f7d62" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1List.html#a92a6732e5efee58a8c420189636f7d62">empty</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Valid for any thread. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adce550b5936a448ea3e5b662267d0a89"></a><!-- doxytag: member="Raul::List::chop_front" ref="adce550b5936a448ea3e5b662267d0a89" args="(List< T > &front, size_t front_size, Node *new_head)" -->
void </td><td class="memItemRight" valign="bottom"><b>chop_front</b> (<a class="el" href="classRaul_1_1List.html">List</a>< T > &front, size_t front_size, <a class="el" href="classRaul_1_1List_1_1Node.html">Node</a> *new_head)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRaul_1_1List_1_1Node.html">Node</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1List.html#adeb74758cc7641b414907f792e276155">erase</a> (const <a class="el" href="classRaul_1_1List_1_1iterator.html">iterator</a> iter)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove an element from the list using an iterator. <a href="#adeb74758cc7641b414907f792e276155"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRaul_1_1List_1_1iterator.html">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1List.html#a534f9df684480b3bb74173e36f0cd2e9">find</a> (const T &val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find an element in the list. <a href="#a534f9df684480b3bb74173e36f0cd2e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa85efa8b2347b18636ab4843db6f9e7e"></a><!-- doxytag: member="Raul::List::begin" ref="aa85efa8b2347b18636ab4843db6f9e7e" args="()" -->
<a class="el" href="classRaul_1_1List_1_1iterator.html">iterator</a> </td><td class="memItemRight" valign="bottom"><b>begin</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac272dad7dbd5c6ca6ff56cb8093c60fd"></a><!-- doxytag: member="Raul::List::begin" ref="ac272dad7dbd5c6ca6ff56cb8093c60fd" args="() const " -->
<a class="el" href="classRaul_1_1List_1_1const__iterator.html">const_iterator</a> </td><td class="memItemRight" valign="bottom"><b>begin</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa55aeaeebb5b2c264771ebb242e08a96"></a><!-- doxytag: member="Raul::List::end" ref="aa55aeaeebb5b2c264771ebb242e08a96" args="() const " -->
const <a class="el" href="classRaul_1_1List_1_1iterator.html">iterator</a> </td><td class="memItemRight" valign="bottom"><b>end</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ccd1b49364318b21bf5339fb0782151"></a><!-- doxytag: member="Raul::List::front" ref="a1ccd1b49364318b21bf5339fb0782151" args="()" -->
T & </td><td class="memItemRight" valign="bottom"><b>front</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c628ba52530aef8983409278fcb4c2b"></a><!-- doxytag: member="Raul::List::front" ref="a0c628ba52530aef8983409278fcb4c2b" args="() const " -->
const T & </td><td class="memItemRight" valign="bottom"><b>front</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a387ffd39a94c99825858906ae99e9611"></a><!-- doxytag: member="Raul::List::head" ref="a387ffd39a94c99825858906ae99e9611" args="()" -->
<a class="el" href="classRaul_1_1List_1_1Node.html">Node</a> * </td><td class="memItemRight" valign="bottom"><b>head</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af07f794b6a5eded2d6f161650465ee99"></a><!-- doxytag: member="Raul::List::head" ref="af07f794b6a5eded2d6f161650465ee99" args="() const " -->
const <a class="el" href="classRaul_1_1List_1_1Node.html">Node</a> * </td><td class="memItemRight" valign="bottom"><b>head</b> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<typename T><br/>
class Raul::List< T ></h3>
<p>A realtime safe, (partially) thread safe doubly-linked list. </p>
<p>Elements can be added safely while another thread is reading the list. Like a typical ringbuffer, this is single-reader single-writer threadsafe only. See documentation for specific functions for specifics. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a20d904c950f9eb4208b19e6ebb690371"></a><!-- doxytag: member="Raul::List::push_back" ref="a20d904c950f9eb4208b19e6ebb690371" args="(Node *elem)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classRaul_1_1List.html">Raul::List</a>< T >::push_back </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRaul_1_1List_1_1Node.html">Node</a> * </td>
<td class="paramname"> <em>elem</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Realtime Safe. </p>
<p>Add an element to the list.</p>
<p><a class="el" href="classRaul_1_1Thread.html" title="Abstract base class for a thread.">Thread</a> safe (may be called while another thread is reading the list). Realtime safe. </p>
<p>Referenced by <a class="el" href="classRaul_1_1Maid.html#a214c353812c45380b27fa3341ff352fa">Raul::Maid::manage()</a>.</p>
</div>
</div>
<a class="anchor" id="a937d7ce5da9552f8b1cfd71f5c7cb5e6"></a><!-- doxytag: member="Raul::List::push_back" ref="a937d7ce5da9552f8b1cfd71f5c7cb5e6" args="(T &elem)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classRaul_1_1List.html">Raul::List</a>< T >::push_back </td>
<td>(</td>
<td class="paramtype">T & </td>
<td class="paramname"> <em>elem</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>NOT Realtime Safe. </p>
<p>Add an element to the list.</p>
<p><a class="el" href="classRaul_1_1Thread.html" title="Abstract base class for a thread.">Thread</a> safe (may be called while another thread is reading the list). NOT realtime safe (a <a class="el" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a> is allocated). </p>
</div>
</div>
<a class="anchor" id="ae37d799cafbab461d145bbf0f5aa8401"></a><!-- doxytag: member="Raul::List::append" ref="ae37d799cafbab461d145bbf0f5aa8401" args="(List< T > &list)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classRaul_1_1List.html">Raul::List</a>< T >::append </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRaul_1_1List.html">List</a>< T > & </td>
<td class="paramname"> <em>list</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Append a list to this list. </p>
<p>This operation is fast ( O(1) ). The appended list is not safe to use concurrently with this call. The appended list will be empty after this call.</p>
<p><a class="el" href="classRaul_1_1Thread.html" title="Abstract base class for a thread.">Thread</a> safe (may be called while another thread is reading the list). Realtime safe. </p>
<p>References <a class="el" href="classRaul_1_1List.html#a8e77fcf7bff6532771334c067acc5977">Raul::List< T >::size()</a>.</p>
</div>
</div>
<a class="anchor" id="a96cb220e9d0bc81a5a40669f9f0a793b"></a><!-- doxytag: member="Raul::List::clear" ref="a96cb220e9d0bc81a5a40669f9f0a793b" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classRaul_1_1List.html">Raul::List</a>< T >::clear </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clear the list, deleting all Nodes contained (but NOT their contents!). </p>
<p>Not realtime safe. </p>
</div>
</div>
<a class="anchor" id="adeb74758cc7641b414907f792e276155"></a><!-- doxytag: member="Raul::List::erase" ref="adeb74758cc7641b414907f792e276155" args="(const iterator iter)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRaul_1_1List.html">List</a>< T >::<a class="el" href="classRaul_1_1List_1_1Node.html">Node</a> * <a class="el" href="classRaul_1_1List.html">Raul::List</a>< T >::erase </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRaul_1_1List_1_1iterator.html">iterator</a> </td>
<td class="paramname"> <em>iter</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove an element from the list using an iterator. </p>
<p>This function is realtime safe - it is the caller's responsibility to delete the returned <a class="el" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a>, or there will be a leak. <a class="el" href="classRaul_1_1Thread.html" title="Abstract base class for a thread.">Thread</a> safe (safe to call while another thread reads the list). <em>iter</em> is invalid immediately following this call. </p>
<p>Referenced by <a class="el" href="classRaul_1_1Maid.html#a83d64bae9f6838d05e6ae8f9740b4dae">Raul::Maid::cleanup()</a>.</p>
</div>
</div>
<a class="anchor" id="a534f9df684480b3bb74173e36f0cd2e9"></a><!-- doxytag: member="Raul::List::find" ref="a534f9df684480b3bb74173e36f0cd2e9" args="(const T &val)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRaul_1_1List.html">List</a>< T >::<a class="el" href="classRaul_1_1List_1_1iterator.html">iterator</a> <a class="el" href="classRaul_1_1List.html">Raul::List</a>< T >::find </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"> <em>val</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find an element in the list. </p>
<p>This will only return the first element found. If there are duplicated, another call to <a class="el" href="classRaul_1_1List.html#a534f9df684480b3bb74173e36f0cd2e9" title="Find an element in the list.">find()</a> will return the next, etc. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="List_8hpp_source.html">List.hpp</a></li>
<li><a class="el" href="ListImpl_8hpp_source.html">ListImpl.hpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
88959ca903fe50462ea99715ead18944
>
files
>
113
