taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2015-03-12 19:03:15 +10:00
parent 083448f195
commit c6206e4216
493 changed files with 35310 additions and 3018 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
Melody_8cpp_source.html
View File

@@ -3,6 +3,7 @@
<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.6"/>
<title>ArduinoLibs: Melody.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@@ -29,7 +30,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
@@ -116,7 +117,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#include &lt;WProgram.h&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="code" href="classMelody.html#a9edc4165a49368dd5d78eedf982c38b9"> 85</a></span>&#160;<a class="code" href="classMelody.html#a9edc4165a49368dd5d78eedf982c38b9" title="Constructs a new melody playing object for pin.">Melody::Melody</a>(uint8_t pin)</div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classMelody.html#a9edc4165a49368dd5d78eedf982c38b9"> 85</a></span>&#160;<a class="code" href="classMelody.html#a9edc4165a49368dd5d78eedf982c38b9">Melody::Melody</a>(uint8_t pin)</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; : _pin(pin)</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; , playing(false)</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; , _loopCount(0)</div>
@@ -130,7 +131,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;{</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;}</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div>
<div class="line"><a name="l00131"></a><span class="lineno"><a class="code" href="classMelody.html#ae88ad06c2acb728f56dd213d5dad6006"> 131</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classMelody.html#ae88ad06c2acb728f56dd213d5dad6006" title="Sets the maximum number of loops to last no longer than ms milliseconds.">Melody::setLoopDuration</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> ms)</div>
<div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="classMelody.html#ae88ad06c2acb728f56dd213d5dad6006"> 131</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classMelody.html#ae88ad06c2acb728f56dd213d5dad6006">Melody::setLoopDuration</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> ms)</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;{</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> duration = 0;</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index = 0; index &lt; size; ++index)</div>
@@ -140,9 +141,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; _loopCount = 1; <span class="comment">// Play the melody at least once.</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;}</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;</div>
<div class="line"><a name="l00146"></a><span class="lineno"><a class="code" href="classMelody.html#a9fd8e0d48833d8da3cd3b3b58408b0b5"> 146</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classMelody.html#a9fd8e0d48833d8da3cd3b3b58408b0b5" title="Starts playing the melody, or restarts it if already playing.">Melody::play</a>()</div>
<div class="line"><a name="l00146"></a><span class="lineno"><a class="line" href="classMelody.html#a9fd8e0d48833d8da3cd3b3b58408b0b5"> 146</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classMelody.html#a9fd8e0d48833d8da3cd3b3b58408b0b5">Melody::play</a>()</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;{</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">stop</a>();</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b">stop</a>();</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="keywordflow">if</span> (size == 0)</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="keywordflow">return</span>; <span class="comment">// No melody to play.</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; loopsLeft = _loopCount;</div>
@@ -151,9 +152,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; nextNote();</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;}</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;</div>
<div class="line"><a name="l00162"></a><span class="lineno"><a class="code" href="classMelody.html#aecc9185c9cb1246e8a55521b17d72932"> 162</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classMelody.html#aecc9185c9cb1246e8a55521b17d72932" title="Plays the melody once and then stops.">Melody::playOnce</a>()</div>
<div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="classMelody.html#aecc9185c9cb1246e8a55521b17d72932"> 162</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classMelody.html#aecc9185c9cb1246e8a55521b17d72932">Melody::playOnce</a>()</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;{</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">stop</a>();</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b">stop</a>();</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <span class="keywordflow">if</span> (size == 0)</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="keywordflow">return</span>; <span class="comment">// No melody to play.</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; loopsLeft = 1;</div>
@@ -162,7 +163,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; nextNote();</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;}</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;</div>
<div class="line"><a name="l00178"></a><span class="lineno"><a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b"> 178</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">Melody::stop</a>()</div>
<div class="line"><a name="l00178"></a><span class="lineno"><a class="line" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b"> 178</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b">Melody::stop</a>()</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;{</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; <span class="keywordflow">if</span> (!playing)</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; <span class="keywordflow">return</span>;</div>
@@ -170,15 +171,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; noTone(_pin);</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;}</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;</div>
<div class="line"><a name="l00199"></a><span class="lineno"><a class="code" href="classMelody.html#adb6ad8e8cfe8c9a137e470f4e85c7254"> 199</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classMelody.html#adb6ad8e8cfe8c9a137e470f4e85c7254" title="Sets the melody to the size elements of notes and lengths.">Melody::setMelody</a>(<span class="keyword">const</span> <span class="keywordtype">int</span> *notes, <span class="keyword">const</span> uint8_t *lengths, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size)</div>
<div class="line"><a name="l00199"></a><span class="lineno"><a class="line" href="classMelody.html#adb6ad8e8cfe8c9a137e470f4e85c7254"> 199</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classMelody.html#adb6ad8e8cfe8c9a137e470f4e85c7254">Melody::setMelody</a>(<span class="keyword">const</span> <span class="keywordtype">int</span> *notes, <span class="keyword">const</span> uint8_t *lengths, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size)</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;{</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">stop</a>();</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b">stop</a>();</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; this-&gt;notes = notes;</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; this-&gt;lengths = lengths;</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; this-&gt;size = size;</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;}</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;</div>
<div class="line"><a name="l00214"></a><span class="lineno"><a class="code" href="classMelody.html#ad1103b970be1f59058cc7d927be68955"> 214</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classMelody.html#ad1103b970be1f59058cc7d927be68955" title="Runs the melody control loop.">Melody::run</a>()</div>
<div class="line"><a name="l00214"></a><span class="lineno"><a class="line" href="classMelody.html#ad1103b970be1f59058cc7d927be68955"> 214</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classMelody.html#ad1103b970be1f59058cc7d927be68955">Melody::run</a>()</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160;{</div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; <span class="keywordflow">if</span> (!playing)</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; <span class="keywordflow">return</span>;</div>
@@ -192,7 +193,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160;{</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160; <span class="keywordflow">if</span> (posn &gt;= size) {</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; <span class="keywordflow">if</span> (loopsLeft != 0 &amp;&amp; --loopsLeft &lt;= 0) {</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b" title="Stops playing the melody.">stop</a>();</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; <a class="code" href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b">stop</a>();</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; }</div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; posn = 0;</div>
@@ -204,12 +205,19 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; duration = duration * 13 / 10; <span class="comment">// i.e., duration * 1.3</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160; startNote = millis();</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160;}</div>
<div class="ttc" id="classMelody_html_adb6ad8e8cfe8c9a137e470f4e85c7254"><div class="ttname"><a href="classMelody.html#adb6ad8e8cfe8c9a137e470f4e85c7254">Melody::setMelody</a></div><div class="ttdeci">void setMelody(const int *notes, const uint8_t *lengths, unsigned int size)</div><div class="ttdoc">Sets the melody to the size elements of notes and lengths. </div><div class="ttdef"><b>Definition:</b> <a href="Melody_8cpp_source.html#l00199">Melody.cpp:199</a></div></div>
<div class="ttc" id="classMelody_html_ac0c552233c41d85f2766d2e4df376b2b"><div class="ttname"><a href="classMelody.html#ac0c552233c41d85f2766d2e4df376b2b">Melody::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Stops playing the melody. </div><div class="ttdef"><b>Definition:</b> <a href="Melody_8cpp_source.html#l00178">Melody.cpp:178</a></div></div>
<div class="ttc" id="classMelody_html_ad1103b970be1f59058cc7d927be68955"><div class="ttname"><a href="classMelody.html#ad1103b970be1f59058cc7d927be68955">Melody::run</a></div><div class="ttdeci">void run()</div><div class="ttdoc">Runs the melody control loop. </div><div class="ttdef"><b>Definition:</b> <a href="Melody_8cpp_source.html#l00214">Melody.cpp:214</a></div></div>
<div class="ttc" id="classMelody_html_aecc9185c9cb1246e8a55521b17d72932"><div class="ttname"><a href="classMelody.html#aecc9185c9cb1246e8a55521b17d72932">Melody::playOnce</a></div><div class="ttdeci">void playOnce()</div><div class="ttdoc">Plays the melody once and then stops. </div><div class="ttdef"><b>Definition:</b> <a href="Melody_8cpp_source.html#l00162">Melody.cpp:162</a></div></div>
<div class="ttc" id="classMelody_html_a9edc4165a49368dd5d78eedf982c38b9"><div class="ttname"><a href="classMelody.html#a9edc4165a49368dd5d78eedf982c38b9">Melody::Melody</a></div><div class="ttdeci">Melody(uint8_t pin)</div><div class="ttdoc">Constructs a new melody playing object for pin. </div><div class="ttdef"><b>Definition:</b> <a href="Melody_8cpp_source.html#l00085">Melody.cpp:85</a></div></div>
<div class="ttc" id="classMelody_html_ae88ad06c2acb728f56dd213d5dad6006"><div class="ttname"><a href="classMelody.html#ae88ad06c2acb728f56dd213d5dad6006">Melody::setLoopDuration</a></div><div class="ttdeci">void setLoopDuration(unsigned long ms)</div><div class="ttdoc">Sets the maximum number of loops to last no longer than ms milliseconds. </div><div class="ttdef"><b>Definition:</b> <a href="Melody_8cpp_source.html#l00131">Melody.cpp:131</a></div></div>
<div class="ttc" id="classMelody_html_a9fd8e0d48833d8da3cd3b3b58408b0b5"><div class="ttname"><a href="classMelody.html#a9fd8e0d48833d8da3cd3b3b58408b0b5">Melody::play</a></div><div class="ttdeci">void play()</div><div class="ttdoc">Starts playing the melody, or restarts it if already playing. </div><div class="ttdef"><b>Definition:</b> <a href="Melody_8cpp_source.html#l00146">Melody.cpp:146</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 29 2013 09:30:46 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Mar 12 2015 19:02:05 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</a> 1.8.6
</small></address>
</body>
</html>