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 '944627f6f6'
${ noResults }
libsdr/classsdr_1_1_combine.html

446 lines
21 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.9.1"/>
<title>libsdr: sdr::Combine&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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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.9.1 -->
<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><a href="modules.html"><span>Modules</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)">
</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_combine.html">Combine</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classsdr_1_1_combine-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sdr::Combine&lt; Scalar &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__datanodes.html">Data handling nodes.</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A combine node.
<a href="classsdr_1_1_combine.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="combine_8hh_source.html">combine.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sdr::Combine&lt; Scalar &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classsdr_1_1_combine.png" usemap="#sdr::Combine&lt; Scalar &gt;_map" alt=""/>
<map id="sdr::Combine&lt; Scalar &gt;_map" name="sdr::Combine&lt; Scalar &gt;_map">
<area href="classsdr_1_1_interleave.html" title="Interleaves several input streams. " alt="sdr::Interleave&lt; Scalar &gt;" shape="rect" coords="0,56,153,80"/>
</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:a9a4a802d6a0fd840cb909e0f8e0805ed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_combine.html#a9a4a802d6a0fd840cb909e0f8e0805ed">Combine</a> (size_t N)</td></tr>
<tr class="memdesc:a9a4a802d6a0fd840cb909e0f8e0805ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor, <br />
N specifies the number of sinks. <a href="#a9a4a802d6a0fd840cb909e0f8e0805ed">More...</a><br /></td></tr>
<tr class="separator:a9a4a802d6a0fd840cb909e0f8e0805ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22d4833e0ee07e58ee84313820c929fa"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_combine.html#a22d4833e0ee07e58ee84313820c929fa">~Combine</a> ()</td></tr>
<tr class="memdesc:a22d4833e0ee07e58ee84313820c929fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a22d4833e0ee07e58ee84313820c929fa">More...</a><br /></td></tr>
<tr class="separator:a22d4833e0ee07e58ee84313820c929fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a125ddc97065e6ae85bc8a1fce8d8cc6b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_combine.html#a125ddc97065e6ae85bc8a1fce8d8cc6b">config</a> (const <a class="el" href="classsdr_1_1_config.html">Config</a> &amp;cfg)=0</td></tr>
<tr class="memdesc:a125ddc97065e6ae85bc8a1fce8d8cc6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Needs to be overridden. <a href="#a125ddc97065e6ae85bc8a1fce8d8cc6b">More...</a><br /></td></tr>
<tr class="separator:a125ddc97065e6ae85bc8a1fce8d8cc6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7df4082b6b821c36fc61197b9bd561ae"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_combine.html#a7df4082b6b821c36fc61197b9bd561ae">process</a> (std::vector&lt; <a class="el" href="classsdr_1_1_ring_buffer.html">RingBuffer</a>&lt; Scalar &gt; &gt; &amp;buffers, size_t N)=0</td></tr>
<tr class="memdesc:a7df4082b6b821c36fc61197b9bd561ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Needs to be overridden. <a href="#a7df4082b6b821c36fc61197b9bd561ae">More...</a><br /></td></tr>
<tr class="separator:a7df4082b6b821c36fc61197b9bd561ae"><td class="memSeparator" colspan="2">&#160;</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:ae9a58e1e60e3f8aeb7c99266504302ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_combine.html#ae9a58e1e60e3f8aeb7c99266504302ab">notifyConfig</a> (size_t idx, const <a class="el" href="classsdr_1_1_config.html">Config</a> &amp;cfg)</td></tr>
<tr class="memdesc:ae9a58e1e60e3f8aeb7c99266504302ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unifies the configuration of all sinks. <a href="#ae9a58e1e60e3f8aeb7c99266504302ab">More...</a><br /></td></tr>
<tr class="separator:ae9a58e1e60e3f8aeb7c99266504302ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a122bd26fcf778feb91b4304b3af7056c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_combine.html#a122bd26fcf778feb91b4304b3af7056c">notifyData</a> (size_t idx)</td></tr>
<tr class="memdesc:a122bd26fcf778feb91b4304b3af7056c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the minimum amount of data that is available on all ring buffers. <a href="#a122bd26fcf778feb91b4304b3af7056c">More...</a><br /></td></tr>
<tr class="separator:a122bd26fcf778feb91b4304b3af7056c"><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:a46442ff7ace056d83ed22fcabe3b9caa"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classsdr_1_1_ring_buffer.html">RingBuffer</a>&lt; Scalar &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_combine.html#a46442ff7ace056d83ed22fcabe3b9caa">_buffers</a></td></tr>
<tr class="memdesc:a46442ff7ace056d83ed22fcabe3b9caa"><td class="mdescLeft">&#160;</td><td class="mdescRight">The ring buffers of all combine sinks. <a href="#a46442ff7ace056d83ed22fcabe3b9caa">More...</a><br /></td></tr>
<tr class="separator:a46442ff7ace056d83ed22fcabe3b9caa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bbe7c33dac4827b42eae989b9b0d505"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classsdr_1_1_combine_sink.html">CombineSink</a>&lt; Scalar &gt; * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_combine.html#a2bbe7c33dac4827b42eae989b9b0d505">_sinks</a></td></tr>
<tr class="memdesc:a2bbe7c33dac4827b42eae989b9b0d505"><td class="mdescLeft">&#160;</td><td class="mdescRight">The combine sinks. <a href="#a2bbe7c33dac4827b42eae989b9b0d505">More...</a><br /></td></tr>
<tr class="separator:a2bbe7c33dac4827b42eae989b9b0d505"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b25fb98f4cfc8956b00ecb6f48ce5ff"><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_combine.html#a6b25fb98f4cfc8956b00ecb6f48ce5ff">_config</a></td></tr>
<tr class="memdesc:a6b25fb98f4cfc8956b00ecb6f48ce5ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">The output configuration. <a href="#a6b25fb98f4cfc8956b00ecb6f48ce5ff">More...</a><br /></td></tr>
<tr class="separator:a6b25fb98f4cfc8956b00ecb6f48ce5ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a1fd1dbc5d62c3aa3d6595266bb484e72"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1fd1dbc5d62c3aa3d6595266bb484e72"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>CombineSink&lt; Scalar &gt;</b></td></tr>
<tr class="separator:a1fd1dbc5d62c3aa3d6595266bb484e72"><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::Combine&lt; Scalar &gt;</h3>
<p>A combine node. </p>
<p>This node allows to combine several streams into one. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a9a4a802d6a0fd840cb909e0f8e0805ed"></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_combine.html">sdr::Combine</a>&lt; Scalar &gt;::<a class="el" href="classsdr_1_1_combine.html">Combine</a> </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>N</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>Constructor, <br />
N specifies the number of sinks. </p>
</div>
</div>
<a class="anchor" id="a22d4833e0ee07e58ee84313820c929fa"></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 <a class="el" href="classsdr_1_1_combine.html">sdr::Combine</a>&lt; Scalar &gt;::~<a class="el" href="classsdr_1_1_combine.html">Combine</a> </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a125ddc97065e6ae85bc8a1fce8d8cc6b"></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_combine.html">sdr::Combine</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>cfg</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Needs to be overridden. </p>
<p>Implemented in <a class="el" href="classsdr_1_1_interleave.html#a565f44f9a680816ab9267bfb96cfe4c1">sdr::Interleave&lt; Scalar &gt;</a>.</p>
</div>
</div>
<a class="anchor" id="ae9a58e1e60e3f8aeb7c99266504302ab"></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">void <a class="el" href="classsdr_1_1_combine.html">sdr::Combine</a>&lt; Scalar &gt;::notifyConfig </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>idx</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>cfg</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">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unifies the configuration of all sinks. </p>
</div>
</div>
<a class="anchor" id="a122bd26fcf778feb91b4304b3af7056c"></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">void <a class="el" href="classsdr_1_1_combine.html">sdr::Combine</a>&lt; Scalar &gt;::notifyData </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>idx</em></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">
<p>Determines the minimum amount of data that is available on all ring buffers. </p>
</div>
</div>
<a class="anchor" id="a7df4082b6b821c36fc61197b9bd561ae"></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_combine.html">sdr::Combine</a>&lt; Scalar &gt;::process </td>
<td>(</td>
<td class="paramtype">std::vector&lt; <a class="el" href="classsdr_1_1_ring_buffer.html">RingBuffer</a>&lt; Scalar &gt; &gt; &amp;&#160;</td>
<td class="paramname"><em>buffers</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>N</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Needs to be overridden. </p>
<p>Implemented in <a class="el" href="classsdr_1_1_interleave.html#a274faa3e0620ff05297809761a51aa85">sdr::Interleave&lt; Scalar &gt;</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a46442ff7ace056d83ed22fcabe3b9caa"></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">std::vector&lt; <a class="el" href="classsdr_1_1_ring_buffer.html">RingBuffer</a>&lt;Scalar&gt; &gt; <a class="el" href="classsdr_1_1_combine.html">sdr::Combine</a>&lt; Scalar &gt;::_buffers</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 ring buffers of all combine sinks. </p>
</div>
</div>
<a class="anchor" id="a6b25fb98f4cfc8956b00ecb6f48ce5ff"></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_config.html">Config</a> <a class="el" href="classsdr_1_1_combine.html">sdr::Combine</a>&lt; Scalar &gt;::_config</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 output configuration. </p>
</div>
</div>
<a class="anchor" id="a2bbe7c33dac4827b42eae989b9b0d505"></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">std::vector&lt; <a class="el" href="classsdr_1_1_combine_sink.html">CombineSink</a>&lt;Scalar&gt; *&gt; <a class="el" href="classsdr_1_1_combine.html">sdr::Combine</a>&lt; Scalar &gt;::_sinks</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 combine sinks. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/<a class="el" href="combine_8hh_source.html">combine.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 2 2015 18:28:37 for libsdr by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink