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

| USRP Hardware Driver and USRP Manual Version: 4.9.0.makepkg-0-g9ec1f582 UHD and USRP Manual |

Loading...
Searching...
No Matches
ranges.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 <type_traits>
12#include <string>
13#include <vector>
14
15namespace uhd {
16
21 class UHD_API range_t
22{
23public:
29 range_t(double value = 0);
30
38 range_t(double start, double stop, double step = 0);
39
41 double start(void) const;
42
44 double stop(void) const;
45
47 double step(void) const;
48
50 std::string to_pp_string(void) const;
51
53 bool operator==(const range_t& other) const;
54
56 bool operator!=(const range_t& other) const;
57
58private:
59 double _start, _stop, _step;
60};
61
65 struct UHD_API meta_range_t : public std::vector<range_t>
66{
68 meta_range_t(void);
69
76 template <typename InputIterator>
77 meta_range_t(InputIterator first, InputIterator last)
78 : std::vector<range_t>(first, last)
79 { /* NOP */
80 // This is to avoid people accidentally doing silly things like:
81 // meta_range_t(0, 0)
82 // which probably was supposed to call meta_range_t(double, double, double)
83 // but actually calls this constructor.
84 static_assert(!std::is_integral<typename std::decay<InputIterator>::type>::value,
85 "You can't pass integers to meta_range_t's constructor!");
86 }
87
95 meta_range_t(double start, double stop, double step = 0);
96
98 double start(void) const;
99
101 double stop(void) const;
102
104 double step(void) const;
105
112 double clip(double value, bool clip_step = false) const;
113
124 meta_range_t as_monotonic() const;
125
127 std::string to_pp_string(void) const;
128};
129
130 typedef meta_range_t gain_range_t;
131 typedef meta_range_t freq_range_t;
132
133} // namespace uhd
uhd::range_t
Definition ranges.hpp:22
uhd::range_t::range_t
range_t(double value=0)
uhd::range_t::operator!=
bool operator!=(const range_t &other) const
Inequality operator.
uhd::range_t::to_pp_string
std::string to_pp_string(void) const
Convert this range to a printable string.
uhd::range_t::stop
double stop(void) const
Get the stop value for this range.
uhd::range_t::start
double start(void) const
Get the start value for this range.
uhd::range_t::range_t
range_t(double start, double stop, double step=0)
uhd::range_t::operator==
bool operator==(const range_t &other) const
Equality operator.
uhd::range_t::step
double step(void) const
Get the step value for this range.
UHD_API
#define UHD_API
Definition config.h:87
config.hpp
std
STL namespace.
uhd
Definition build_info.hpp:12
uhd::freq_range_t
meta_range_t freq_range_t
Definition ranges.hpp:131
uhd::gain_range_t
meta_range_t gain_range_t
Definition ranges.hpp:130
uhd::meta_range_t
Definition ranges.hpp:66
uhd::meta_range_t::stop
double stop(void) const
Get the overall stop value for this meta-range.
uhd::meta_range_t::as_monotonic
meta_range_t as_monotonic() const
uhd::meta_range_t::step
double step(void) const
Get the overall step value for this meta-range.
uhd::meta_range_t::meta_range_t
meta_range_t(InputIterator first, InputIterator last)
Definition ranges.hpp:77
uhd::meta_range_t::to_pp_string
std::string to_pp_string(void) const
Convert this meta-range to a printable string.
uhd::meta_range_t::meta_range_t
meta_range_t(double start, double stop, double step=0)
uhd::meta_range_t::meta_range_t
meta_range_t(void)
A default constructor for an empty meta-range.
uhd::meta_range_t::start
double start(void) const
Get the overall start value for this meta-range.
uhd::meta_range_t::clip
double clip(double value, bool clip_step=false) const