alex
/
libsdr
mirror of https://github.com/hmatuschek/libsdr
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
master
gh-pages
v0.1.0
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '66f1d36673'
${ noResults }
libsdr/classsdr_1_1_buffer_node.html

430 lines
34 KiB
HTML
Raw Blame History

<!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.6"/>
<title>libsdr: sdr::BufferNode&lt; Scalar &gt; Class Template 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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">libsdr
&#160;<span id="projectnumber">0.1.0</span>
</div>
<div id="projectbrief">A simple SDR library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</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>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>sdr</b></li><li class="navelem"><a class="el" href="classsdr_1_1_buffer_node.html">BufferNode</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classsdr_1_1_buffer_node-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sdr::BufferNode&lt; Scalar &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A simple buffering node, that ensures a fixed buffer size.
<a href="classsdr_1_1_buffer_node.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="buffernode_8hh_source.html">buffernode.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sdr::BufferNode&lt; Scalar &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classsdr_1_1_buffer_node.png" usemap="#sdr::BufferNode&lt; Scalar &gt;_map" alt=""/>
<map id="sdr::BufferNode&lt; Scalar &gt;_map" name="sdr::BufferNode&lt; Scalar &gt;_map">
<area href="classsdr_1_1_sink.html" title="Typed sink. " alt="sdr::Sink&lt; Scalar &gt;" shape="rect" coords="0,56,162,80"/>
<area href="classsdr_1_1_source.html" title="Generic source class. " alt="sdr::Source" shape="rect" coords="172,56,334,80"/>
<area href="classsdr_1_1_sink_base.html" title="Basic interface of all Sinks. " alt="sdr::SinkBase" shape="rect" coords="0,0,162,24"/>
</map>
</div></div>
<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:a231ac24b83844174b6f611a709e50ec7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_buffer_node.html#a231ac24b83844174b6f611a709e50ec7">BufferNode</a> (size_t bufferSize)</td></tr>
<tr class="memdesc:a231ac24b83844174b6f611a709e50ec7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new buffer node. <a href="#a231ac24b83844174b6f611a709e50ec7">More...</a><br/></td></tr>
<tr class="separator:a231ac24b83844174b6f611a709e50ec7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a827c44de5d3c5a24d548ca498ee8fea6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_buffer_node.html#a827c44de5d3c5a24d548ca498ee8fea6">config</a> (const <a class="el" href="classsdr_1_1_config.html">Config</a> &amp;src_cfg)</td></tr>
<tr class="memdesc:a827c44de5d3c5a24d548ca498ee8fea6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the buffer node. <a href="#a827c44de5d3c5a24d548ca498ee8fea6">More...</a><br/></td></tr>
<tr class="separator:a827c44de5d3c5a24d548ca498ee8fea6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb7d0d4724ccbc18e762c1b1d55d4d95"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_buffer_node.html#abb7d0d4724ccbc18e762c1b1d55d4d95">process</a> (const <a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt; Scalar &gt; &amp;buffer, bool allow_overwrite)</td></tr>
<tr class="memdesc:abb7d0d4724ccbc18e762c1b1d55d4d95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process the incomming data. <a href="#abb7d0d4724ccbc18e762c1b1d55d4d95">More...</a><br/></td></tr>
<tr class="separator:abb7d0d4724ccbc18e762c1b1d55d4d95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classsdr_1_1_sink"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsdr_1_1_sink')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classsdr_1_1_sink.html">sdr::Sink&lt; Scalar &gt;</a></td></tr>
<tr class="memitem:a1a5279c1507276612797734eed890ecb inherit pub_methods_classsdr_1_1_sink"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_sink.html#a1a5279c1507276612797734eed890ecb">Sink</a> ()</td></tr>
<tr class="memdesc:a1a5279c1507276612797734eed890ecb inherit pub_methods_classsdr_1_1_sink"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a1a5279c1507276612797734eed890ecb">More...</a><br/></td></tr>
<tr class="separator:a1a5279c1507276612797734eed890ecb inherit pub_methods_classsdr_1_1_sink"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad17413f3a75305f326b7c3885be9279a inherit pub_methods_classsdr_1_1_sink"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_sink.html#ad17413f3a75305f326b7c3885be9279a">~Sink</a> ()</td></tr>
<tr class="memdesc:ad17413f3a75305f326b7c3885be9279a inherit pub_methods_classsdr_1_1_sink"><td class="mdescLeft">&#160;</td><td class="mdescRight">Drestructor. <a href="#ad17413f3a75305f326b7c3885be9279a">More...</a><br/></td></tr>
<tr class="separator:ad17413f3a75305f326b7c3885be9279a inherit pub_methods_classsdr_1_1_sink"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25b0849e40053f87496ca72f8b8cd9e2 inherit pub_methods_classsdr_1_1_sink"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_sink.html#a25b0849e40053f87496ca72f8b8cd9e2">handleBuffer</a> (const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &amp;buffer, bool allow_overwrite)</td></tr>
<tr class="memdesc:a25b0849e40053f87496ca72f8b8cd9e2 inherit pub_methods_classsdr_1_1_sink"><td class="mdescLeft">&#160;</td><td class="mdescRight">Re-implemented from <code><a class="el" href="classsdr_1_1_sink_base.html" title="Basic interface of all Sinks. ">SinkBase</a></code>. <a href="#a25b0849e40053f87496ca72f8b8cd9e2">More...</a><br/></td></tr>
<tr class="separator:a25b0849e40053f87496ca72f8b8cd9e2 inherit pub_methods_classsdr_1_1_sink"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classsdr_1_1_sink_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsdr_1_1_sink_base')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classsdr_1_1_sink_base.html">sdr::SinkBase</a></td></tr>
<tr class="memitem:aaa9fb7219aa47e809ff1d62a819a2d57 inherit pub_methods_classsdr_1_1_sink_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_sink_base.html#aaa9fb7219aa47e809ff1d62a819a2d57">SinkBase</a> ()</td></tr>
<tr class="memdesc:aaa9fb7219aa47e809ff1d62a819a2d57 inherit pub_methods_classsdr_1_1_sink_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#aaa9fb7219aa47e809ff1d62a819a2d57">More...</a><br/></td></tr>
<tr class="separator:aaa9fb7219aa47e809ff1d62a819a2d57 inherit pub_methods_classsdr_1_1_sink_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a522205396205d6d3601da6a65bdaf75a inherit pub_methods_classsdr_1_1_sink_base"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_sink_base.html#a522205396205d6d3601da6a65bdaf75a">~SinkBase</a> ()</td></tr>
<tr class="memdesc:a522205396205d6d3601da6a65bdaf75a inherit pub_methods_classsdr_1_1_sink_base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a522205396205d6d3601da6a65bdaf75a">More...</a><br/></td></tr>
<tr class="separator:a522205396205d6d3601da6a65bdaf75a inherit pub_methods_classsdr_1_1_sink_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classsdr_1_1_source"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsdr_1_1_source')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classsdr_1_1_source.html">sdr::Source</a></td></tr>
<tr class="memitem:a660c0a4b8b8f8402568bef86f2cb2fbb inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#a660c0a4b8b8f8402568bef86f2cb2fbb">Source</a> ()</td></tr>
<tr class="memdesc:a660c0a4b8b8f8402568bef86f2cb2fbb inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a660c0a4b8b8f8402568bef86f2cb2fbb">More...</a><br/></td></tr>
<tr class="separator:a660c0a4b8b8f8402568bef86f2cb2fbb inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5104a4d66641ae529419b47da4a1473 inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#ac5104a4d66641ae529419b47da4a1473">~Source</a> ()</td></tr>
<tr class="memdesc:ac5104a4d66641ae529419b47da4a1473 inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#ac5104a4d66641ae529419b47da4a1473">More...</a><br/></td></tr>
<tr class="separator:ac5104a4d66641ae529419b47da4a1473 inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13921d5daa00574e2057c1ae1fc28054 inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#a13921d5daa00574e2057c1ae1fc28054">send</a> (const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &amp;buffer, bool allow_overwrite=false)</td></tr>
<tr class="memdesc:a13921d5daa00574e2057c1ae1fc28054 inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends the given buffer to all connected sinks. <a href="#a13921d5daa00574e2057c1ae1fc28054">More...</a><br/></td></tr>
<tr class="separator:a13921d5daa00574e2057c1ae1fc28054 inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7df1faefb31e72e135eec3ecf539132 inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#ac7df1faefb31e72e135eec3ecf539132">connect</a> (<a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a> *sink, bool direct=false)</td></tr>
<tr class="memdesc:ac7df1faefb31e72e135eec3ecf539132 inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect this source to a sink. <a href="#ac7df1faefb31e72e135eec3ecf539132">More...</a><br/></td></tr>
<tr class="separator:ac7df1faefb31e72e135eec3ecf539132 inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b1d1ccef6cee5f4668ee67bc28eed7a inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#a9b1d1ccef6cee5f4668ee67bc28eed7a">disconnect</a> (<a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a> *sink)</td></tr>
<tr class="memdesc:a9b1d1ccef6cee5f4668ee67bc28eed7a inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnect a sink again. <a href="#a9b1d1ccef6cee5f4668ee67bc28eed7a">More...</a><br/></td></tr>
<tr class="separator:a9b1d1ccef6cee5f4668ee67bc28eed7a inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd4c7e3fb94a057ac40e9877167791ec inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#afd4c7e3fb94a057ac40e9877167791ec">setConfig</a> (const <a class="el" href="classsdr_1_1_config.html">Config</a> &amp;config)</td></tr>
<tr class="memdesc:afd4c7e3fb94a057ac40e9877167791ec inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the configuration and propergates it if the configuration has been changed. <a href="#afd4c7e3fb94a057ac40e9877167791ec">More...</a><br/></td></tr>
<tr class="separator:afd4c7e3fb94a057ac40e9877167791ec inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca6c3a89bb5787de5657c4d221bb1ed4 inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#aca6c3a89bb5787de5657c4d221bb1ed4">sampleRate</a> () const </td></tr>
<tr class="memdesc:aca6c3a89bb5787de5657c4d221bb1ed4 inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the configured sample rate or <code>0</code> otherwise. <a href="#aca6c3a89bb5787de5657c4d221bb1ed4">More...</a><br/></td></tr>
<tr class="separator:aca6c3a89bb5787de5657c4d221bb1ed4 inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9362057c06f35e0a23901cc0556b976 inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classsdr_1_1_config.html#a62084c40ed753ff6caefdc4564c597b8">Config::Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#ab9362057c06f35e0a23901cc0556b976">type</a> () const </td></tr>
<tr class="memdesc:ab9362057c06f35e0a23901cc0556b976 inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the configured source type or <code>Config::Type_UNDEFINED</code> otherwise. <a href="#ab9362057c06f35e0a23901cc0556b976">More...</a><br/></td></tr>
<tr class="separator:ab9362057c06f35e0a23901cc0556b976 inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cf977be7a508097532991155e90ae45 inherit pub_methods_classsdr_1_1_source"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:a7cf977be7a508097532991155e90ae45 inherit pub_methods_classsdr_1_1_source"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#a7cf977be7a508097532991155e90ae45">addEOS</a> (T *instance, void(T::*function)())</td></tr>
<tr class="memdesc:a7cf977be7a508097532991155e90ae45 inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a callback to the end-of-stream signal of the source. <a href="#a7cf977be7a508097532991155e90ae45">More...</a><br/></td></tr>
<tr class="separator:a7cf977be7a508097532991155e90ae45 inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2">&#160;</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:a1b8c539b97c3180c6e6155a63248443b"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_buffer_node.html#a1b8c539b97c3180c6e6155a63248443b">_bufferSize</a></td></tr>
<tr class="memdesc:a1b8c539b97c3180c6e6155a63248443b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The desired buffer size. <a href="#a1b8c539b97c3180c6e6155a63248443b">More...</a><br/></td></tr>
<tr class="separator:a1b8c539b97c3180c6e6155a63248443b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50fe21ba7349e28eb8c05b6bf65b9968"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsdr_1_1_buffer_set.html">BufferSet</a>&lt; Scalar &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_buffer_node.html#a50fe21ba7349e28eb8c05b6bf65b9968">_bufferSet</a></td></tr>
<tr class="memdesc:a50fe21ba7349e28eb8c05b6bf65b9968"><td class="mdescLeft">&#160;</td><td class="mdescRight">A set of output buffers. <a href="#a50fe21ba7349e28eb8c05b6bf65b9968">More...</a><br/></td></tr>
<tr class="separator:a50fe21ba7349e28eb8c05b6bf65b9968"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3b1f7333d120b68ef817ab040915c68"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt; Scalar &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_buffer_node.html#ad3b1f7333d120b68ef817ab040915c68">_temp</a></td></tr>
<tr class="memdesc:ad3b1f7333d120b68ef817ab040915c68"><td class="mdescLeft">&#160;</td><td class="mdescRight">An intermediate buffer to hold left-over samples from the previous buffers. <a href="#ad3b1f7333d120b68ef817ab040915c68">More...</a><br/></td></tr>
<tr class="separator:ad3b1f7333d120b68ef817ab040915c68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace6451c9fe46e682742911b9dc3aa6e9"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_buffer_node.html#ace6451c9fe46e682742911b9dc3aa6e9">_samplesLeft</a></td></tr>
<tr class="memdesc:ace6451c9fe46e682742911b9dc3aa6e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of samples left. <a href="#ace6451c9fe46e682742911b9dc3aa6e9">More...</a><br/></td></tr>
<tr class="separator:ace6451c9fe46e682742911b9dc3aa6e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classsdr_1_1_source"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classsdr_1_1_source')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classsdr_1_1_source.html">sdr::Source</a></td></tr>
<tr class="memitem:ac7ea547c33d45cf5b5654ce21957ab27 inherit pro_attribs_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsdr_1_1_config.html">Config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#ac7ea547c33d45cf5b5654ce21957ab27">_config</a></td></tr>
<tr class="memdesc:ac7ea547c33d45cf5b5654ce21957ab27 inherit pro_attribs_classsdr_1_1_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds the source configuration, this can be updated by calling <code>setConfig</code>. <a href="#ac7ea547c33d45cf5b5654ce21957ab27">More...</a><br/></td></tr>
<tr class="separator:ac7ea547c33d45cf5b5654ce21957ab27 inherit pro_attribs_classsdr_1_1_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d030b840c4a1ad45d7a6598f9f582b9 inherit pro_attribs_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">std::map&lt; <a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a> *, bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#a2d030b840c4a1ad45d7a6598f9f582b9">_sinks</a></td></tr>
<tr class="memdesc:a2d030b840c4a1ad45d7a6598f9f582b9 inherit pro_attribs_classsdr_1_1_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">The connected sinks. <a href="#a2d030b840c4a1ad45d7a6598f9f582b9">More...</a><br/></td></tr>
<tr class="separator:a2d030b840c4a1ad45d7a6598f9f582b9 inherit pro_attribs_classsdr_1_1_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee600dc30d6f91466acec5ffcde0f3ac inherit pro_attribs_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">std::list&lt; <a class="el" href="classsdr_1_1_delegate_interface.html">DelegateInterface</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#aee600dc30d6f91466acec5ffcde0f3ac">_eos</a></td></tr>
<tr class="memdesc:aee600dc30d6f91466acec5ffcde0f3ac inherit pro_attribs_classsdr_1_1_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">The connected EOS singal handlers. <a href="#aee600dc30d6f91466acec5ffcde0f3ac">More...</a><br/></td></tr>
<tr class="separator:aee600dc30d6f91466acec5ffcde0f3ac inherit pro_attribs_classsdr_1_1_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classsdr_1_1_source"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classsdr_1_1_source')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classsdr_1_1_source.html">sdr::Source</a></td></tr>
<tr class="memitem:a30eeb1d98d9759ef01a36e938a1172bc inherit pro_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#a30eeb1d98d9759ef01a36e938a1172bc">signalEOS</a> ()</td></tr>
<tr class="memdesc:a30eeb1d98d9759ef01a36e938a1172bc inherit pro_methods_classsdr_1_1_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signals the EOS. <a href="#a30eeb1d98d9759ef01a36e938a1172bc">More...</a><br/></td></tr>
<tr class="separator:a30eeb1d98d9759ef01a36e938a1172bc inherit pro_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fbd9bdaf370acad141440388da2100c inherit pro_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#a3fbd9bdaf370acad141440388da2100c">propagateConfig</a> (const <a class="el" href="classsdr_1_1_config.html">Config</a> &amp;config)</td></tr>
<tr class="memdesc:a3fbd9bdaf370acad141440388da2100c inherit pro_methods_classsdr_1_1_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">Propagates the given configuration to all connected sinks. <a href="#a3fbd9bdaf370acad141440388da2100c">More...</a><br/></td></tr>
<tr class="separator:a3fbd9bdaf370acad141440388da2100c inherit pro_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class Scalar&gt;<br/>
class sdr::BufferNode&lt; Scalar &gt;</h3>
<p>A simple buffering node, that ensures a fixed buffer size. </p>
<p>This node is useful, expecially in front of a node that performs a <a class="el" href="classsdr_1_1_f_f_t.html" title="FFT module class, provides static methods to perfrom a FFT directly. ">FFT</a> transform, which requires a certain buffer size. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a231ac24b83844174b6f611a709e50ec7"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsdr_1_1_buffer_node.html">sdr::BufferNode</a>&lt; Scalar &gt;::<a class="el" href="classsdr_1_1_buffer_node.html">BufferNode</a> </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>bufferSize</em></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>Constructs a new buffer node. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bufferSize</td><td>Specifies the desired size of the output buffers. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a827c44de5d3c5a24d548ca498ee8fea6"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classsdr_1_1_buffer_node.html">sdr::BufferNode</a>&lt; Scalar &gt;::config </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsdr_1_1_config.html">Config</a> &amp;&#160;</td>
<td class="paramname"><em>src_cfg</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Configures the buffer node. </p>
<p>Implements <a class="el" href="classsdr_1_1_sink_base.html#aacebf73840f06c82c438e352bf1eb75e">sdr::SinkBase</a>.</p>
</div>
</div>
<a class="anchor" id="abb7d0d4724ccbc18e762c1b1d55d4d95"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classsdr_1_1_buffer_node.html">sdr::BufferNode</a>&lt; Scalar &gt;::process </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt; Scalar &gt; &amp;&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>allow_overwrite</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Process the incomming data. </p>
<p>Implements <a class="el" href="classsdr_1_1_sink.html#aaa6fa5f784d5f328fc9c4e7b241a03e9">sdr::Sink&lt; Scalar &gt;</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a50fe21ba7349e28eb8c05b6bf65b9968"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsdr_1_1_buffer_set.html">BufferSet</a>&lt;Scalar&gt; <a class="el" href="classsdr_1_1_buffer_node.html">sdr::BufferNode</a>&lt; Scalar &gt;::_bufferSet</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A set of output buffers. </p>
</div>
</div>
<a class="anchor" id="a1b8c539b97c3180c6e6155a63248443b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classsdr_1_1_buffer_node.html">sdr::BufferNode</a>&lt; Scalar &gt;::_bufferSize</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The desired buffer size. </p>
</div>
</div>
<a class="anchor" id="ace6451c9fe46e682742911b9dc3aa6e9"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classsdr_1_1_buffer_node.html">sdr::BufferNode</a>&lt; Scalar &gt;::_samplesLeft</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of samples left. </p>
</div>
</div>
<a class="anchor" id="ad3b1f7333d120b68ef817ab040915c68"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt;Scalar&gt; <a class="el" href="classsdr_1_1_buffer_node.html">sdr::BufferNode</a>&lt; Scalar &gt;::_temp</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>An intermediate buffer to hold left-over samples from the previous buffers. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/hannes/sdr/libsdr/src/<a class="el" href="buffernode_8hh_source.html">buffernode.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed May 27 2015 14:36:14 for libsdr by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink