<!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.3"/>
<title>GNU Radio 3.6.4.1 C++ API: gr_timer Class 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="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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 style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</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('classgr__timer.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classgr__timer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gr_timer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>implement timeouts
<a href="classgr__timer.html#details">More...</a></p>
<p><code>#include <<a class="el" href="gr__timer_8h_source.html">gr_timer.h</a>></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:a253ab647fa0383d51ad9eb138ee392bb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__timer.html#a253ab647fa0383d51ad9eb138ee392bb">~gr_timer</a> ()</td></tr>
<tr class="separator:a253ab647fa0383d51ad9eb138ee392bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab781a88ff4cc3e0df4f9c0f1c9476191"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__timer.html#ab781a88ff4cc3e0df4f9c0f1c9476191">schedule_at</a> (double abs_when)</td></tr>
<tr class="memdesc:ab781a88ff4cc3e0df4f9c0f1c9476191"><td class="mdescLeft"> </td><td class="mdescRight">schedule timer to fire at abs_when <a href="#ab781a88ff4cc3e0df4f9c0f1c9476191"></a><br/></td></tr>
<tr class="separator:ab781a88ff4cc3e0df4f9c0f1c9476191"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a984ee98c414f274071e02738c9b540f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__timer.html#a984ee98c414f274071e02738c9b540f0">schedule_after</a> (double rel_when)</td></tr>
<tr class="memdesc:a984ee98c414f274071e02738c9b540f0"><td class="mdescLeft"> </td><td class="mdescRight">schedule timer to fire rel_when seconds from now. <a href="#a984ee98c414f274071e02738c9b540f0"></a><br/></td></tr>
<tr class="separator:a984ee98c414f274071e02738c9b540f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b34271c4cfc0ac9d3f145db3d66e9d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__timer.html#a8b34271c4cfc0ac9d3f145db3d66e9d2">schedule_periodic</a> (double abs_when, double period)</td></tr>
<tr class="memdesc:a8b34271c4cfc0ac9d3f145db3d66e9d2"><td class="mdescLeft"> </td><td class="mdescRight">schedule a periodic timeout. <a href="#a8b34271c4cfc0ac9d3f145db3d66e9d2"></a><br/></td></tr>
<tr class="separator:a8b34271c4cfc0ac9d3f145db3d66e9d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e145fa5b0ea597fa0853498b18f6a0a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__timer.html#a0e145fa5b0ea597fa0853498b18f6a0a">unschedule</a> ()</td></tr>
<tr class="memdesc:a0e145fa5b0ea597fa0853498b18f6a0a"><td class="mdescLeft"> </td><td class="mdescRight">cancel timer <a href="#a0e145fa5b0ea597fa0853498b18f6a0a"></a><br/></td></tr>
<tr class="separator:a0e145fa5b0ea597fa0853498b18f6a0a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa6e9cdb89da2b3aa07af41b771c24ba8"><td class="memItemLeft" align="right" valign="top">static double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__timer.html#aa6e9cdb89da2b3aa07af41b771c24ba8">now</a> ()</td></tr>
<tr class="memdesc:aa6e9cdb89da2b3aa07af41b771c24ba8"><td class="mdescLeft"> </td><td class="mdescRight">return absolute current time (seconds since the epoc). <a href="#aa6e9cdb89da2b3aa07af41b771c24ba8"></a><br/></td></tr>
<tr class="separator:aa6e9cdb89da2b3aa07af41b771c24ba8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a462255ae0a0ae202ef6c88cef0be8ada"><td class="memItemLeft" align="right" valign="top"><a class="el" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="el" href="classboost_1_1shared__ptr.html">gr_timer_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__timer.html#a462255ae0a0ae202ef6c88cef0be8ada">gr_make_timer</a> (<a class="el" href="gr__timer_8h.html#a72c5c11c933a21d559ca3c1eed5753ef">gr_timer_hook</a>, <a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> *)</td></tr>
<tr class="memdesc:a462255ae0a0ae202ef6c88cef0be8ada"><td class="mdescLeft"> </td><td class="mdescRight">create a timeout. <a href="#a462255ae0a0ae202ef6c88cef0be8ada"></a><br/></td></tr>
<tr class="separator:a462255ae0a0ae202ef6c88cef0be8ada"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>implement timeouts </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a253ab647fa0383d51ad9eb138ee392bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_timer::~gr_timer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa6e9cdb89da2b3aa07af41b771c24ba8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static double gr_timer::now </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>return absolute current time (seconds since the epoc). </p>
</div>
</div>
<a class="anchor" id="a984ee98c414f274071e02738c9b540f0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr_timer::schedule_after </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>rel_when</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>schedule timer to fire rel_when seconds from now. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rel_when</td><td>relative time in seconds from now. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab781a88ff4cc3e0df4f9c0f1c9476191"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr_timer::schedule_at </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>abs_when</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>schedule timer to fire at abs_when </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">abs_when</td><td>absolute time in seconds since the epoc. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8b34271c4cfc0ac9d3f145db3d66e9d2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr_timer::schedule_periodic </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>abs_when</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>period</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>schedule a periodic timeout. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">abs_when</td><td>absolute time to fire first time </td></tr>
<tr><td class="paramname">period</td><td>time between firings </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0e145fa5b0ea597fa0853498b18f6a0a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> gr_timer::unschedule </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>cancel timer </p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a462255ae0a0ae202ef6c88cef0be8ada"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="el" href="classboost_1_1shared__ptr.html">gr_timer_sptr</a> gr_make_timer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="gr__timer_8h.html#a72c5c11c933a21d559ca3c1eed5753ef">gr_timer_hook</a> </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="volk_8tmpl_8h.html#a8dc2b7da310a28e667530ba0e8ca4cc4">void</a> * </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>create a timeout. </p>
<p>gr_timer_hook is called when timer fires. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__timer_8h_source.html">gr_timer.h</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="classgr__timer.html">gr_timer</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:39 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
