<!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"/>
<title>RAUL: Raul::TimeSlice Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div 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="namespaces.html"><span>Namespaces</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>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><b>Raul</b> </li>
<li><a class="el" href="classRaul_1_1TimeSlice.html">Raul::TimeSlice</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Raul::TimeSlice Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Raul::TimeSlice" -->
<p>A duration of time, with conversion between tick time and beat time.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="TimeSlice_8hpp_source.html">TimeSlice.hpp</a>></code></p>
<div class="dynheader">
Collaboration diagram for Raul::TimeSlice:</div>
<div class="dyncontent">
<div class="center"><img src="classRaul_1_1TimeSlice__coll__graph.png" border="0" usemap="#Raul_1_1TimeSlice_coll__map" alt="Collaboration graph"/></div>
<map name="Raul_1_1TimeSlice_coll__map" id="Raul_1_1TimeSlice_coll__map">
<area shape="rect" id="node2" href="classRaul_1_1TimeStamp.html" title="A real-time time stamp (possible units: frame, absolute (s), or beat)." alt="" coords="5,101,128,131"/><area shape="rect" id="node4" href="classRaul_1_1TimeUnit.html" title="A type of time stamp." alt="" coords="12,5,121,35"/></map>
</div>
<p><a href="classRaul_1_1TimeSlice-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1137d61707ab97eccbb5a1c799238b24"></a><!-- doxytag: member="Raul::TimeSlice::TimeSlice" ref="a1137d61707ab97eccbb5a1c799238b24" args="(uint32_t rate, uint32_t ppqn, double bpm)" -->
</td><td class="memItemRight" valign="bottom"><b>TimeSlice</b> (uint32_t rate, uint32_t ppqn, double bpm)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1TimeSlice.html#ac1d0209d2f40224f150cd3c7d7f5a9ed">set_slice</a> (<a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> start, <a class="el" href="classRaul_1_1TimeStamp.html">TimeDuration</a> length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the start and length of the slice. <a href="#ac1d0209d2f40224f150cd3c7d7f5a9ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff2dc6fb2a6f25dc7d2b1731165d143d"></a><!-- doxytag: member="Raul::TimeSlice::set_length" ref="aff2dc6fb2a6f25dc7d2b1731165d143d" args="(TimeDuration length)" -->
void </td><td class="memItemRight" valign="bottom"><b>set_length</b> (<a class="el" href="classRaul_1_1TimeStamp.html">TimeDuration</a> length)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50cfee2cb2bc12dc8b898b043c978933"></a><!-- doxytag: member="Raul::TimeSlice::contains" ref="a50cfee2cb2bc12dc8b898b043c978933" args="(TimeStamp time)" -->
bool </td><td class="memItemRight" valign="bottom"><b>contains</b> (<a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> time)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ffebd3125fb67ca5d06cbbcd16aace9"></a><!-- doxytag: member="Raul::TimeSlice::tick_rate" ref="a6ffebd3125fb67ca5d06cbbcd16aace9" args="()" -->
double </td><td class="memItemRight" valign="bottom"><b>tick_rate</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31d5104580e42ddd0c3108de2575fb02"></a><!-- doxytag: member="Raul::TimeSlice::beat_rate" ref="a31d5104580e42ddd0c3108de2575fb02" args="()" -->
double </td><td class="memItemRight" valign="bottom"><b>beat_rate</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ad7d9473e861f924cc8105c260c08f7"></a><!-- doxytag: member="Raul::TimeSlice::bpm" ref="a3ad7d9473e861f924cc8105c260c08f7" args="()" -->
double </td><td class="memItemRight" valign="bottom"><b>bpm</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2c201d2f1764b6355d9fdb6b48e4414"></a><!-- doxytag: member="Raul::TimeSlice::set_tick_rate" ref="ad2c201d2f1764b6355d9fdb6b48e4414" args="(double tick_rate)" -->
void </td><td class="memItemRight" valign="bottom"><b>set_tick_rate</b> (double tick_rate)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af825f904a154822b1c206c8630c8ad54"></a><!-- doxytag: member="Raul::TimeSlice::set_bpm" ref="af825f904a154822b1c206c8630c8ad54" args="(double bpm)" -->
void </td><td class="memItemRight" valign="bottom"><b>set_bpm</b> (double bpm)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade69d5cad79b8411c1ea3ac6c51ee769"></a><!-- doxytag: member="Raul::TimeSlice::beats_to_seconds" ref="ade69d5cad79b8411c1ea3ac6c51ee769" args="(TimeStamp beats) const " -->
<a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> </td><td class="memItemRight" valign="bottom"><b>beats_to_seconds</b> (<a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> beats) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0bdc22f299b5c330841e2dca6a8a86db"></a><!-- doxytag: member="Raul::TimeSlice::beats_to_ticks" ref="a0bdc22f299b5c330841e2dca6a8a86db" args="(TimeStamp beats) const " -->
<a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> </td><td class="memItemRight" valign="bottom"><b>beats_to_ticks</b> (<a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> beats) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf6c4eddb13e36a20d13b1d29508dee0"></a><!-- doxytag: member="Raul::TimeSlice::ticks_to_seconds" ref="aaf6c4eddb13e36a20d13b1d29508dee0" args="(TimeStamp ticks) const " -->
<a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> </td><td class="memItemRight" valign="bottom"><b>ticks_to_seconds</b> (<a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> ticks) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac676432f8b1be9419e8287e632a9ca0d"></a><!-- doxytag: member="Raul::TimeSlice::ticks_to_beats" ref="ac676432f8b1be9419e8287e632a9ca0d" args="(TimeStamp ticks) const " -->
<a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> </td><td class="memItemRight" valign="bottom"><b>ticks_to_beats</b> (<a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> ticks) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33f9ecd79318df0a0c1adbb71de4aae7"></a><!-- doxytag: member="Raul::TimeSlice::start_ticks" ref="a33f9ecd79318df0a0c1adbb71de4aae7" args="() const " -->
<a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1TimeSlice.html#a33f9ecd79318df0a0c1adbb71de4aae7">start_ticks</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start of current sub-cycle in ticks. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59f5a1955b65b5937a3238a9eb872c3b"></a><!-- doxytag: member="Raul::TimeSlice::length_ticks" ref="a59f5a1955b65b5937a3238a9eb872c3b" args="() const " -->
<a class="el" href="classRaul_1_1TimeStamp.html">TimeDuration</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1TimeSlice.html#a59f5a1955b65b5937a3238a9eb872c3b">length_ticks</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Length of current sub-cycle in ticks. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97521b3954662d7faf6b26db3039a8b0"></a><!-- doxytag: member="Raul::TimeSlice::start_beats" ref="a97521b3954662d7faf6b26db3039a8b0" args="() const " -->
<a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1TimeSlice.html#a97521b3954662d7faf6b26db3039a8b0">start_beats</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start of current sub-cycle in beats. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e3953cc15f6cffe8b10c2fc957aa0fb"></a><!-- doxytag: member="Raul::TimeSlice::length_beats" ref="a0e3953cc15f6cffe8b10c2fc957aa0fb" args="() const " -->
<a class="el" href="classRaul_1_1TimeStamp.html">TimeDuration</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1TimeSlice.html#a0e3953cc15f6cffe8b10c2fc957aa0fb">length_beats</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Length of current sub-cycle in beats. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1TimeSlice.html#a077a893ae8bd829b546b4ded72fed510">set_offset</a> (<a class="el" href="classRaul_1_1TimeStamp.html">TimeDuration</a> offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the offset between real-time and timeslice-time. <a href="#a077a893ae8bd829b546b4ded72fed510"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adfd0fac70b35b56d085423178caa7267"></a><!-- doxytag: member="Raul::TimeSlice::offset_ticks" ref="adfd0fac70b35b56d085423178caa7267" args="() const " -->
<a class="el" href="classRaul_1_1TimeStamp.html">TimeDuration</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1TimeSlice.html#adfd0fac70b35b56d085423178caa7267">offset_ticks</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Offset relative to external (e.g Jack) time. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb369c618d578a2d83ca7c7685076c86"></a><!-- doxytag: member="Raul::TimeSlice::beats_unit" ref="afb369c618d578a2d83ca7c7685076c86" args="() const " -->
<a class="el" href="classRaul_1_1TimeUnit.html">TimeUnit</a> </td><td class="memItemRight" valign="bottom"><b>beats_unit</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03d9c51fc659232d6a1711c9acdc683e"></a><!-- doxytag: member="Raul::TimeSlice::ticks_unit" ref="a03d9c51fc659232d6a1711c9acdc683e" args="() const " -->
<a class="el" href="classRaul_1_1TimeUnit.html">TimeUnit</a> </td><td class="memItemRight" valign="bottom"><b>ticks_unit</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2693abce8deda786b843fe7c1d30f971"></a><!-- doxytag: member="Raul::TimeSlice::real_unit" ref="a2693abce8deda786b843fe7c1d30f971" args="() const " -->
<a class="el" href="classRaul_1_1TimeUnit.html">TimeUnit</a> </td><td class="memItemRight" valign="bottom"><b>real_unit</b> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A duration of time, with conversion between tick time and beat time. </p>
<p>This is a slice along a single timeline (ie t=0 in ticks and t=0 in beats are equal). Relation to an external time base (e.g. Jack frame time) is represented by frame_offset (the idea is that this holds all the information necessary for passing to run() methods so they know the current state of things WRT time).</p>
<p>This class handles conversion between two units of time: musical (beat) time, and real (tick) time. Real time is discrete, the smallest unit of time is the 'tick' (usually audio frames or MIDI ticks). Beat time is stored as a double (to be independent of any rates or timer precision).</p>
<p>This caches as many values as possible to make calls less expensive, pass it around by reference, not value. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac1d0209d2f40224f150cd3c7d7f5a9ed"></a><!-- doxytag: member="Raul::TimeSlice::set_slice" ref="ac1d0209d2f40224f150cd3c7d7f5a9ed" args="(TimeStamp start, TimeDuration length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Raul::TimeSlice::set_slice </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRaul_1_1TimeStamp.html">TimeStamp</a> </td>
<td class="paramname"> <em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classRaul_1_1TimeStamp.html">TimeDuration</a> </td>
<td class="paramname"> <em>length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the start and length of the slice. </p>
<p>Note that external offset is not affected by this, don't forget to reset the offset each cycle! </p>
</div>
</div>
<a class="anchor" id="a077a893ae8bd829b546b4ded72fed510"></a><!-- doxytag: member="Raul::TimeSlice::set_offset" ref="a077a893ae8bd829b546b4ded72fed510" args="(TimeDuration offset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Raul::TimeSlice::set_offset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRaul_1_1TimeStamp.html">TimeDuration</a> </td>
<td class="paramname"> <em>offset</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the offset between real-time and timeslice-time. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="TimeSlice_8hpp_source.html">TimeSlice.hpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
88959ca903fe50462ea99715ead18944
>
files
>
176
