USRP Hardware Driver and USRP Manual  Version: 4.1.0.4-3
UHD and USRP Manual
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 <string>
12 #include <type_traits>
13 #include <vector>
14 
15 namespace uhd {
16 
22 {
23 public:
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  const 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 
58 private:
59  double _start, _stop, _step;
60 };
61 
65 struct UHD_API meta_range_t : 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(
85  !std::is_integral<typename std::decay<InputIterator>::type>::value,
86  "You can't pass integers to meta_range_t's constructor!"
87  );
88  }
89 
97  meta_range_t(double start, double stop, double step = 0);
98 
100  double start(void) const;
101 
103  double stop(void) const;
104 
106  double step(void) const;
107 
114  double clip(double value, bool clip_step = false) const;
115 
117  const std::string to_pp_string(void) const;
118 };
119 
122 
123 } // namespace uhd
Definition: ranges.hpp:22
range_t(double value=0)
bool operator!=(const range_t &other) const
Inequality operator.
const std::string to_pp_string(void) const
Convert this range to a printable string.
double stop(void) const
Get the stop value for this range.
double start(void) const
Get the start value for this range.
range_t(double start, double stop, double step=0)
bool operator==(const range_t &other) const
Equality operator.
double step(void) const
Get the step value for this range.
#define UHD_API
Definition: config.h:70
Definition: build_info.hpp:12
meta_range_t freq_range_t
Definition: ranges.hpp:121
meta_range_t gain_range_t
Definition: ranges.hpp:120
Definition: ranges.hpp:66
double stop(void) const
Get the overall stop value for this meta-range.
double step(void) const
Get the overall step value for this meta-range.
meta_range_t(InputIterator first, InputIterator last)
Definition: ranges.hpp:77
meta_range_t(double start, double stop, double step=0)
meta_range_t(void)
A default constructor for an empty meta-range.
double start(void) const
Get the overall start value for this meta-range.
const std::string to_pp_string(void) const
Convert this meta-range to a printable string.
double clip(double value, bool clip_step=false) const