USRP Hardware Driver and USRP Manual: time_spec.hpp Source File

| USRP Hardware Driver and USRP Manual Version: 4.8.0.makepkg-0-g308126a4 UHD and USRP Manual |

Loading...
Searching...
No Matches
time_spec.hpp
Go to the documentation of this file.
1//
2// Copyright 2010-2012 Ettus Research LLC
3// Copyright 2018 Ettus Research, a National Instruments Company
4//
5// SPDX-License-Identifier: GPL-3.0-or-later
6//
7
8#pragma once
9
10#include <uhd/config.hpp>
11#include <stdint.h>
12#include <boost/operators.hpp>
13
14namespace uhd {
15
28 class UHD_API time_spec_t : boost::additive<time_spec_t>,
29 boost::additive<time_spec_t, double>,
30 boost::totally_ordered<time_spec_t>
31{
32public:
33 // A special value that signifies immediate execution
34 static constexpr double ASAP = 0.0;
35
40 time_spec_t(double secs = 0);
41
47 time_spec_t(int64_t full_secs, double frac_secs = 0);
48
56 time_spec_t(int64_t full_secs, long tick_count, double tick_rate);
57
64 static time_spec_t from_ticks(long long ticks, double tick_rate);
65
72 long get_tick_count(double tick_rate) const;
73
80 long long to_ticks(const double tick_rate) const;
81
88 double get_real_secs(void) const;
89
94 int64_t get_full_secs(void) const;
95
100 double get_frac_secs(void) const;
101
103 time_spec_t& operator+=(const time_spec_t&);
104 time_spec_t& operator+=(double&);
106 time_spec_t& operator-=(const time_spec_t&);
107 time_spec_t& operator-=(double&);
108
109 // private time storage details
110private:
111 int64_t _full_secs;
112 double _frac_secs;
113};
114
116 UHD_API bool operator==(const time_spec_t&, const time_spec_t&);
117
119 UHD_API bool operator<(const time_spec_t&, const time_spec_t&);
120
121 UHD_INLINE int64_t time_spec_t::get_full_secs(void) const
122{
123 return this->_full_secs;
124}
125
126 UHD_INLINE double time_spec_t::get_frac_secs(void) const
127{
128 return this->_frac_secs;
129}
130
131} // namespace uhd
uhd::time_spec_t
Definition time_spec.hpp:31
uhd::time_spec_t::get_full_secs
int64_t get_full_secs(void) const
Definition time_spec.hpp:121
uhd::time_spec_t::get_tick_count
long get_tick_count(double tick_rate) const
uhd::time_spec_t::time_spec_t
time_spec_t(double secs=0)
uhd::time_spec_t::operator+=
time_spec_t & operator+=(double &)
uhd::time_spec_t::operator+=
time_spec_t & operator+=(const time_spec_t &)
Implement addable interface.
uhd::time_spec_t::get_frac_secs
double get_frac_secs(void) const
Definition time_spec.hpp:126
uhd::time_spec_t::ASAP
static constexpr double ASAP
Definition time_spec.hpp:34
uhd::time_spec_t::time_spec_t
time_spec_t(int64_t full_secs, long tick_count, double tick_rate)
uhd::time_spec_t::operator-=
time_spec_t & operator-=(double &)
uhd::time_spec_t::get_real_secs
double get_real_secs(void) const
uhd::time_spec_t::from_ticks
static time_spec_t from_ticks(long long ticks, double tick_rate)
uhd::time_spec_t::time_spec_t
time_spec_t(int64_t full_secs, double frac_secs=0)
uhd::time_spec_t::operator-=
time_spec_t & operator-=(const time_spec_t &)
Implement subtractable interface.
uhd::time_spec_t::to_ticks
long long to_ticks(const double tick_rate) const
UHD_INLINE
#define UHD_INLINE
Definition config.h:65
UHD_API
#define UHD_API
Definition config.h:87
config.hpp
uhd
Definition build_info.hpp:12
uhd::operator==
UHD_API bool operator==(const time_spec_t &, const time_spec_t &)
Implement equality_comparable interface.
uhd::operator<
UHD_API bool operator<(const time_spec_t &, const time_spec_t &)
Implement less_than_comparable interface.