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.
libsdr/classsdr_1_1_sink_base.html

266 lines
19 KiB
HTML

<!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::SinkBase 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="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_sink_base.html">SinkBase</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classsdr_1_1_sink_base-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sdr::SinkBase Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Basic interface of all Sinks.
<a href="classsdr_1_1_sink_base.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="node_8hh_source.html">node.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sdr::SinkBase:</div>
<div class="dyncontent">
<div class="center">
<img src="classsdr_1_1_sink_base.png" usemap="#sdr::SinkBase_map" alt=""/>
<map id="sdr::SinkBase_map" name="sdr::SinkBase_map">
<area href="classsdr_1_1_auto_cast.html" title="This class performs some automatic casts to a certain buffer type (if possible) specified by the temp..." alt="sdr::AutoCast&lt; Scalar &gt;" shape="rect" coords="226,56,442,80"/>
<area href="classsdr_1_1_port_sink.html" title="PortAudio playback node. " alt="sdr::PortSink" shape="rect" coords="226,112,442,136"/>
<area href="classsdr_1_1_proxy.html" title="A NOP node. " alt="sdr::Proxy" shape="rect" coords="226,168,442,192"/>
<area href="classsdr_1_1_signed_to_unsigned.html" title="Performs a reinterprete cast from an unsinged value to a singed one. " alt="sdr::SignedToUnsigned" shape="rect" coords="226,224,442,248"/>
<area href="classsdr_1_1_sink.html" title="Typed sink. " alt="sdr::Sink&lt; Scalar &gt;" shape="rect" coords="226,280,442,304"/>
<area href="classsdr_1_1_unsigned_to_signed.html" title="Performs a reinterprete cast from an unsinged value to a singed one. " alt="sdr::UnsignedToSigned" shape="rect" coords="226,336,442,360"/>
<area href="classsdr_1_1_sink.html" alt="sdr::Sink&lt; int16_t &gt;" shape="rect" coords="226,392,442,416"/>
<area href="classsdr_1_1_sink.html" alt="sdr::Sink&lt; iScalar &gt;" shape="rect" coords="226,448,442,472"/>
<area href="classsdr_1_1_sink.html" alt="sdr::Sink&lt; std::complex&lt; iScalar &gt; &gt;" shape="rect" coords="226,504,442,528"/>
<area href="classsdr_1_1_sink.html" alt="sdr::Sink&lt; std::complex&lt; Scalar &gt; &gt;" shape="rect" coords="226,560,442,584"/>
<area href="classsdr_1_1_sink.html" alt="sdr::Sink&lt; uint8_t &gt;" shape="rect" coords="226,616,442,640"/>
</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:aaa9fb7219aa47e809ff1d62a819a2d57"><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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#aaa9fb7219aa47e809ff1d62a819a2d57">More...</a><br /></td></tr>
<tr class="separator:aaa9fb7219aa47e809ff1d62a819a2d57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a522205396205d6d3601da6a65bdaf75a"><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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a522205396205d6d3601da6a65bdaf75a">More...</a><br /></td></tr>
<tr class="separator:a522205396205d6d3601da6a65bdaf75a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae64ff25bdf0b31ec5366dab55e219088"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_sink_base.html#ae64ff25bdf0b31ec5366dab55e219088">handleBuffer</a> (const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &amp;buffer, bool allow_overwrite)=0</td></tr>
<tr class="memdesc:ae64ff25bdf0b31ec5366dab55e219088"><td class="mdescLeft">&#160;</td><td class="mdescRight">Needs to be implemented by any sub-type to process the received data. <a href="#ae64ff25bdf0b31ec5366dab55e219088">More...</a><br /></td></tr>
<tr class="separator:ae64ff25bdf0b31ec5366dab55e219088"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacebf73840f06c82c438e352bf1eb75e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_sink_base.html#aacebf73840f06c82c438e352bf1eb75e">config</a> (const <a class="el" href="classsdr_1_1_config.html">Config</a> &amp;src_cfg)=0</td></tr>
<tr class="memdesc:aacebf73840f06c82c438e352bf1eb75e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Needs to be implemented by any sub-type to check and perform the configuration of the node. <a href="#aacebf73840f06c82c438e352bf1eb75e">More...</a><br /></td></tr>
<tr class="separator:aacebf73840f06c82c438e352bf1eb75e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Basic interface of all Sinks. </p>
<p>Usually, sinks are derived from the <code><a class="el" href="classsdr_1_1_sink.html" title="Typed sink. ">Sink</a></code> template. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aaa9fb7219aa47e809ff1d62a819a2d57"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SinkBase::SinkBase </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="a522205396205d6d3601da6a65bdaf75a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">SinkBase::~SinkBase </td>
<td>(</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>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aacebf73840f06c82c438e352bf1eb75e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void sdr::SinkBase::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Needs to be implemented by any sub-type to check and perform the configuration of the node. </p>
<p>Implemented in <a class="el" href="classsdr_1_1_text_dump.html#aca4ba1d0b79cd18dabc5df25f9b2d765">sdr::TextDump</a>, <a class="el" href="classsdr_1_1_debug_dump.html#af496d34703693264a457c4f9cb8b6b44">sdr::DebugDump&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_debug_store.html#a49a16b42f72c91fadf494ab7e3fa88de">sdr::DebugStore&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_a_g_c.html#a76db615ca776e62d16c7ab8b9f348afa">sdr::AGC&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_scale.html#a2b70619a04f2f50aaea59828f0d333e5">sdr::Scale&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_stream_sink.html#ace62c79416acaa9680fc48da13bd583e">sdr::StreamSink&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_freq_shift.html#a2aeaf444562a0b054ae65442992caefc">sdr::FreqShift&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_signed_to_unsigned.html#a3c95c11ec3424ab0188f4cfacb175a0c">sdr::SignedToUnsigned</a>, <a class="el" href="classsdr_1_1_unsigned_to_signed.html#a96623592a4d99c2305896d47bd7ccf03">sdr::UnsignedToSigned</a>, <a class="el" href="classsdr_1_1_base_band.html#adcaeff6352ee34550c04c9d42f669dbe">sdr::BaseBand&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_proxy.html#adb2f2d95d1fd6921b2143116bb0de448">sdr::Proxy</a>, <a class="el" href="classsdr_1_1_f_m_deemph.html#a01f7e78791d641c3498344e712f86bea">sdr::FMDeemph&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_varicode.html#adf7cb0e1e1603a8c3ab6432932e4d21f">sdr::Varicode</a>, <a class="el" href="classsdr_1_1_cast.html#a7abe34a154f45e89f1b8df475cb8109d">sdr::Cast&lt; iScalar, oScalar &gt;</a>, <a class="el" href="classsdr_1_1_to_complex.html#a318dbc6cdaf30baf9ee2de67ac57bc5a">sdr::ToComplex&lt; iScalar, oScalar &gt;</a>, <a class="el" href="classsdr_1_1_inpol_sub_sampler.html#ad2bdbee4da505eb76b4b89694aef9e2f">sdr::InpolSubSampler&lt; iScalar, oScalar &gt;</a>, <a class="el" href="classsdr_1_1_f_m_demod.html#a8f3008f786982883d9a1b2284a8b0a57">sdr::FMDemod&lt; iScalar, oScalar &gt;</a>, <a class="el" href="classsdr_1_1_bit_dump.html#a99f0038ca11b8f2bcd940c57a570fb4c">sdr::BitDump</a>, <a class="el" href="classsdr_1_1_f_i_r_filter.html#add82f22f403ae4aaa004788a78bf6fb3">sdr::FIRFilter&lt; Scalar, FilterCoeffs &gt;</a>, <a class="el" href="classsdr_1_1_f_i_r_filter.html#add82f22f403ae4aaa004788a78bf6fb3">sdr::FIRFilter&lt; Scalar, FIRBandPassCoeffs &gt;</a>, <a class="el" href="classsdr_1_1_f_i_r_filter.html#add82f22f403ae4aaa004788a78bf6fb3">sdr::FIRFilter&lt; Scalar, FIRBandStopCoeffs &gt;</a>, <a class="el" href="classsdr_1_1_f_i_r_filter.html#add82f22f403ae4aaa004788a78bf6fb3">sdr::FIRFilter&lt; Scalar, FIRHighPassCoeffs &gt;</a>, <a class="el" href="classsdr_1_1_f_i_r_filter.html#add82f22f403ae4aaa004788a78bf6fb3">sdr::FIRFilter&lt; Scalar, FIRLowPassCoeffs &gt;</a>, <a class="el" href="classsdr_1_1_i_q_balance.html#ad87c15d962ab16363ab0b463a9e9724b">sdr::IQBalance&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_bit_stream.html#a98345187427af72ba6b51dbd120d539f">sdr::BitStream</a>, <a class="el" href="classsdr_1_1_filter_source.html#aedb6195cdaeadd83f18bd5c699aeb31a">sdr::FilterSource&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_i_q_base_band.html#a737f6c7d26595934f3d5a577304d4e97">sdr::IQBaseBand&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_u_s_b_demod.html#af337424855632186cbfe8d241845e7e1">sdr::USBDemod&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_p_o_c_s_a_g.html#a1e6fcb4a9cb1aeb98918a60d57b33a93">sdr::POCSAG</a>, <a class="el" href="classsdr_1_1_a_s_k_detector.html#a30359528ceb5ecca030e84d00bc4d384">sdr::ASKDetector&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_b_p_s_k31.html#a36da3163abca21c2dcd042139de0a36e">sdr::BPSK31&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_wav_sink.html#a8fe7a9c850f1d7ab49a258f204e389b5">sdr::WavSink&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_filter_sink.html#a1331f69c193bfbbf7309347295c5661c">sdr::FilterSink&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_port_sink.html#a864372dbd08d8f5cc0fd8731f093fea0">sdr::PortSink</a>, <a class="el" href="classsdr_1_1_baudot.html#a6bbfc71b128015c7656d31c47a3c56d4">sdr::Baudot</a>, <a class="el" href="classsdr_1_1_sub_sample.html#a0191ff1b7142c17ed24a05ba502ebbc8">sdr::SubSample&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_a_m_demod.html#ae7a8db03a6982ae33c4786ab3b82a6cc">sdr::AMDemod&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_combine_sink.html#a0ff7d730bc75a6e7b36d12c42a8ebbf1">sdr::CombineSink&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_buffer_node.html#a827c44de5d3c5a24d548ca498ee8fea6">sdr::BufferNode&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_buffer_node.html#a827c44de5d3c5a24d548ca498ee8fea6">sdr::BufferNode&lt; std::complex&lt; Scalar &gt; &gt;</a>, <a class="el" href="classsdr_1_1_real_imag_part.html#ad1a035bdf7d65807bc00f02e76b14cfa">sdr::RealImagPart&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_a_x25.html#a35ae34c6c6337f67adbcb3a6e0c8fac8">sdr::AX25</a>, <a class="el" href="classsdr_1_1_f_s_k_detector.html#ad36f7ab9733bb7acb07a24b62d32b36d">sdr::FSKDetector</a>, and <a class="el" href="classsdr_1_1_auto_cast.html#ad8f0b826c405a26bdb0884690b1dc1e6">sdr::AutoCast&lt; Scalar &gt;</a>.</p>
</div>
</div>
<a class="anchor" id="ae64ff25bdf0b31ec5366dab55e219088"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void sdr::SinkBase::handleBuffer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Needs to be implemented by any sub-type to process the received data. </p>
<p>Implemented in <a class="el" href="classsdr_1_1_signed_to_unsigned.html#a45b29ca444478cb29c6faf119024efe6">sdr::SignedToUnsigned</a>, <a class="el" href="classsdr_1_1_unsigned_to_signed.html#a0d33c6c5e8cbfee5b549daa11263f471">sdr::UnsignedToSigned</a>, <a class="el" href="classsdr_1_1_proxy.html#a2fff7c978c2cf3e7e80a3eca7ea8a4f6">sdr::Proxy</a>, <a class="el" href="classsdr_1_1_sink.html#a25b0849e40053f87496ca72f8b8cd9e2">sdr::Sink&lt; Scalar &gt;</a>, <a class="el" href="classsdr_1_1_sink.html#a25b0849e40053f87496ca72f8b8cd9e2">sdr::Sink&lt; int16_t &gt;</a>, <a class="el" href="classsdr_1_1_sink.html#a25b0849e40053f87496ca72f8b8cd9e2">sdr::Sink&lt; std::complex&lt; Scalar &gt; &gt;</a>, <a class="el" href="classsdr_1_1_sink.html#a25b0849e40053f87496ca72f8b8cd9e2">sdr::Sink&lt; std::complex&lt; iScalar &gt; &gt;</a>, <a class="el" href="classsdr_1_1_sink.html#a25b0849e40053f87496ca72f8b8cd9e2">sdr::Sink&lt; uint8_t &gt;</a>, <a class="el" href="classsdr_1_1_sink.html#a25b0849e40053f87496ca72f8b8cd9e2">sdr::Sink&lt; iScalar &gt;</a>, <a class="el" href="classsdr_1_1_auto_cast.html#a8acf3f265d8da760d0b75c9281da8c28">sdr::AutoCast&lt; Scalar &gt;</a>, and <a class="el" href="classsdr_1_1_port_sink.html#a080e01c07a812fa597487a88bc99b196">sdr::PortSink</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/<a class="el" href="node_8hh_source.html">node.hh</a></li>
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/node.cc</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 2 2015 18:28:39 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>