Files
stk/doc/html/structstk_1_1Skini_1_1Message.html
2013-09-29 23:48:48 +02:00

131 lines
6.7 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="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Skini.html">Skini</a>::<a class="el" href="structstk_1_1Skini_1_1Message.html">Message</a>
</div>
<div class="contents">
<h1>stk::Skini::Message Struct Reference</h1><!-- doxytag: class="stk::Skini::Message" -->
<p>A message structure to store and pass parsed SKINI messages.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Skini_8h_source.html">Skini.h</a>&gt;</code></p>
<p><a href="structstk_1_1Skini_1_1Message-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structstk_1_1Skini_1_1Message.html#a6f55441cfdbc674c992fd98f95d458ca">type</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structstk_1_1Skini_1_1Message.html#ac5d1504e617c2227055799300fc1936e">channel</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structstk_1_1Skini_1_1Message.html#a6d07933c0cf4c92e76677236c2341e2f">time</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::vector&lt; StkFloat &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structstk_1_1Skini_1_1Message.html#acb4bb30558903d1b02092207d4f2dda8">floatValues</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::vector&lt; long &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structstk_1_1Skini_1_1Message.html#a0d5d310534fa8a7edc43ca259e73ffc7">intValues</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structstk_1_1Skini_1_1Message.html#a8c61b471a341e0168eb475b458404247">remainder</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A message structure to store and pass parsed SKINI messages. </p>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a6f55441cfdbc674c992fd98f95d458ca"></a><!-- doxytag: member="stk::Skini::Message::type" ref="a6f55441cfdbc674c992fd98f95d458ca" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long <a class="el" href="structstk_1_1Skini_1_1Message.html#a6f55441cfdbc674c992fd98f95d458ca">stk::Skini::Message::type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The message type, as defined in SKINI.msg. </p>
</div>
</div>
<a class="anchor" id="ac5d1504e617c2227055799300fc1936e"></a><!-- doxytag: member="stk::Skini::Message::channel" ref="ac5d1504e617c2227055799300fc1936e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long <a class="el" href="structstk_1_1Skini_1_1Message.html#ac5d1504e617c2227055799300fc1936e">stk::Skini::Message::channel</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The message channel (not limited to 16!). </p>
</div>
</div>
<a class="anchor" id="a6d07933c0cf4c92e76677236c2341e2f"></a><!-- doxytag: member="stk::Skini::Message::time" ref="a6d07933c0cf4c92e76677236c2341e2f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StkFloat <a class="el" href="structstk_1_1Skini_1_1Message.html#a6d07933c0cf4c92e76677236c2341e2f">stk::Skini::Message::time</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The message time stamp in seconds (delta or absolute). </p>
</div>
</div>
<a class="anchor" id="acb4bb30558903d1b02092207d4f2dda8"></a><!-- doxytag: member="stk::Skini::Message::floatValues" ref="acb4bb30558903d1b02092207d4f2dda8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;StkFloat&gt; <a class="el" href="structstk_1_1Skini_1_1Message.html#acb4bb30558903d1b02092207d4f2dda8">stk::Skini::Message::floatValues</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The message values read as floats (values are type-specific). </p>
</div>
</div>
<a class="anchor" id="a0d5d310534fa8a7edc43ca259e73ffc7"></a><!-- doxytag: member="stk::Skini::Message::intValues" ref="a0d5d310534fa8a7edc43ca259e73ffc7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;long&gt; <a class="el" href="structstk_1_1Skini_1_1Message.html#a0d5d310534fa8a7edc43ca259e73ffc7">stk::Skini::Message::intValues</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The message values read as ints (number and values are type-specific). </p>
</div>
</div>
<a class="anchor" id="a8c61b471a341e0168eb475b458404247"></a><!-- doxytag: member="stk::Skini::Message::remainder" ref="a8c61b471a341e0168eb475b458404247" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="structstk_1_1Skini_1_1Message.html#a8c61b471a341e0168eb475b458404247">stk::Skini::Message::remainder</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Any remaining message data, read as ascii text. </p>
</div>
</div>
<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></li>
</ul>
</div>
<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-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>