ranges.hpp

Go to the documentation of this file.

//
// Copyright 2010-2012 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
 
#pragma once
 
#include <uhd/config.hpp>
#include <initializer_list>
#include <type_traits>
#include <string>
#include <vector>
 
namespace uhd {

class UHD_API range_t
{
public:
    range_t(double value = 0);

    range_t(double start, double stop, double step = 0);

    double start(void) const;

    double stop(void) const;

    double step(void) const;

    std::string to_pp_string(void) const;

    bool operator==(const range_t& other) const;

    bool operator!=(const range_t& other) const;
 
private:
    double _start, _stop, _step;
};

struct UHD_API meta_range_t : public std::vector<range_t>
{
    meta_range_t(void);

    template <typename InputIterator>
    meta_range_t(InputIterator first, InputIterator last)
        : std::vector<range_t>(first, last)
    { /* NOP */
        // This is to avoid people accidentally doing silly things like:
        // meta_range_t(0, 0)
        // which probably was supposed to call meta_range_t(double, double, double)
        // but actually calls this constructor.
        static_assert(!std::is_integral<typename std::decay<InputIterator>::type>::value,
            "You can't pass integers to meta_range_t's constructor!");
    }

    //
    // For backward-compatibility reasons, we allow the user to initialize
    // a range like this:
    // ```cpp
    // meta_range_t r1{0.0, 2.0};
    // // Same as:
    // meta_range_t r2(0.0, 2.0);
    // ```
    // Note that for longer initializer lists, this creates a list of ranges:
    // ```cpp
    // meta_range_t r1{0.0, 1.0, 2.0, 3.0};
    // // Same as:
    // meta_range_t r2{range_t(0.0), range_t(1.0), range_t(2.0), range_t(3.0)};
    // ```
    meta_range_t(std::initializer_list<double> il);

    //
    // This can be used to create a meta_range_t object from a list of ranges
    // by using initializer list notation:
    // ```cpp
    // meta_range_t mr{range_t(0.0, 1.0), range_t(2.0), range_t(3.0, 4.0)};
    // ```
    //
    // A double-braced initializer list is also allowed, but is only recommended
    // when it is really clear what is meant:
    // ```cpp
    // meta_range_t mr{{0.0, 1.0}, range_t(2.0), {3.0, 4.0}};
    // ```
    meta_range_t(std::initializer_list<range_t> il) : std::vector<range_t>(il)
    {
        /* NOP */
    }

    meta_range_t(double start, double stop, double step = 0);

    double start(void) const;

    double stop(void) const;

    double step(void) const;

    double clip(double value, bool clip_step = false) const;

    meta_range_t as_monotonic() const;

    std::string to_pp_string(void) const;
};
 
typedef meta_range_t gain_range_t;
typedef meta_range_t freq_range_t;
 
} // namespace uhd