class_i_oscillator.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: IOscillator&lt; 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="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_i_oscillator-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">IOscillator&lt; T &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for IOscillator&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="class_i_oscillator__inherit__graph.svg" width="418" height="110"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</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:a683f44c0a0266bfa63d5d98aea382a31"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_oscillator.html#a683f44c0a0266bfa63d5d98aea382a31">IOscillator</a> (double startPhase=0., double startFreq=1.)</td></tr>
<tr class="separator:a683f44c0a0266bfa63d5d98aea382a31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6ceae343febf3b354beb401de2df639"><td class="memItemLeft" align="right" valign="top">virtual T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_oscillator.html#ac6ceae343febf3b354beb401de2df639">Process</a> (double freqHz)=0</td></tr>
<tr class="separator:ac6ceae343febf3b354beb401de2df639"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7c87fe27f853cce6ef5aa0c16cb897e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_oscillator.html#aa7c87fe27f853cce6ef5aa0c16cb897e">SetFreqCPS</a> (double freqHz)</td></tr>
<tr class="separator:aa7c87fe27f853cce6ef5aa0c16cb897e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a914b0c6ec52b3a970320925f33598d30"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_oscillator.html#a914b0c6ec52b3a970320925f33598d30">SetSampleRate</a> (double sampleRate)</td></tr>
<tr class="separator:a914b0c6ec52b3a970320925f33598d30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94da81880742026be748543cbed2cda2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_oscillator.html#a94da81880742026be748543cbed2cda2">Reset</a> ()</td></tr>
<tr class="separator:a94da81880742026be748543cbed2cda2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5260496ffd4842d4e8d6b1e6469d3559"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_oscillator.html#a5260496ffd4842d4e8d6b1e6469d3559">SetPhase</a> (double phase)</td></tr>
<tr class="separator:a5260496ffd4842d4e8d6b1e6469d3559"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ae6856794d0ffa655471f8b009ef0e5aa"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_oscillator.html#ae6856794d0ffa655471f8b009ef0e5aa">mPhase</a> = 0.</td></tr>
<tr class="separator:ae6856794d0ffa655471f8b009ef0e5aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afddff474168853ec85ca7d407ecabefe"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_oscillator.html#afddff474168853ec85ca7d407ecabefe">mPhaseIncr</a> = 0.</td></tr>
<tr class="separator:afddff474168853ec85ca7d407ecabefe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a800171ba8d90d9dfafd4ae1f88544b87"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_oscillator.html#a800171ba8d90d9dfafd4ae1f88544b87">mSampleRate</a> = 44100.</td></tr>
<tr class="separator:a800171ba8d90d9dfafd4ae1f88544b87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9e2568b1bb93c7960cfdd8fe4b6a0b2"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_oscillator.html#aa9e2568b1bb93c7960cfdd8fe4b6a0b2">mStartPhase</a></td></tr>
<tr class="separator:aa9e2568b1bb93c7960cfdd8fe4b6a0b2"><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;typename T&gt;<br />
class IOscillator&lt; T &gt;</div>
<p class="definition">Definition at line <a class="el" href="_oscillator_8h_source.html#l00018">18</a> of file <a class="el" href="_oscillator_8h_source.html">Oscillator.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a683f44c0a0266bfa63d5d98aea382a31" name="a683f44c0a0266bfa63d5d98aea382a31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a683f44c0a0266bfa63d5d98aea382a31">&#9670;&#160;</a></span>IOscillator()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_i_oscillator.html">IOscillator</a>&lt; T &gt;<a class="el" href="class_i_oscillator.html">::IOscillator</a> </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>startPhase</em> = <code>0.</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>startFreq</em> = <code>1.</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">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_oscillator_8h_source.html#l00021">21</a> of file <a class="el" href="_oscillator_8h_source.html">Oscillator.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac6ceae343febf3b354beb401de2df639" name="ac6ceae343febf3b354beb401de2df639"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6ceae343febf3b354beb401de2df639">&#9670;&#160;</a></span>Process()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual T <a class="el" href="class_i_oscillator.html">IOscillator</a>&lt; T &gt;::Process </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>freqHz</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="class_l_f_o.html#af5ae4163da421c1aa8b5ff0c7551b6ff">LFO&lt; T &gt;</a>.</p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_i_oscillator.html">IOscillator</a>&lt; T &gt;::Reset </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 class="definition">Definition at line <a class="el" href="_oscillator_8h_source.html#l00039">39</a> of file <a class="el" href="_oscillator_8h_source.html">Oscillator.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_i_oscillator.html">IOscillator</a>&lt; T &gt;::SetFreqCPS </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>freqHz</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 class="definition">Definition at line <a class="el" href="_oscillator_8h_source.html#l00029">29</a> of file <a class="el" href="_oscillator_8h_source.html">Oscillator.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_i_oscillator.html">IOscillator</a>&lt; T &gt;::SetPhase </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>phase</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 class="definition">Definition at line <a class="el" href="_oscillator_8h_source.html#l00044">44</a> of file <a class="el" href="_oscillator_8h_source.html">Oscillator.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_i_oscillator.html">IOscillator</a>&lt; T &gt;::SetSampleRate </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>sampleRate</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 class="definition">Definition at line <a class="el" href="_oscillator_8h_source.html#l00034">34</a> of file <a class="el" href="_oscillator_8h_source.html">Oscillator.h</a>.</p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="class_i_oscillator.html">IOscillator</a>&lt; T &gt;::mPhase = 0.</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 class="definition">Definition at line <a class="el" href="_oscillator_8h_source.html#l00050">50</a> of file <a class="el" href="_oscillator_8h_source.html">Oscillator.h</a>.</p>

</div>
</div>
<a id="afddff474168853ec85ca7d407ecabefe" name="afddff474168853ec85ca7d407ecabefe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afddff474168853ec85ca7d407ecabefe">&#9670;&#160;</a></span>mPhaseIncr</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="class_i_oscillator.html">IOscillator</a>&lt; T &gt;::mPhaseIncr = 0.</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 class="definition">Definition at line <a class="el" href="_oscillator_8h_source.html#l00051">51</a> of file <a class="el" href="_oscillator_8h_source.html">Oscillator.h</a>.</p>

</div>
</div>
<a id="a800171ba8d90d9dfafd4ae1f88544b87" name="a800171ba8d90d9dfafd4ae1f88544b87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a800171ba8d90d9dfafd4ae1f88544b87">&#9670;&#160;</a></span>mSampleRate</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="class_i_oscillator.html">IOscillator</a>&lt; T &gt;::mSampleRate = 44100.</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 class="definition">Definition at line <a class="el" href="_oscillator_8h_source.html#l00052">52</a> of file <a class="el" href="_oscillator_8h_source.html">Oscillator.h</a>.</p>

</div>
</div>
<a id="aa9e2568b1bb93c7960cfdd8fe4b6a0b2" name="aa9e2568b1bb93c7960cfdd8fe4b6a0b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9e2568b1bb93c7960cfdd8fe4b6a0b2">&#9670;&#160;</a></span>mStartPhase</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="class_i_oscillator.html">IOscillator</a>&lt; T &gt;::mStartPhase</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 class="definition">Definition at line <a class="el" href="_oscillator_8h_source.html#l00053">53</a> of file <a class="el" href="_oscillator_8h_source.html">Oscillator.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_oscillator_8h_source.html">Oscillator.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>