Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 6645

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<!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: omni_time.h Source File</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('omni__time_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>omni_time.h</h1>  </div>
</div>
<div class="contents">
<a href="omni__time_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2007,2008 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License along</span>
<a name="l00018"></a>00018 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00019"></a>00019 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef INCLUDED_OMNI_TIME_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_OMNI_TIME_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a><a class="code" href="structomni__time.html">00024</a> <span class="keyword">struct </span><a class="code" href="structomni__time.html">omni_time</a> {
<a name="l00025"></a><a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">00025</a>   <span class="keywordtype">long</span> <span class="keywordtype">int</span> <a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a>;      <span class="comment">// seconds.</span>
<a name="l00026"></a><a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">00026</a>   <span class="keywordtype">long</span> <span class="keywordtype">int</span> <a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">d_nsecs</a>;     <span class="comment">// nanoseconds.  Always in [0, 1e9-1]</span>
<a name="l00027"></a>00027 
<a name="l00028"></a><a class="code" href="structomni__time.html#a94b120b2cd53941358eb0950af134471">00028</a>   <a class="code" href="structomni__time.html#a94b120b2cd53941358eb0950af134471">omni_time</a>() : <a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a>(0), <a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">d_nsecs</a>(0) {}
<a name="l00029"></a><a class="code" href="structomni__time.html#a340aeb0fbf9c353419914e354c1b248f">00029</a>   <a class="code" href="structomni__time.html#a340aeb0fbf9c353419914e354c1b248f">omni_time</a>(<span class="keywordtype">long</span> secs, <span class="keywordtype">long</span> nanosecs=0) : <a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a>(secs), <a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">d_nsecs</a>(nanosecs) {}
<a name="l00030"></a>00030 
<a name="l00031"></a>00031   <span class="comment">// N.B., this only makes sense for differences between times.</span>
<a name="l00032"></a>00032   <span class="comment">// Double doesn&#39;t have enough bits to precisely represent an absolute time.</span>
<a name="l00033"></a>00033   <a class="code" href="structomni__time.html#a94b120b2cd53941358eb0950af134471">omni_time</a>(<span class="keywordtype">double</span> secs);
<a name="l00034"></a>00034 
<a name="l00035"></a>00035   <span class="comment">// N.B. This only makes sense for differences between times.</span>
<a name="l00036"></a>00036   <span class="comment">// Double doesn&#39;t have enough bits to precisely represent an absolute time.</span>
<a name="l00037"></a><a class="code" href="structomni__time.html#aec19bee86376de74ce2801f694181351">00037</a>   <span class="keywordtype">double</span> <a class="code" href="structomni__time.html#aec19bee86376de74ce2801f694181351">double_time</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (<span class="keywordtype">double</span>)<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> + <a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">d_nsecs</a> * 1e-9; }
<a name="l00038"></a>00038 <span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment">  /*!</span>
<a name="l00040"></a>00040 <span class="comment">   * \brief Return an absolute time suitable for use with</span>
<a name="l00041"></a>00041 <span class="comment">   * schedule_one_shot_timeout &amp; schedule_periodic_timeout</span>
<a name="l00042"></a>00042 <span class="comment">   *</span>
<a name="l00043"></a>00043 <span class="comment">   * The return value is the current time plus the given relative offset.</span>
<a name="l00044"></a>00044 <span class="comment">   */</span>
<a name="l00045"></a>00045   <span class="keyword">static</span> <a class="code" href="structomni__time.html">omni_time</a> <a class="code" href="structomni__time.html#a624ef1455d24588488284fa3b4aaebcd" title="Return an absolute time suitable for use with schedule_one_shot_timeout &amp;amp; schedule_periodic_timeo...">time</a>(<span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;relative_offset = <a class="code" href="structomni__time.html#a94b120b2cd53941358eb0950af134471">omni_time</a>());
<a name="l00046"></a>00046 };
<a name="l00047"></a>00047 
<a name="l00048"></a>00048 
<a name="l00049"></a>00049 <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">bool</span>
<a name="l00050"></a><a class="code" href="omni__time_8h.html#a1b1132e02060b62ec57d1820a8aee48d">00050</a> <a class="code" href="gr__basic__block_8h.html#afe7684d11bda1c7330f6f32251f5a447">operator&lt;</a>(<span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;x, <span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;y)
<a name="l00051"></a>00051 {
<a name="l00052"></a>00052   <span class="keywordflow">return</span> ((x.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> &lt; y.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a>)
<a name="l00053"></a>00053           || (x.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> == y.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> &amp;&amp; x.<a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">d_nsecs</a> &lt; y.<a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">d_nsecs</a>));
<a name="l00054"></a>00054 }
<a name="l00055"></a>00055 
<a name="l00056"></a>00056 <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">bool</span>
<a name="l00057"></a><a class="code" href="omni__time_8h.html#a25be0522379f62af6aaa6d3e36bb1a73">00057</a> <a class="code" href="omni__time_8h.html#a25be0522379f62af6aaa6d3e36bb1a73">operator&gt;</a>(<span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;x, <span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;y)
<a name="l00058"></a>00058 {
<a name="l00059"></a>00059   <span class="keywordflow">return</span> ((x.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> &gt; y.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a>)
<a name="l00060"></a>00060           || (x.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> == y.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> &amp;&amp; x.<a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">d_nsecs</a> &gt; y.<a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">d_nsecs</a>));
<a name="l00061"></a>00061 }
<a name="l00062"></a>00062 
<a name="l00063"></a>00063 <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">bool</span>
<a name="l00064"></a><a class="code" href="omni__time_8h.html#a5080392f200a2f28a1a51c5752aa1d6d">00064</a> <a class="code" href="omni__time_8h.html#a5080392f200a2f28a1a51c5752aa1d6d">operator&gt;=</a>(<span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;x, <span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;y)
<a name="l00065"></a>00065 {
<a name="l00066"></a>00066   <span class="keywordflow">return</span> ((x.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> &gt; y.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a>)
<a name="l00067"></a>00067           || (x.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> == y.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> &amp;&amp; x.<a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">d_nsecs</a> &gt;= y.<a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">d_nsecs</a>));
<a name="l00068"></a>00068 }
<a name="l00069"></a>00069 
<a name="l00070"></a>00070 <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">bool</span>
<a name="l00071"></a><a class="code" href="omni__time_8h.html#a8693ce7de44078cb5577b9669676f4ee">00071</a> <a class="code" href="omni__time_8h.html#a8693ce7de44078cb5577b9669676f4ee">operator&lt;=</a>(<span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;x, <span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;y)
<a name="l00072"></a>00072 {
<a name="l00073"></a>00073   <span class="keywordflow">return</span> ((x.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> &lt; y.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a>)
<a name="l00074"></a>00074           || (x.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> == y.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> &amp;&amp; x.<a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">d_nsecs</a> &lt;= y.<a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">d_nsecs</a>));
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076 
<a name="l00077"></a>00077 <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keywordtype">bool</span>
<a name="l00078"></a><a class="code" href="omni__time_8h.html#af46e40dc8d0a1f7f18e9d8a61aeb7662">00078</a> <a class="code" href="omni__time_8h.html#af46e40dc8d0a1f7f18e9d8a61aeb7662">operator==</a>(<span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;x, <span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;y)
<a name="l00079"></a>00079 {
<a name="l00080"></a>00080   <span class="keywordflow">return</span> (x.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> == y.<a class="code" href="structomni__time.html#af1407e75b5cf65c9e0c7e8de05c665f7">d_secs</a> &amp;&amp; x.<a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">d_nsecs</a> == y.<a class="code" href="structomni__time.html#ac22fcb7bafadbc2b85b1e83f2f31dbad">d_nsecs</a>);
<a name="l00081"></a>00081 }
<a name="l00082"></a>00082 
<a name="l00083"></a>00083 
<a name="l00084"></a>00084 <a class="code" href="structomni__time.html">omni_time</a> <a class="code" href="omni__time_8h.html#a6415a9483ff049dd9718171ab152fa4b">operator+</a>(<span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;x, <span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;y);
<a name="l00085"></a>00085 <a class="code" href="structomni__time.html">omni_time</a> <a class="code" href="omni__time_8h.html#a6415a9483ff049dd9718171ab152fa4b">operator+</a>(<span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;x, <span class="keywordtype">double</span> y);
<a name="l00086"></a>00086 <a class="code" href="structomni__time.html">omni_time</a> <a class="code" href="omni__time_8h.html#a212475c9aa4ea9de2523bb74c027044c">operator-</a>(<span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;x, <span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;y);
<a name="l00087"></a>00087 <a class="code" href="structomni__time.html">omni_time</a> <a class="code" href="omni__time_8h.html#a212475c9aa4ea9de2523bb74c027044c">operator-</a>(<span class="keyword">const</span> <a class="code" href="structomni__time.html">omni_time</a> &amp;x, <span class="keywordtype">double</span> y);
<a name="l00088"></a>00088 
<a name="l00089"></a>00089 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_OMNI_TIME_H */</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="omni__time_8h.html">omni_time.h</a>      </li>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<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>