gain_group.hpp

Go to the documentation of this file.

//
// Copyright 2010-2011,2014 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#ifndef INCLUDED_UHD_UTILS_GAIN_GROUP_HPP
#define INCLUDED_UHD_UTILS_GAIN_GROUP_HPP

#include <uhd/config.hpp>
#include <uhd/types/ranges.hpp>
#include <boost/function.hpp>
#include <boost/shared_ptr.hpp>
#include <uhd/utils/noncopyable.hpp>
#include <string>
#include <vector>

namespace uhd {

struct UHD_API gain_fcns_t
{
    boost::function<gain_range_t(void)> get_range;
    boost::function<double(void)> get_value;
    boost::function<void(double)> set_value;
};

class UHD_API gain_group : uhd::noncopyable
{
public:
    typedef boost::shared_ptr<gain_group> sptr;

    virtual ~gain_group(void) = 0;

    virtual gain_range_t get_range(const std::string& name = "") = 0;

    virtual double get_value(const std::string& name = "") = 0;

    virtual void set_value(double gain, const std::string& name = "") = 0;

    virtual const std::vector<std::string> get_names(void) = 0;

    virtual void register_fcns(
        const std::string& name, const gain_fcns_t& gain_fcns, size_t priority = 0) = 0;

    static sptr make(void);
};

} // namespace uhd

#endif /* INCLUDED_UHD_UTILS_GAIN_GROUP_HPP */