143 lines
18 KiB
HTML
143 lines
18 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.11"/>
|
|
<title>Arduino MIDI Library: /Users/franky/dev/git/arduino_midi_library/src/midi_Message.h Source File</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
|
|
 <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 Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><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="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File 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('a00028_source.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="headertitle">
|
|
<div class="title">midi_Message.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="a00028.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="a00029.html">midi_Namespace.h</a>"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="a00027.html">midi_Defs.h</a>"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <a class="code" href="a00029.html#adf6b690441eb0a31c4abd3bc4fb99673">BEGIN_MIDI_NAMESPACE</a></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">template</span><<span class="keywordtype">unsigned</span> SysExMaxSize></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="a00016.html"> 40</a></span> <span class="keyword">struct </span><a class="code" href="a00016.html">Message</a></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> {</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="a00016.html#a539ee7ccd80e06cb2fa45b1f47569837"> 45</a></span>  <span class="keyword">inline</span> <a class="code" href="a00016.html#a539ee7ccd80e06cb2fa45b1f47569837">Message</a>()</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  : <a class="code" href="a00016.html#a3e088d88b4c2c84efd78f080a6ba3384">channel</a>(0)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  , <a class="code" href="a00016.html#abfe2249141ed2a0b529f35343affb0e0">type</a>(midi::<a class="code" href="a00027.html#af8bb3cf501a6b530be54ef36864af943a791c6b5c1e5f30ce6c7b0937e93adbbb">InvalidType</a>)</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  , <a class="code" href="a00016.html#a92150532e5720f95013e16a2f49a8df8">data1</a>(0)</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  , <a class="code" href="a00016.html#af6ca8f3ba3f77fe769a259de3b88c36c">data2</a>(0)</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  , <a class="code" href="a00016.html#a715befa071b78dc19c48c4871bd5f293">valid</a>(false)</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  memset(<a class="code" href="a00016.html#a4f63b5d7cc89e5f96c8fed1367832c2b">sysexArray</a>, 0, <a class="code" href="a00016.html#a06ebe9aea7bf76c87564cc4b6c74f901">sSysExMaxSize</a> * <span class="keyword">sizeof</span>(<a class="code" href="a00027.html#a7c1eccfe3d7d44de8ee9138d5378cd91">DataByte</a>));</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="a00016.html#a06ebe9aea7bf76c87564cc4b6c74f901"> 57</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <a class="code" href="a00016.html#a06ebe9aea7bf76c87564cc4b6c74f901">sSysExMaxSize</a> = SysExMaxSize;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="a00016.html#a3e088d88b4c2c84efd78f080a6ba3384"> 62</a></span>  <a class="code" href="a00027.html#af0fba1bdf23d6f77614ea9697290325d">Channel</a> <a class="code" href="a00016.html#a3e088d88b4c2c84efd78f080a6ba3384">channel</a>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="a00016.html#abfe2249141ed2a0b529f35343affb0e0"> 67</a></span>  <a class="code" href="a00027.html#af8bb3cf501a6b530be54ef36864af943">MidiType</a> <a class="code" href="a00016.html#abfe2249141ed2a0b529f35343affb0e0">type</a>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="a00016.html#a92150532e5720f95013e16a2f49a8df8"> 72</a></span>  <a class="code" href="a00027.html#a7c1eccfe3d7d44de8ee9138d5378cd91">DataByte</a> <a class="code" href="a00016.html#a92150532e5720f95013e16a2f49a8df8">data1</a>;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="a00016.html#af6ca8f3ba3f77fe769a259de3b88c36c"> 78</a></span>  <a class="code" href="a00027.html#a7c1eccfe3d7d44de8ee9138d5378cd91">DataByte</a> <a class="code" href="a00016.html#af6ca8f3ba3f77fe769a259de3b88c36c">data2</a>;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="a00016.html#a4f63b5d7cc89e5f96c8fed1367832c2b"> 84</a></span>  <a class="code" href="a00027.html#a7c1eccfe3d7d44de8ee9138d5378cd91">DataByte</a> <a class="code" href="a00016.html#a4f63b5d7cc89e5f96c8fed1367832c2b">sysexArray</a>[<a class="code" href="a00016.html#a06ebe9aea7bf76c87564cc4b6c74f901">sSysExMaxSize</a>];</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="a00016.html#a715befa071b78dc19c48c4871bd5f293"> 90</a></span>  <span class="keywordtype">bool</span> <a class="code" href="a00016.html#a715befa071b78dc19c48c4871bd5f293">valid</a>;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="a00016.html#a6c72b14a27625012b1215c518fd4576e"> 92</a></span>  <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <a class="code" href="a00016.html#a6c72b14a27625012b1215c518fd4576e">getSysExSize</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> size = unsigned(data2) << 8 | <a class="code" href="a00016.html#a92150532e5720f95013e16a2f49a8df8">data1</a>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">return</span> size > sSysExMaxSize ? sSysExMaxSize : size;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> };</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <a class="code" href="a00029.html#abf831eff386c2ded4d253fb11321028e">END_MIDI_NAMESPACE</a></div><div class="ttc" id="a00029_html_abf831eff386c2ded4d253fb11321028e"><div class="ttname"><a href="a00029.html#abf831eff386c2ded4d253fb11321028e">END_MIDI_NAMESPACE</a></div><div class="ttdeci">#define END_MIDI_NAMESPACE</div><div class="ttdef"><b>Definition:</b> <a href="a00029_source.html#l00033">midi_Namespace.h:33</a></div></div>
|
|
<div class="ttc" id="a00027_html"><div class="ttname"><a href="a00027.html">midi_Defs.h</a></div><div class="ttdoc">MIDI Library for the Arduino - Definitions. </div></div>
|
|
<div class="ttc" id="a00029_html_adf6b690441eb0a31c4abd3bc4fb99673"><div class="ttname"><a href="a00029.html#adf6b690441eb0a31c4abd3bc4fb99673">BEGIN_MIDI_NAMESPACE</a></div><div class="ttdeci">#define BEGIN_MIDI_NAMESPACE</div><div class="ttdef"><b>Definition:</b> <a href="a00029_source.html#l00032">midi_Namespace.h:32</a></div></div>
|
|
<div class="ttc" id="a00016_html_a715befa071b78dc19c48c4871bd5f293"><div class="ttname"><a href="a00016.html#a715befa071b78dc19c48c4871bd5f293">Message::valid</a></div><div class="ttdeci">bool valid</div><div class="ttdef"><b>Definition:</b> <a href="a00028_source.html#l00090">midi_Message.h:90</a></div></div>
|
|
<div class="ttc" id="a00027_html_af8bb3cf501a6b530be54ef36864af943"><div class="ttname"><a href="a00027.html#af8bb3cf501a6b530be54ef36864af943">MidiType</a></div><div class="ttdeci">MidiType</div><div class="ttdef"><b>Definition:</b> <a href="a00027_source.html#l00066">midi_Defs.h:66</a></div></div>
|
|
<div class="ttc" id="a00016_html_a4f63b5d7cc89e5f96c8fed1367832c2b"><div class="ttname"><a href="a00016.html#a4f63b5d7cc89e5f96c8fed1367832c2b">Message::sysexArray</a></div><div class="ttdeci">DataByte sysexArray[sSysExMaxSize]</div><div class="ttdef"><b>Definition:</b> <a href="a00028_source.html#l00084">midi_Message.h:84</a></div></div>
|
|
<div class="ttc" id="a00016_html_a3e088d88b4c2c84efd78f080a6ba3384"><div class="ttname"><a href="a00016.html#a3e088d88b4c2c84efd78f080a6ba3384">Message::channel</a></div><div class="ttdeci">Channel channel</div><div class="ttdef"><b>Definition:</b> <a href="a00028_source.html#l00062">midi_Message.h:62</a></div></div>
|
|
<div class="ttc" id="a00016_html_af6ca8f3ba3f77fe769a259de3b88c36c"><div class="ttname"><a href="a00016.html#af6ca8f3ba3f77fe769a259de3b88c36c">Message::data2</a></div><div class="ttdeci">DataByte data2</div><div class="ttdef"><b>Definition:</b> <a href="a00028_source.html#l00078">midi_Message.h:78</a></div></div>
|
|
<div class="ttc" id="a00016_html_abfe2249141ed2a0b529f35343affb0e0"><div class="ttname"><a href="a00016.html#abfe2249141ed2a0b529f35343affb0e0">Message::type</a></div><div class="ttdeci">MidiType type</div><div class="ttdef"><b>Definition:</b> <a href="a00028_source.html#l00067">midi_Message.h:67</a></div></div>
|
|
<div class="ttc" id="a00029_html"><div class="ttname"><a href="a00029.html">midi_Namespace.h</a></div><div class="ttdoc">MIDI Library for the Arduino - Namespace declaration. </div></div>
|
|
<div class="ttc" id="a00016_html_a92150532e5720f95013e16a2f49a8df8"><div class="ttname"><a href="a00016.html#a92150532e5720f95013e16a2f49a8df8">Message::data1</a></div><div class="ttdeci">DataByte data1</div><div class="ttdef"><b>Definition:</b> <a href="a00028_source.html#l00072">midi_Message.h:72</a></div></div>
|
|
<div class="ttc" id="a00027_html_af8bb3cf501a6b530be54ef36864af943a791c6b5c1e5f30ce6c7b0937e93adbbb"><div class="ttname"><a href="a00027.html#af8bb3cf501a6b530be54ef36864af943a791c6b5c1e5f30ce6c7b0937e93adbbb">InvalidType</a></div><div class="ttdoc">For notifying errors. </div><div class="ttdef"><b>Definition:</b> <a href="a00027_source.html#l00068">midi_Defs.h:68</a></div></div>
|
|
<div class="ttc" id="a00016_html_a539ee7ccd80e06cb2fa45b1f47569837"><div class="ttname"><a href="a00016.html#a539ee7ccd80e06cb2fa45b1f47569837">Message::Message</a></div><div class="ttdeci">Message()</div><div class="ttdef"><b>Definition:</b> <a href="a00028_source.html#l00045">midi_Message.h:45</a></div></div>
|
|
<div class="ttc" id="a00016_html_a6c72b14a27625012b1215c518fd4576e"><div class="ttname"><a href="a00016.html#a6c72b14a27625012b1215c518fd4576e">Message::getSysExSize</a></div><div class="ttdeci">unsigned getSysExSize() const </div><div class="ttdef"><b>Definition:</b> <a href="a00028_source.html#l00092">midi_Message.h:92</a></div></div>
|
|
<div class="ttc" id="a00027_html_af0fba1bdf23d6f77614ea9697290325d"><div class="ttname"><a href="a00027.html#af0fba1bdf23d6f77614ea9697290325d">Channel</a></div><div class="ttdeci">byte Channel</div><div class="ttdef"><b>Definition:</b> <a href="a00027_source.html#l00060">midi_Defs.h:60</a></div></div>
|
|
<div class="ttc" id="a00016_html_a06ebe9aea7bf76c87564cc4b6c74f901"><div class="ttname"><a href="a00016.html#a06ebe9aea7bf76c87564cc4b6c74f901">Message::sSysExMaxSize</a></div><div class="ttdeci">static const unsigned sSysExMaxSize</div><div class="ttdef"><b>Definition:</b> <a href="a00028_source.html#l00057">midi_Message.h:57</a></div></div>
|
|
<div class="ttc" id="a00016_html"><div class="ttname"><a href="a00016.html">Message</a></div><div class="ttdef"><b>Definition:</b> <a href="a00028_source.html#l00040">midi_Message.h:40</a></div></div>
|
|
<div class="ttc" id="a00027_html_a7c1eccfe3d7d44de8ee9138d5378cd91"><div class="ttname"><a href="a00027.html#a7c1eccfe3d7d44de8ee9138d5378cd91">DataByte</a></div><div class="ttdeci">byte DataByte</div><div class="ttdef"><b>Definition:</b> <a href="a00027_source.html#l00059">midi_Defs.h:59</a></div></div>
|
|
</div><!-- fragment --></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="dir_645b81139e363ce037e25dbaed8c5263.html">franky</a></li><li class="navelem"><a class="el" href="dir_24ed65e94774636179756562244c7302.html">dev</a></li><li class="navelem"><a class="el" href="dir_8e174b5f2a67f3e976f171aae2086cba.html">git</a></li><li class="navelem"><a class="el" href="dir_09481f2e998cf47f01eea124dd549c96.html">arduino_midi_library</a></li><li class="navelem"><a class="el" href="dir_4f69b3b5f50f765bf848b47dadc3c85f.html">src</a></li><li class="navelem"><a class="el" href="a00028.html">midi_Message.h</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>
|