<!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>GNU Radio 3.2.2 C++ API: gr_timer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<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.2.2 C++ API</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
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> </div>
<div class="headertitle">
<h1>gr_timer Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_timer" -->
<p>implement timeouts
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__timer_8h_source.html">gr_timer.h</a>></code></p>
<p><a href="classgr__timer-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__timer.html#a253ab647fa0383d51ad9eb138ee392bb">~gr_timer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__timer.html#ab781a88ff4cc3e0df4f9c0f1c9476191">schedule_at</a> (double abs_when)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">schedule timer to fire at abs_when <a href="#ab781a88ff4cc3e0df4f9c0f1c9476191"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__timer.html#a984ee98c414f274071e02738c9b540f0">schedule_after</a> (double rel_when)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">schedule timer to fire rel_when seconds from now. <a href="#a984ee98c414f274071e02738c9b540f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </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><td class="mdescLeft"> </td><td class="mdescRight">schedule a periodic timeout. <a href="#a8b34271c4cfc0ac9d3f145db3d66e9d2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__timer.html#a0e145fa5b0ea597fa0853498b18f6a0a">unschedule</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">cancel timer <a href="#a0e145fa5b0ea597fa0853498b18f6a0a"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">return absolute current time (seconds since the epoc). <a href="#aa6e9cdb89da2b3aa07af41b771c24ba8"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><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#a54c4024986ca4db5b59761ae5c15ccbe">gr_make_timer</a> (<a class="el" href="gr__timer_8h.html#aaad1a7988cefaef6f86f25ce635e6162">gr_timer_hook</a>, void *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">create a timeout. <a href="#a54c4024986ca4db5b59761ae5c15ccbe"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>implement timeouts </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a253ab647fa0383d51ad9eb138ee392bb"></a><!-- doxytag: member="gr_timer::~gr_timer" ref="a253ab647fa0383d51ad9eb138ee392bb" args="()" -->
<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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa6e9cdb89da2b3aa07af41b771c24ba8"></a><!-- doxytag: member="gr_timer::now" ref="aa6e9cdb89da2b3aa07af41b771c24ba8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static double gr_timer::now </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></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><!-- doxytag: member="gr_timer::schedule_after" ref="a984ee98c414f274071e02738c9b540f0" args="(double rel_when)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void 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><dt><b>Parameters:</b></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><!-- doxytag: member="gr_timer::schedule_at" ref="ab781a88ff4cc3e0df4f9c0f1c9476191" args="(double abs_when)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void 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><dt><b>Parameters:</b></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><!-- doxytag: member="gr_timer::schedule_periodic" ref="a8b34271c4cfc0ac9d3f145db3d66e9d2" args="(double abs_when, double period)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void 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><dt><b>Parameters:</b></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><!-- doxytag: member="gr_timer::unschedule" ref="a0e145fa5b0ea597fa0853498b18f6a0a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void 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>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a54c4024986ca4db5b59761ae5c15ccbe"></a><!-- doxytag: member="gr_timer::gr_make_timer" ref="a54c4024986ca4db5b59761ae5c15ccbe" args="(gr_timer_hook, void *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><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#aaad1a7988cefaef6f86f25ce635e6162">gr_timer_hook</a> </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [friend]</code></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>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__timer.html">gr_timer</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
2099
