class_i_sender.html

<!-- HTML header for doxygen 1.8.14-->
<!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.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iPlug 2: ISender&lt; MAXNC, QUEUE_SIZE, T &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/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="style.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: 80px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">iPlug2 - C++ Audio Plug-in Framework
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="class_i_sender-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ISender&lt; MAXNC, QUEUE_SIZE, T &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="class_i_sender.html" title="ISender is a utility class which can be used to defer data from the realtime audio processing and sen...">ISender</a> is a utility class which can be used to defer data from the realtime audio processing and send it to the GUI for visualization.  
 <a href="class_i_sender.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_i_sender_8h_source.html">ISender.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ISender&lt; MAXNC, QUEUE_SIZE, T &gt;:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="class_i_sender__inherit__graph.svg" width="100%" height="434"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a92a9c820f01facfff1cb4af02a35911f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_sender.html#a92a9c820f01facfff1cb4af02a35911f">PushData</a> (const <a class="el" href="struct_i_sender_data.html">ISenderData</a>&lt; MAXNC, T &gt; &amp;d)</td></tr>
<tr class="memdesc:a92a9c820f01facfff1cb4af02a35911f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pushes a data element onto the queue.  <a href="class_i_sender.html#a92a9c820f01facfff1cb4af02a35911f">More...</a><br /></td></tr>
<tr class="separator:a92a9c820f01facfff1cb4af02a35911f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72921db73b016904ac9980940741c63e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_sender.html#a72921db73b016904ac9980940741c63e">PrepareDataForUI</a> (<a class="el" href="struct_i_sender_data.html">ISenderData</a>&lt; MAXNC, T &gt; &amp;d)</td></tr>
<tr class="memdesc:a72921db73b016904ac9980940741c63e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is called on the main thread and can be used to transform the data, e.g.  <a href="class_i_sender.html#a72921db73b016904ac9980940741c63e">More...</a><br /></td></tr>
<tr class="separator:a72921db73b016904ac9980940741c63e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad61c80e910d77b335ee04174949355e6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_sender.html#ad61c80e910d77b335ee04174949355e6">TransmitData</a> (<a class="el" href="class_i_editor_delegate.html">IEditorDelegate</a> &amp;dlg)</td></tr>
<tr class="memdesc:ad61c80e910d77b335ee04174949355e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pops elements off the queue and sends messages to controls.  <a href="class_i_sender.html#ad61c80e910d77b335ee04174949355e6">More...</a><br /></td></tr>
<tr class="separator:ad61c80e910d77b335ee04174949355e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a969329ff6714cfa7ed8429702146f499"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_sender.html#a969329ff6714cfa7ed8429702146f499">TransmitDataToControlsWithTags</a> (<a class="el" href="class_i_editor_delegate.html">IEditorDelegate</a> &amp;dlg, const std::initializer_list&lt; int &gt; &amp;ctrlTags)</td></tr>
<tr class="memdesc:a969329ff6714cfa7ed8429702146f499"><td class="mdescLeft">&#160;</td><td class="mdescRight">This variation can be used if you need to supply multiple controls with the same <a class="el" href="struct_i_sender_data.html" title="ISenderData is used to represent a typed data packet, that may contain values for multiple channels.">ISenderData</a>, overriding the tags in the data packet.  <a href="class_i_sender.html#a969329ff6714cfa7ed8429702146f499">More...</a><br /></td></tr>
<tr class="separator:a969329ff6714cfa7ed8429702146f499"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:aed4e25d47ab3555cda2bc259e8aa1b1f"><td class="memItemLeft" align="right" valign="top">static constexpr int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_sender.html#aed4e25d47ab3555cda2bc259e8aa1b1f">kUpdateMessage</a> = 0</td></tr>
<tr class="separator:aed4e25d47ab3555cda2bc259e8aa1b1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;int MAXNC = 1, int QUEUE_SIZE = 64, typename T = float&gt;<br />
class ISender&lt; MAXNC, QUEUE_SIZE, T &gt;</div><p ><a class="el" href="class_i_sender.html" title="ISender is a utility class which can be used to defer data from the realtime audio processing and sen...">ISender</a> is a utility class which can be used to defer data from the realtime audio processing and send it to the GUI for visualization. </p>

<p class="definition">Definition at line <a class="el" href="_i_sender_8h_source.html#l00065">65</a> of file <a class="el" href="_i_sender_8h_source.html">ISender.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a72921db73b016904ac9980940741c63e" name="a72921db73b016904ac9980940741c63e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72921db73b016904ac9980940741c63e">&#9670;&#160;</a></span>PrepareDataForUI()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int MAXNC = 1, int QUEUE_SIZE = 64, typename T  = float&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="class_i_sender.html">ISender</a>&lt; MAXNC, QUEUE_SIZE, T &gt;::PrepareDataForUI </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_i_sender_data.html">ISenderData</a>&lt; MAXNC, T &gt; &amp;&#160;</td>
          <td class="paramname"><em>d</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>This is called on the main thread and can be used to transform the data, e.g. </p>
<p >take an FFT. </p>

<p class="definition">Definition at line <a class="el" href="_i_sender_8h_source.html#l00077">77</a> of file <a class="el" href="_i_sender_8h_source.html">ISender.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="_i_sender_8h_source.html#l00081">ISender&lt; MAXNC, QUEUE_SIZE, T &gt;::TransmitData()</a>.</p>

</div>
</div>
<a id="a92a9c820f01facfff1cb4af02a35911f" name="a92a9c820f01facfff1cb4af02a35911f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92a9c820f01facfff1cb4af02a35911f">&#9670;&#160;</a></span>PushData()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int MAXNC = 1, int QUEUE_SIZE = 64, typename T  = float&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_i_sender.html">ISender</a>&lt; MAXNC, QUEUE_SIZE, T &gt;::PushData </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_i_sender_data.html">ISenderData</a>&lt; MAXNC, T &gt; &amp;&#160;</td>
          <td class="paramname"><em>d</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>Pushes a data element onto the queue. </p>
<p >This can be called on the realtime audio thread. </p>

<p class="definition">Definition at line <a class="el" href="_i_sender_8h_source.html#l00071">71</a> of file <a class="el" href="_i_sender_8h_source.html">ISender.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="_i_sender_8h_source.html#l00147">IPeakSender&lt; MAXNC, QUEUE_SIZE &gt;::ProcessBlock()</a>, <a class="el" href="_i_sender_8h_source.html#l00289">IPeakAvgSender&lt; MAXNC, QUEUE_SIZE &gt;::ProcessBlock()</a>, and <a class="el" href="_i_sender_8h_source.html#l00451">IBufferSender&lt; MAXNC, QUEUE_SIZE, MAXBUF &gt;::ProcessBlock()</a>.</p>

</div>
</div>
<a id="ad61c80e910d77b335ee04174949355e6" name="ad61c80e910d77b335ee04174949355e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad61c80e910d77b335ee04174949355e6">&#9670;&#160;</a></span>TransmitData()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int MAXNC = 1, int QUEUE_SIZE = 64, typename T  = float&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_i_sender.html">ISender</a>&lt; MAXNC, QUEUE_SIZE, T &gt;::TransmitData </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_i_editor_delegate.html">IEditorDelegate</a> &amp;&#160;</td>
          <td class="paramname"><em>dlg</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>Pops elements off the queue and sends messages to controls. </p>
<p >This must be called on the main thread - typically in MyPlugin::OnIdle() </p>

<p class="definition">Definition at line <a class="el" href="_i_sender_8h_source.html#l00081">81</a> of file <a class="el" href="_i_sender_8h_source.html">ISender.h</a>.</p>

<p class="reference">References <a class="el" href="_i_sender_8h_source.html#l00077">ISender&lt; MAXNC, QUEUE_SIZE, T &gt;::PrepareDataForUI()</a>, and <a class="el" href="_i_plug_editor_delegate_8h_source.html#l00192">IEditorDelegate::SendControlMsgFromDelegate()</a>.</p>

</div>
</div>
<a id="a969329ff6714cfa7ed8429702146f499" name="a969329ff6714cfa7ed8429702146f499"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a969329ff6714cfa7ed8429702146f499">&#9670;&#160;</a></span>TransmitDataToControlsWithTags()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int MAXNC = 1, int QUEUE_SIZE = 64, typename T  = float&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_i_sender.html">ISender</a>&lt; MAXNC, QUEUE_SIZE, T &gt;::TransmitDataToControlsWithTags </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_i_editor_delegate.html">IEditorDelegate</a> &amp;&#160;</td>
          <td class="paramname"><em>dlg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::initializer_list&lt; int &gt; &amp;&#160;</td>
          <td class="paramname"><em>ctrlTags</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>This variation can be used if you need to supply multiple controls with the same <a class="el" href="struct_i_sender_data.html" title="ISenderData is used to represent a typed data packet, that may contain values for multiple channels.">ISenderData</a>, overriding the tags in the data packet. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dlg</td><td>The editor delegate </td></tr>
    <tr><td class="paramname">ctrlTags</td><td>A list of control tags that should receive the updates from this sender </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="_i_sender_8h_source.html#l00096">96</a> of file <a class="el" href="_i_sender_8h_source.html">ISender.h</a>.</p>

<p class="reference">References <a class="el" href="_i_plug_editor_delegate_8h_source.html#l00192">IEditorDelegate::SendControlMsgFromDelegate()</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aed4e25d47ab3555cda2bc259e8aa1b1f" name="aed4e25d47ab3555cda2bc259e8aa1b1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed4e25d47ab3555cda2bc259e8aa1b1f">&#9670;&#160;</a></span>kUpdateMessage</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int MAXNC = 1, int QUEUE_SIZE = 64, typename T  = float&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr int <a class="el" href="class_i_sender.html">ISender</a>&lt; MAXNC, QUEUE_SIZE, T &gt;::kUpdateMessage = 0</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_i_sender_8h_source.html#l00068">68</a> of file <a class="el" href="_i_sender_8h_source.html">ISender.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_i_sender_8h_source.html">ISender.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>