Seich
/
arduino_midi_library
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
arduino_midi_library/a00022.html

327 lines
18 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.11"/>
<title>Arduino MIDI Library: UsbTransport&lt; BuffersSize &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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Arduino MIDI Library
&#160;<span id="projectnumber">Version 4.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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="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><a href="examples.html"><span>Examples</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="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('a00022.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="a00049.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">UsbTransport&lt; BuffersSize &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="a00034_source.html">midi_UsbTransport.h</a>&gt;</code></p>
<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:acb8ca31730e8ea4e9058b17b2f41202b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#acb8ca31730e8ea4e9058b17b2f41202b">UsbTransport</a> ()</td></tr>
<tr class="separator:acb8ca31730e8ea4e9058b17b2f41202b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab74990a39fc08cbe523e6b42a11bbe35"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#ab74990a39fc08cbe523e6b42a11bbe35">~UsbTransport</a> ()</td></tr>
<tr class="separator:ab74990a39fc08cbe523e6b42a11bbe35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc6e724fdcc96fb83af0285c5e583741"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#afc6e724fdcc96fb83af0285c5e583741">begin</a> (unsigned inBaudrate)</td></tr>
<tr class="separator:afc6e724fdcc96fb83af0285c5e583741"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad850ea7fa2dfe63ea199bb841c535402"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#ad850ea7fa2dfe63ea199bb841c535402">available</a> ()</td></tr>
<tr class="separator:ad850ea7fa2dfe63ea199bb841c535402"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e2a189763c0075a18761a438f385b05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00027.html#ab8ef12fab634c171394422d0ee8baf94">byte</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#a3e2a189763c0075a18761a438f385b05">read</a> ()</td></tr>
<tr class="separator:a3e2a189763c0075a18761a438f385b05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedfc3deea0759ec00c4baf0dced87672"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#aedfc3deea0759ec00c4baf0dced87672">write</a> (<a class="el" href="a00027.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> inData)</td></tr>
<tr class="separator:aedfc3deea0759ec00c4baf0dced87672"><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;unsigned BuffersSize&gt;<br />
class UsbTransport&lt; BuffersSize &gt;</h3>
<p>Definition at line <a class="el" href="a00034_source.html#l00038">38</a> of file <a class="el" href="a00034_source.html">midi_UsbTransport.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="acb8ca31730e8ea4e9058b17b2f41202b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;unsigned BufferSize&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00029.html#adf6b690441eb0a31c4abd3bc4fb99673">BEGIN_MIDI_NAMESPACE</a> <a class="el" href="a00022.html">UsbTransport</a>&lt; BufferSize &gt;::<a class="el" href="a00022.html">UsbTransport</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>Definition at line <a class="el" href="a00035_source.html#l00034">34</a> of file <a class="el" href="a00035_source.html">midi_UsbTransport.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;{</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ab74990a39fc08cbe523e6b42a11bbe35"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;unsigned BufferSize&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00022.html">UsbTransport</a>&lt; BufferSize &gt;::~<a class="el" href="a00022.html">UsbTransport</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>Definition at line <a class="el" href="a00035_source.html#l00040">40</a> of file <a class="el" href="a00035_source.html">midi_UsbTransport.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;{</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad850ea7fa2dfe63ea199bb841c535402"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;unsigned BufferSize&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned <a class="el" href="a00022.html">UsbTransport</a>&lt; BufferSize &gt;::available </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>Definition at line <a class="el" href="a00035_source.html#l00055">55</a> of file <a class="el" href="a00035_source.html">midi_UsbTransport.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;{</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; pollUsbMidi();</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">return</span> mRxBuffer.<a class="code" href="a00018.html#a0b1b3ca5f78a359c282dd4c80f14e70e">getLength</a>();</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;}</div><div class="ttc" id="a00018_html_a0b1b3ca5f78a359c282dd4c80f14e70e"><div class="ttname"><a href="a00018.html#a0b1b3ca5f78a359c282dd4c80f14e70e">RingBuffer::getLength</a></div><div class="ttdeci">int getLength() const </div><div class="ttdef"><b>Definition:</b> <a href="a00031_source.html#l00049">midi_RingBuffer.hpp:49</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="afc6e724fdcc96fb83af0285c5e583741"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;unsigned BufferSize&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00022.html">UsbTransport</a>&lt; BufferSize &gt;::begin </td>
<td>(</td>
<td class="paramtype">unsigned&#160;</td>
<td class="paramname"><em>inBaudrate</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>Definition at line <a class="el" href="a00035_source.html#l00048">48</a> of file <a class="el" href="a00035_source.html">midi_UsbTransport.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;{</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; mTxBuffer.<a class="code" href="a00018.html#a88d68cb12b382c21d35fd419d0feed1b">clear</a>();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; mRxBuffer.<a class="code" href="a00018.html#a88d68cb12b382c21d35fd419d0feed1b">clear</a>();</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;}</div><div class="ttc" id="a00018_html_a88d68cb12b382c21d35fd419d0feed1b"><div class="ttname"><a href="a00018.html#a88d68cb12b382c21d35fd419d0feed1b">RingBuffer::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdef"><b>Definition:</b> <a href="a00031_source.html#l00093">midi_RingBuffer.hpp:93</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="a3e2a189763c0075a18761a438f385b05"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;unsigned BufferSize&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00027.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> <a class="el" href="a00022.html">UsbTransport</a>&lt; BufferSize &gt;::read </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>Definition at line <a class="el" href="a00035_source.html#l00062">62</a> of file <a class="el" href="a00035_source.html">midi_UsbTransport.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;{</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordflow">return</span> mRxBuffer.<a class="code" href="a00018.html#a9f6ccc4d0e05b60f223c8b7a8b88c76d">read</a>();</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;}</div><div class="ttc" id="a00018_html_a9f6ccc4d0e05b60f223c8b7a8b88c76d"><div class="ttname"><a href="a00018.html#a9f6ccc4d0e05b60f223c8b7a8b88c76d">RingBuffer::read</a></div><div class="ttdeci">DataType read()</div><div class="ttdef"><b>Definition:</b> <a href="a00031_source.html#l00103">midi_RingBuffer.hpp:103</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="aedfc3deea0759ec00c4baf0dced87672"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;unsigned BufferSize&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00022.html">UsbTransport</a>&lt; BufferSize &gt;::write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00027.html#ab8ef12fab634c171394422d0ee8baf94">byte</a>&#160;</td>
<td class="paramname"><em>inData</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>Definition at line <a class="el" href="a00035_source.html#l00068">68</a> of file <a class="el" href="a00035_source.html">midi_UsbTransport.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;{</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; mTxBuffer.<a class="code" href="a00018.html#a1de8ffd41505b8d915f4c850d7c76b6f">write</a>(inData);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; recomposeAndSendTxPackets();</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;}</div><div class="ttc" id="a00018_html_a1de8ffd41505b8d915f4c850d7c76b6f"><div class="ttname"><a href="a00018.html#a1de8ffd41505b8d915f4c850d7c76b6f">RingBuffer::write</a></div><div class="ttdeci">void write(DataType inData)</div><div class="ttdef"><b>Definition:</b> <a href="a00031_source.html#l00074">midi_RingBuffer.hpp:74</a></div></div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/Users/franky/dev/git/arduino_midi_library/src/<a class="el" href="a00034_source.html">midi_UsbTransport.h</a></li>
<li>/Users/franky/dev/git/arduino_midi_library/src/<a class="el" href="a00035_source.html">midi_UsbTransport.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="a00022.html">UsbTransport</a></li>
<li class="footer">Generated on Wed Nov 2 2016 19:56:40 for Arduino MIDI Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink