Files
stk/doc/html/structSkini_1_1Message.html
2013-09-29 23:40:35 +02:00

185 lines
6.9 KiB
HTML

<HTML>
<HEAD>
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.4.4 -->
<div class="nav">
<a class="el" href="classSkini.html">Skini</a>::<a class="el" href="structSkini_1_1Message.html">Message</a></div>
<h1>Skini::Message Struct Reference</h1><!-- doxytag: class="Skini::Message" --><code>#include &lt;<a class="el" href="Skini_8h-source.html">Skini.h</a>&gt;</code>
<p>
<a href="structSkini_1_1Message-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
A message structure to store and pass parsed SKINI messages.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSkini_1_1Message.html#o0">type</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSkini_1_1Message.html#o1">channel</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSkini_1_1Message.html#o2">time</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; StkFloat &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSkini_1_1Message.html#o3">floatValues</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; long &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSkini_1_1Message.html#o4">intValues</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSkini_1_1Message.html#o5">remainder</a></td></tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="o0"></a><!-- doxytag: member="Skini::Message::type" ref="o0" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">long <a class="el" href="structSkini_1_1Message.html#o0">Skini::Message::type</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The message type, as defined in SKINI.msg. </td>
</tr>
</table>
<a class="anchor" name="o1"></a><!-- doxytag: member="Skini::Message::channel" ref="o1" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">long <a class="el" href="structSkini_1_1Message.html#o1">Skini::Message::channel</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The message channel (not limited to 16!). </td>
</tr>
</table>
<a class="anchor" name="o2"></a><!-- doxytag: member="Skini::Message::time" ref="o2" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">StkFloat <a class="el" href="structSkini_1_1Message.html#o2">Skini::Message::time</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The message time stamp in seconds (delta or absolute). </td>
</tr>
</table>
<a class="anchor" name="o3"></a><!-- doxytag: member="Skini::Message::floatValues" ref="o3" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">std::vector&lt;StkFloat&gt; <a class="el" href="structSkini_1_1Message.html#o3">Skini::Message::floatValues</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The message values read as floats (values are type-specific). </td>
</tr>
</table>
<a class="anchor" name="o4"></a><!-- doxytag: member="Skini::Message::intValues" ref="o4" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">std::vector&lt;long&gt; <a class="el" href="structSkini_1_1Message.html#o4">Skini::Message::intValues</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The message values read as ints (number and values are type-specific). </td>
</tr>
</table>
<a class="anchor" name="o5"></a><!-- doxytag: member="Skini::Message::remainder" ref="o5" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">std::string <a class="el" href="structSkini_1_1Message.html#o5">Skini::Message::remainder</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Any remaining message data, read as ascii text. </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="Skini_8h-source.html">Skini.h</a></ul>
<HR>
<table>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2005 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>