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

364 lines
21 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::DebugStore&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_debug_store.html">DebugStore</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classsdr_1_1_debug_store-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sdr::DebugStore&lt; Scalar &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__sinks.html">Data sinks.</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Keeps a copy of the last buffer received.
<a href="classsdr_1_1_debug_store.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="utils_8hh_source.html">utils.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sdr::DebugStore&lt; Scalar &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classsdr_1_1_debug_store.png" usemap="#sdr::DebugStore&lt; Scalar &gt;_map" alt=""/>
<map id="sdr::DebugStore&lt; Scalar &gt;_map" name="sdr::DebugStore&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,164,80"/>
<area href="classsdr_1_1_sink_base.html" title="Basic interface of all Sinks. " alt="sdr::SinkBase" shape="rect" coords="0,0,164,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:ae0069303062df5385e61654744f42dcb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_debug_store.html#ae0069303062df5385e61654744f42dcb">DebugStore</a> ()</td></tr>
<tr class="memdesc:ae0069303062df5385e61654744f42dcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constrctor. <a href="#ae0069303062df5385e61654744f42dcb">More...</a><br /></td></tr>
<tr class="separator:ae0069303062df5385e61654744f42dcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49a16b42f72c91fadf494ab7e3fa88de"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_debug_store.html#a49a16b42f72c91fadf494ab7e3fa88de">config</a> (const <a class="el" href="classsdr_1_1_config.html">Config</a> &amp;src_cfg)</td></tr>
<tr class="memdesc:a49a16b42f72c91fadf494ab7e3fa88de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the node. <a href="#a49a16b42f72c91fadf494ab7e3fa88de">More...</a><br /></td></tr>
<tr class="separator:a49a16b42f72c91fadf494ab7e3fa88de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4614b418a72ef58bdec3da66baa17b9"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_debug_store.html#ad4614b418a72ef58bdec3da66baa17b9">process</a> (const <a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt; Scalar &gt; &amp;<a class="el" href="classsdr_1_1_debug_store.html#acc0294ae47ad796ccbb81e90c8cbbdfb">buffer</a>, bool allow_overwrite)</td></tr>
<tr class="memdesc:ad4614b418a72ef58bdec3da66baa17b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the given buffer. <a href="#ad4614b418a72ef58bdec3da66baa17b9">More...</a><br /></td></tr>
<tr class="separator:ad4614b418a72ef58bdec3da66baa17b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc0294ae47ad796ccbb81e90c8cbbdfb"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt; Scalar &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_debug_store.html#acc0294ae47ad796ccbb81e90c8cbbdfb">buffer</a> () const </td></tr>
<tr class="memdesc:acc0294ae47ad796ccbb81e90c8cbbdfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retunrs a reference to the last received buffer. <a href="#acc0294ae47ad796ccbb81e90c8cbbdfb">More...</a><br /></td></tr>
<tr class="separator:acc0294ae47ad796ccbb81e90c8cbbdfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01c2f43a30b8642a663addcf7fd5b897"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_debug_store.html#a01c2f43a30b8642a663addcf7fd5b897">clear</a> ()</td></tr>
<tr class="memdesc:a01c2f43a30b8642a663addcf7fd5b897"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the buffer. <a href="#a01c2f43a30b8642a663addcf7fd5b897">More...</a><br /></td></tr>
<tr class="separator:a01c2f43a30b8642a663addcf7fd5b897"><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>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:adb09b528eaa679d15bb695b100e5fd2a"><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_debug_store.html#adb09b528eaa679d15bb695b100e5fd2a">_buffer</a></td></tr>
<tr class="memdesc:adb09b528eaa679d15bb695b100e5fd2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pre-allocated buffer, that will hold the last data received. <a href="#adb09b528eaa679d15bb695b100e5fd2a">More...</a><br /></td></tr>
<tr class="separator:adb09b528eaa679d15bb695b100e5fd2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae50fa8b237a4f4db86829bad5b862a17"><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_debug_store.html#ae50fa8b237a4f4db86829bad5b862a17">_view</a></td></tr>
<tr class="memdesc:ae50fa8b237a4f4db86829bad5b862a17"><td class="mdescLeft">&#160;</td><td class="mdescRight">A view to the last data received. <a href="#ae50fa8b237a4f4db86829bad5b862a17">More...</a><br /></td></tr>
<tr class="separator:ae50fa8b237a4f4db86829bad5b862a17"><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::DebugStore&lt; Scalar &gt;</h3>
<p>Keeps a copy of the last buffer received. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae0069303062df5385e61654744f42dcb"></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_debug_store.html">sdr::DebugStore</a>&lt; Scalar &gt;::<a class="el" href="classsdr_1_1_debug_store.html">DebugStore</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constrctor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="acc0294ae47ad796ccbb81e90c8cbbdfb"></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">const <a class="el" href="classsdr_1_1_buffer.html">Buffer</a>&lt;Scalar&gt;&amp; <a class="el" href="classsdr_1_1_debug_store.html">sdr::DebugStore</a>&lt; Scalar &gt;::buffer </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retunrs a reference to the last received buffer. </p>
</div>
</div>
<a class="anchor" id="a01c2f43a30b8642a663addcf7fd5b897"></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_debug_store.html">sdr::DebugStore</a>&lt; Scalar &gt;::clear </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the buffer. </p>
</div>
</div>
<a class="anchor" id="a49a16b42f72c91fadf494ab7e3fa88de"></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_debug_store.html">sdr::DebugStore</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 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="ad4614b418a72ef58bdec3da66baa17b9"></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_debug_store.html">sdr::DebugStore</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>Stores the given buffer. </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="adb09b528eaa679d15bb695b100e5fd2a"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar &gt; </div>
<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_debug_store.html">sdr::DebugStore</a>&lt; Scalar &gt;::_buffer</td>
</tr>
</table>
</div><div class="memdoc">
<p>A pre-allocated buffer, that will hold the last data received. </p>
</div>
</div>
<a class="anchor" id="ae50fa8b237a4f4db86829bad5b862a17"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Scalar &gt; </div>
<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_debug_store.html">sdr::DebugStore</a>&lt; Scalar &gt;::_view</td>
</tr>
</table>
</div><div class="memdoc">
<p>A view to the last data received. </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="utils_8hh_source.html">utils.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jun 1 2015 11:35:02 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>