<!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.8"/> <title>UHD: include/uhd/types/time_spec.hpp Source File</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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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">UHD  <span id="projectnumber">003.007.002-0-unknown</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9b536c30bc5a9db2084d75e9c271ba6f.html">uhd</a></li><li class="navelem"><a class="el" href="dir_7461a2958eedf41f0cc2e50ee75b14b0.html">types</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">time_spec.hpp</div> </div> </div><!--header--> <div class="contents"> <a href="time__spec_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright 2010-2012 Ettus Research LLC</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// This program is free software: you can redistribute it and/or modify</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// it under the terms of the GNU General Public License as published by</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// the Free Software Foundation, either version 3 of the License, or</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// (at your option) any later version.</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// This program is distributed in the hope that it will be useful,</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// GNU General Public License for more details.</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">//</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// You should have received a copy of the GNU General Public License</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// along with this program. If not, see <http://www.gnu.org/licenses/>.</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">//</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef INCLUDED_UHD_TYPES_TIME_SPEC_HPP</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define INCLUDED_UHD_TYPES_TIME_SPEC_HPP</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <<a class="code" href="config_8hpp.html">uhd/config.hpp</a>></span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <boost/operators.hpp></span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ctime></span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span><a class="code" href="namespaceuhd.html">uhd</a>{</div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div> <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classuhd_1_1time__spec__t.html"> 39</a></span>  <span class="keyword">class </span><a class="code" href="config_8hpp.html#adc68e1c030efb88af856decedf19aedf">UHD_API</a> <a class="code" href="classuhd_1_1time__spec__t.html">time_spec_t</a> : boost::additive<time_spec_t>, boost::totally_ordered<time_spec_t>{</div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">public</span>:</div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">static</span> <a class="code" href="classuhd_1_1time__spec__t.html">time_spec_t</a> get_system_time(<span class="keywordtype">void</span>);</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classuhd_1_1time__spec__t.html">time_spec_t</a>(<span class="keywordtype">double</span> secs = 0);</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="classuhd_1_1time__spec__t.html">time_spec_t</a>(time_t full_secs, <span class="keywordtype">double</span> frac_secs = 0);</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classuhd_1_1time__spec__t.html">time_spec_t</a>(time_t full_secs, <span class="keywordtype">long</span> tick_count, <span class="keywordtype">double</span> tick_rate);</div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">static</span> <a class="code" href="classuhd_1_1time__spec__t.html">time_spec_t</a> from_ticks(<span class="keywordtype">long</span> <span class="keywordtype">long</span> ticks, <span class="keywordtype">double</span> tick_rate);</div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">long</span> get_tick_count(<span class="keywordtype">double</span> tick_rate) <span class="keyword">const</span>;</div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">long</span> <span class="keywordtype">long</span> to_ticks(<span class="keyword">const</span> <span class="keywordtype">double</span> tick_rate) <span class="keyword">const</span>;</div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">double</span> get_real_secs(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  time_t get_full_secs(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">double</span> get_frac_secs(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <a class="code" href="classuhd_1_1time__spec__t.html">time_spec_t</a> &operator+=(<span class="keyword">const</span> <a class="code" href="classuhd_1_1time__spec__t.html">time_spec_t</a> &);</div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="classuhd_1_1time__spec__t.html">time_spec_t</a> &operator-=(<span class="keyword">const</span> <a class="code" href="classuhd_1_1time__spec__t.html">time_spec_t</a> &);</div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="comment">//private time storage details</span></div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">private</span>: time_t _full_secs; <span class="keywordtype">double</span> _frac_secs;</div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  };</div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <a class="code" href="config_8hpp.html#adc68e1c030efb88af856decedf19aedf">UHD_API</a> <span class="keywordtype">bool</span> <a class="code" href="namespaceuhd.html#a493a9edc85b83ed91c909670a259a6bd">operator==</a>(<span class="keyword">const</span> <a class="code" href="classuhd_1_1time__spec__t.html">time_spec_t</a> &, <span class="keyword">const</span> <a class="code" href="classuhd_1_1time__spec__t.html">time_spec_t</a> &);</div> <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div> <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <a class="code" href="config_8hpp.html#adc68e1c030efb88af856decedf19aedf">UHD_API</a> <span class="keywordtype">bool</span> <a class="code" href="namespaceuhd.html#a5c44da6b9ff6024bd84063273323e015">operator<</a>(<span class="keyword">const</span> <a class="code" href="classuhd_1_1time__spec__t.html">time_spec_t</a> &, <span class="keyword">const</span> <a class="code" href="classuhd_1_1time__spec__t.html">time_spec_t</a> &);</div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div> <div class="line"><a name="l00131"></a><span class="lineno"><a class="line" href="classuhd_1_1time__spec__t.html#a6226790aa8374389cde058fd7d87d05c"> 131</a></span>  <a class="code" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> time_t <a class="code" href="classuhd_1_1time__spec__t.html#a6226790aa8374389cde058fd7d87d05c">time_spec_t::get_full_secs</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span>{</div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordflow">return</span> this->_full_secs;</div> <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  }</div> <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div> <div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="classuhd_1_1time__spec__t.html#a76bb46c8415285383ca89786253e32ed"> 135</a></span>  <a class="code" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> <span class="keywordtype">double</span> <a class="code" href="classuhd_1_1time__spec__t.html#a76bb46c8415285383ca89786253e32ed">time_spec_t::get_frac_secs</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span>{</div> <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordflow">return</span> this->_frac_secs;</div> <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  }</div> <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div> <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> } <span class="comment">//namespace uhd</span></div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div> <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_UHD_TYPES_TIME_SPEC_HPP */</span><span class="preprocessor"></span></div> <div class="ttc" id="classuhd_1_1time__spec__t_html"><div class="ttname"><a href="classuhd_1_1time__spec__t.html">uhd::time_spec_t</a></div><div class="ttdef"><b>Definition:</b> time_spec.hpp:39</div></div> <div class="ttc" id="config_8hpp_html"><div class="ttname"><a href="config_8hpp.html">config.hpp</a></div></div> <div class="ttc" id="classuhd_1_1time__spec__t_html_a6226790aa8374389cde058fd7d87d05c"><div class="ttname"><a href="classuhd_1_1time__spec__t.html#a6226790aa8374389cde058fd7d87d05c">uhd::time_spec_t::get_full_secs</a></div><div class="ttdeci">time_t get_full_secs(void) const </div><div class="ttdef"><b>Definition:</b> time_spec.hpp:131</div></div> <div class="ttc" id="config_8hpp_html_adc68e1c030efb88af856decedf19aedf"><div class="ttname"><a href="config_8hpp.html#adc68e1c030efb88af856decedf19aedf">UHD_API</a></div><div class="ttdeci">#define UHD_API</div><div class="ttdef"><b>Definition:</b> config.hpp:79</div></div> <div class="ttc" id="namespaceuhd_html"><div class="ttname"><a href="namespaceuhd.html">uhd</a></div><div class="ttdef"><b>Definition:</b> convert.hpp:28</div></div> <div class="ttc" id="config_8hpp_html_a8b9b549161081d54c2161046649a0323"><div class="ttname"><a href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a></div><div class="ttdeci">#define UHD_INLINE</div><div class="ttdef"><b>Definition:</b> config.hpp:69</div></div> <div class="ttc" id="namespaceuhd_html_a5c44da6b9ff6024bd84063273323e015"><div class="ttname"><a href="namespaceuhd.html#a5c44da6b9ff6024bd84063273323e015">uhd::operator<</a></div><div class="ttdeci">UHD_API bool operator<(const time_spec_t &, const time_spec_t &)</div><div class="ttdoc">Implement less_than_comparable interface. </div></div> <div class="ttc" id="namespaceuhd_html_a493a9edc85b83ed91c909670a259a6bd"><div class="ttname"><a href="namespaceuhd.html#a493a9edc85b83ed91c909670a259a6bd">uhd::operator==</a></div><div class="ttdeci">UHD_API bool operator==(const time_spec_t &, const time_spec_t &)</div><div class="ttdoc">Implement equality_comparable interface. </div></div> <div class="ttc" id="classuhd_1_1time__spec__t_html_a76bb46c8415285383ca89786253e32ed"><div class="ttname"><a href="classuhd_1_1time__spec__t.html#a76bb46c8415285383ca89786253e32ed">uhd::time_spec_t::get_frac_secs</a></div><div class="ttdeci">double get_frac_secs(void) const </div><div class="ttdef"><b>Definition:</b> time_spec.hpp:135</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Wed Oct 15 2014 11:47:53 for UHD by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.8 </small></address> </body> </html>