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
//

#ifndef INCLUDED_UHD_TYPES_RANGES_HPP
#define INCLUDED_UHD_TYPES_RANGES_HPP

#include <uhd/config.hpp>
#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;

        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 : 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 */ }

        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;

        const std::string to_pp_string(void) const;

    };

    typedef meta_range_t gain_range_t;
    typedef meta_range_t freq_range_t;

} //namespace uhd

#endif /* INCLUDED_UHD_TYPES_RANGES_HPP */