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_source.html

587 lines
32 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::Source 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_source.html">Source</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="classsdr_1_1_source-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sdr::Source Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Generic source class.
<a href="classsdr_1_1_source.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::Source:</div>
<div class="dyncontent">
<div class="center">
<img src="classsdr_1_1_source.png" usemap="#sdr::Source_map" alt=""/>
<map id="sdr::Source_map" name="sdr::Source_map">
<area href="classsdr_1_1_buffer_node.html" alt="sdr::BufferNode&lt; std::complex&lt; Scalar &gt; &gt;" shape="rect" coords="276,56,542,80"/>
<area href="classsdr_1_1_f_i_r_filter.html" alt="sdr::FIRFilter&lt; Scalar, FIRBandPassCoeffs &gt;" shape="rect" coords="276,112,542,136"/>
<area href="classsdr_1_1_f_i_r_filter.html" alt="sdr::FIRFilter&lt; Scalar, FIRBandStopCoeffs &gt;" shape="rect" coords="276,168,542,192"/>
<area href="classsdr_1_1_f_i_r_filter.html" alt="sdr::FIRFilter&lt; Scalar, FIRHighPassCoeffs &gt;" shape="rect" coords="276,224,542,248"/>
<area href="classsdr_1_1_f_i_r_filter.html" alt="sdr::FIRFilter&lt; Scalar, FIRLowPassCoeffs &gt;" shape="rect" coords="276,280,542,304"/>
<area href="classsdr_1_1_a_g_c.html" title="An automatic gain control node. " alt="sdr::AGC&lt; Scalar &gt;" shape="rect" coords="276,336,542,360"/>
<area href="classsdr_1_1_a_m_demod.html" title="Amplitude modulation (AM) demodulator from an I/Q signal. " alt="sdr::AMDemod&lt; Scalar &gt;" shape="rect" coords="276,392,542,416"/>
<area href="classsdr_1_1_a_s_k_detector.html" title="Rather trivial node to detect mark/space symbols by the amplitude. " alt="sdr::ASKDetector&lt; Scalar &gt;" shape="rect" coords="276,448,542,472"/>
<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="276,504,542,528"/>
<area href="classsdr_1_1_a_x25.html" title="Decodes AX25 (PacketRadio) messages from a bit stream. " alt="sdr::AX25" shape="rect" coords="276,560,542,584"/>
<area href="classsdr_1_1_base_band.html" title="This class performs several operations on the real input stream, It first filters out some part of th..." alt="sdr::BaseBand&lt; Scalar &gt;" shape="rect" coords="276,616,542,640"/>
<area href="classsdr_1_1_baudot.html" title="Implements a Baudot decoder. " alt="sdr::Baudot" shape="rect" coords="276,672,542,696"/>
<area href="classsdr_1_1_bit_stream.html" title="Decodes a bitstream with the desired baud rate. " alt="sdr::BitStream" shape="rect" coords="276,728,542,752"/>
<area href="classsdr_1_1_blocking_source.html" title="Iterface of a blocking source. " alt="sdr::BlockingSource" shape="rect" coords="276,784,542,808"/>
<area href="classsdr_1_1_b_p_s_k31.html" title="A simple BPSK31 "demodulator". " alt="sdr::BPSK31&lt; Scalar &gt;" shape="rect" coords="276,840,542,864"/>
<area href="classsdr_1_1_buffer_node.html" title="A simple buffering node, that ensures a fixed buffer size. " alt="sdr::BufferNode&lt; Scalar &gt;" shape="rect" coords="276,896,542,920"/>
<area href="classsdr_1_1_cast.html" title="Explicit type cast node. " alt="sdr::Cast&lt; iScalar, oScalar &gt;" shape="rect" coords="276,952,542,976"/>
<area href="classsdr_1_1_filter_sink.html" title="Performs the FFT forward transform. " alt="sdr::FilterSink&lt; Scalar &gt;" shape="rect" coords="276,1008,542,1032"/>
<area href="classsdr_1_1_filter_source.html" title="Performs the overlap-add FFT filtering and back-transform. " alt="sdr::FilterSource&lt; Scalar &gt;" shape="rect" coords="276,1064,542,1088"/>
<area href="classsdr_1_1_f_i_r_filter.html" title="Generic FIR filter class. " alt="sdr::FIRFilter&lt; Scalar, FilterCoeffs &gt;" shape="rect" coords="276,1120,542,1144"/>
<area href="classsdr_1_1_f_m_deemph.html" title="A tiny node to de-emphasize the higher frequencies of a FM transmitted audio signal. " alt="sdr::FMDeemph&lt; Scalar &gt;" shape="rect" coords="276,1176,542,1200"/>
<area href="classsdr_1_1_f_m_demod.html" title="Demodulates FM from an I/Q signal. " alt="sdr::FMDemod&lt; iScalar, oScalar &gt;" shape="rect" coords="276,1232,542,1256"/>
<area href="classsdr_1_1_freq_shift.html" title="Performs a frequency shift on a complex input signal, by multiplying it with . " alt="sdr::FreqShift&lt; Scalar &gt;" shape="rect" coords="276,1288,542,1312"/>
<area href="classsdr_1_1_f_s_k_detector.html" title="Implements the basic FSK/AFSK symbol detection. " alt="sdr::FSKDetector" shape="rect" coords="276,1344,542,1368"/>
<area href="classsdr_1_1_g_w_n_source.html" title="A Gaussian White Noise source. " alt="sdr::GWNSource&lt; Scalar &gt;" shape="rect" coords="276,1400,542,1424"/>
<area href="classsdr_1_1_inpol_sub_sampler.html" title="An interpolating sub-sampler. " alt="sdr::InpolSubSampler&lt; iScalar, oScalar &gt;" shape="rect" coords="276,1456,542,1480"/>
<area href="classsdr_1_1_interleave.html" title="Interleaves several input streams. " alt="sdr::Interleave&lt; Scalar &gt;" shape="rect" coords="276,1512,542,1536"/>
<area href="classsdr_1_1_i_q_balance.html" title="A simple node, that allows to balance an IQ signal. " alt="sdr::IQBalance&lt; Scalar &gt;" shape="rect" coords="276,1568,542,1592"/>
<area href="classsdr_1_1_i_q_base_band.html" title="This class performs several operations on the complex (integral) input stream, it first filters out s..." alt="sdr::IQBaseBand&lt; Scalar &gt;" shape="rect" coords="276,1624,542,1648"/>
<area href="classsdr_1_1_i_q_sig_gen.html" title="Arbitrary function generator. " alt="sdr::IQSigGen&lt; Scalar &gt;" shape="rect" coords="276,1680,542,1704"/>
<area href="classsdr_1_1_port_source.html" title="PortAudio input stream as a Source. " alt="sdr::PortSource&lt; Scalar &gt;" shape="rect" coords="276,1736,542,1760"/>
<area href="classsdr_1_1_proxy.html" title="A NOP node. " alt="sdr::Proxy" shape="rect" coords="276,1792,542,1816"/>
<area href="classsdr_1_1_real_imag_part.html" title="Extracts the real or imaginary part of a complex valued data stream. " alt="sdr::RealImagPart&lt; Scalar &gt;" shape="rect" coords="276,1848,542,1872"/>
<area href="classsdr_1_1_r_t_l_source.html" title="Implements a uint_8 I/Q source for RTL2832 based TV dongles. " alt="sdr::RTLSource" shape="rect" coords="276,1904,542,1928"/>
<area href="classsdr_1_1_scale.html" title="Simple scaling node. " alt="sdr::Scale&lt; Scalar &gt;" shape="rect" coords="276,1960,542,1984"/>
<area href="classsdr_1_1_sig_gen.html" title="Arbitrary function generator. " alt="sdr::SigGen&lt; Scalar &gt;" shape="rect" coords="276,2016,542,2040"/>
<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="276,2072,542,2096"/>
<area href="classsdr_1_1_stream_source.html" title="Reads raw samples from an imput stream, (ie a file). " alt="sdr::StreamSource&lt; Scalar &gt;" shape="rect" coords="276,2128,542,2152"/>
<area href="classsdr_1_1_sub_sample.html" title="Simple averaging sub-sampler. " alt="sdr::SubSample&lt; Scalar &gt;" shape="rect" coords="276,2184,542,2208"/>
<area href="classsdr_1_1_to_complex.html" title="Tiny helper node to transform a real part into a complex, including a possible type-cast. " alt="sdr::ToComplex&lt; iScalar, oScalar &gt;" shape="rect" coords="276,2240,542,2264"/>
<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="276,2296,542,2320"/>
<area href="classsdr_1_1_u_s_b_demod.html" title="SSB upper side band (USB) demodulator from an I/Q signal. " alt="sdr::USBDemod&lt; Scalar &gt;" shape="rect" coords="276,2352,542,2376"/>
<area href="classsdr_1_1_varicode.html" title="Simple varicode (Huffman code) decoder node. " alt="sdr::Varicode" shape="rect" coords="276,2408,542,2432"/>
<area href="classsdr_1_1_wav_source.html" title="A simple imput source that reads from a wav file. " alt="sdr::WavSource" shape="rect" coords="276,2464,542,2488"/>
</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:a660c0a4b8b8f8402568bef86f2cb2fbb"><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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a660c0a4b8b8f8402568bef86f2cb2fbb">More...</a><br /></td></tr>
<tr class="separator:a660c0a4b8b8f8402568bef86f2cb2fbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5104a4d66641ae529419b47da4a1473"><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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#ac5104a4d66641ae529419b47da4a1473">More...</a><br /></td></tr>
<tr class="separator:ac5104a4d66641ae529419b47da4a1473"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13921d5daa00574e2057c1ae1fc28054"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7df1faefb31e72e135eec3ecf539132"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b1d1ccef6cee5f4668ee67bc28eed7a"><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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnect a sink again. <a href="#a9b1d1ccef6cee5f4668ee67bc28eed7a">More...</a><br /></td></tr>
<tr class="separator:a9b1d1ccef6cee5f4668ee67bc28eed7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd4c7e3fb94a057ac40e9877167791ec"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca6c3a89bb5787de5657c4d221bb1ed4"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9362057c06f35e0a23901cc0556b976"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cf977be7a508097532991155e90ae45"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:a7cf977be7a508097532991155e90ae45"><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"><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"><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:a30eeb1d98d9759ef01a36e938a1172bc"><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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signals the EOS. <a href="#a30eeb1d98d9759ef01a36e938a1172bc">More...</a><br /></td></tr>
<tr class="separator:a30eeb1d98d9759ef01a36e938a1172bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fbd9bdaf370acad141440388da2100c"><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"><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"><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:ac7ea547c33d45cf5b5654ce21957ab27"><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"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d030b840c4a1ad45d7a6598f9f582b9"><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"><td class="mdescLeft">&#160;</td><td class="mdescRight">The connected sinks. <a href="#a2d030b840c4a1ad45d7a6598f9f582b9">More...</a><br /></td></tr>
<tr class="separator:a2d030b840c4a1ad45d7a6598f9f582b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee600dc30d6f91466acec5ffcde0f3ac"><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"><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"><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>Generic source class. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a660c0a4b8b8f8402568bef86f2cb2fbb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Source::Source </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="ac5104a4d66641ae529419b47da4a1473"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Source::~Source </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="a7cf977be7a508097532991155e90ae45"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sdr::Source::addEOS </td>
<td>(</td>
<td class="paramtype">T *&#160;</td>
<td class="paramname"><em>instance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(T::*)()&#160;</td>
<td class="paramname"><em>function</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a callback to the end-of-stream signal of the source. </p>
</div>
</div>
<a class="anchor" id="ac7df1faefb31e72e135eec3ecf539132"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Source::connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a> *&#160;</td>
<td class="paramname"><em>sink</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>direct</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Connect this source to a sink. </p>
</div>
</div>
<a class="anchor" id="a9b1d1ccef6cee5f4668ee67bc28eed7a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Source::disconnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a> *&#160;</td>
<td class="paramname"><em>sink</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disconnect a sink again. </p>
</div>
</div>
<a class="anchor" id="a3fbd9bdaf370acad141440388da2100c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Source::propagateConfig </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>config</em></td><td>)</td>
<td></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>Propagates the given configuration to all connected sinks. </p>
</div>
</div>
<a class="anchor" id="aca6c3a89bb5787de5657c4d221bb1ed4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double Source::sampleRate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Returns the configured sample rate or <code>0</code> otherwise. </p>
<p>Reimplemented in <a class="el" href="classsdr_1_1_r_t_l_source.html#ad04242d3c53001a17a50d4e372316366">sdr::RTLSource</a>.</p>
</div>
</div>
<a class="anchor" id="a13921d5daa00574e2057c1ae1fc28054"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Source::send </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> = <code>false</code>&#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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sends the given buffer to all connected sinks. </p>
</div>
</div>
<a class="anchor" id="afd4c7e3fb94a057ac40e9877167791ec"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Source::setConfig </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>config</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>Stores the configuration and propergates it if the configuration has been changed. </p>
</div>
</div>
<a class="anchor" id="a30eeb1d98d9759ef01a36e938a1172bc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Source::signalEOS </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Signals the EOS. </p>
</div>
</div>
<a class="anchor" id="ab9362057c06f35e0a23901cc0556b976"></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="classsdr_1_1_config.html#a62084c40ed753ff6caefdc4564c597b8">Config::Type</a> Source::type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Returns the configured source type or <code>Config::Type_UNDEFINED</code> otherwise. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ac7ea547c33d45cf5b5654ce21957ab27"></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="classsdr_1_1_config.html">Config</a> sdr::Source::_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>Holds the source configuration, this can be updated by calling <code>setConfig</code>. </p>
</div>
</div>
<a class="anchor" id="aee600dc30d6f91466acec5ffcde0f3ac"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::list&lt;<a class="el" href="classsdr_1_1_delegate_interface.html">DelegateInterface</a> *&gt; sdr::Source::_eos</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 connected EOS singal handlers. </p>
</div>
</div>
<a class="anchor" id="a2d030b840c4a1ad45d7a6598f9f582b9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::map&lt;<a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a> *, bool&gt; sdr::Source::_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 connected sinks. </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:40 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