UHD  003.004.001-0-unknown
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
include/uhd/types/time_spec.hpp
Go to the documentation of this file.
00001 //
00002 // Copyright 2010-2012 Ettus Research LLC
00003 //
00004 // This program is free software: you can redistribute it and/or modify
00005 // it under the terms of the GNU General Public License as published by
00006 // the Free Software Foundation, either version 3 of the License, or
00007 // (at your option) any later version.
00008 //
00009 // This program is distributed in the hope that it will be useful,
00010 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00011 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012 // GNU General Public License for more details.
00013 //
00014 // You should have received a copy of the GNU General Public License
00015 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
00016 //
00017 
00018 #ifndef INCLUDED_UHD_TYPES_TIME_SPEC_HPP
00019 #define INCLUDED_UHD_TYPES_TIME_SPEC_HPP
00020 
00021 #include <uhd/config.hpp>
00022 #include <boost/operators.hpp>
00023 #include <ctime>
00024 
00025 namespace uhd{
00026 
00039     class UHD_API time_spec_t : boost::additive<time_spec_t>, boost::totally_ordered<time_spec_t>{
00040     public:
00041 
00047         static time_spec_t get_system_time(void);
00048 
00053         time_spec_t(double secs = 0);
00054 
00060         time_spec_t(time_t full_secs, double frac_secs = 0);
00061 
00069         time_spec_t(time_t full_secs, long tick_count, double tick_rate);
00070 
00077         static time_spec_t from_ticks(long long ticks, double tick_rate);
00078 
00085         long get_tick_count(double tick_rate) const;
00086 
00093         long long to_ticks(const double tick_rate) const;
00094 
00101         double get_real_secs(void) const;
00102 
00107         time_t get_full_secs(void) const;
00108 
00113         double get_frac_secs(void) const;
00114 
00116         time_spec_t &operator+=(const time_spec_t &);
00117 
00119         time_spec_t &operator-=(const time_spec_t &);
00120 
00121     //private time storage details
00122     private: time_t _full_secs; double _frac_secs;
00123     };
00124 
00126     UHD_API bool operator==(const time_spec_t &, const time_spec_t &);
00127 
00129     UHD_API bool operator<(const time_spec_t &, const time_spec_t &);
00130 
00131     UHD_INLINE time_t time_spec_t::get_full_secs(void) const{
00132         return this->_full_secs;
00133     }
00134 
00135     UHD_INLINE double time_spec_t::get_frac_secs(void) const{
00136         return this->_frac_secs;
00137     }
00138 
00139 } //namespace uhd
00140 
00141 #endif /* INCLUDED_UHD_TYPES_TIME_SPEC_HPP */