UHD 003.002.000

include/uhd/utils/gain_group.hpp

Go to the documentation of this file.
00001 //
00002 // Copyright 2010-2011 Ettus Research LLC
00003 //
00004 // This program is free software: you can redistribute it and/or modify
00005 // it under the terms of the GNU General Public License as published by
00006 // the Free Software Foundation, either version 3 of the License, or
00007 // (at your option) any later version.
00008 //
00009 // This program is distributed in the hope that it will be useful,
00010 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00011 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012 // GNU General Public License for more details.
00013 //
00014 // You should have received a copy of the GNU General Public License
00015 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
00016 //
00017 
00018 #ifndef INCLUDED_UHD_UTILS_GAIN_GROUP_HPP
00019 #define INCLUDED_UHD_UTILS_GAIN_GROUP_HPP
00020 
00021 #include <uhd/config.hpp>
00022 #include <uhd/types/ranges.hpp>
00023 #include <boost/shared_ptr.hpp>
00024 #include <boost/function.hpp>
00025 #include <boost/utility.hpp>
00026 #include <vector>
00027 #include <string>
00028 
00029 namespace uhd{
00030 
00034 struct UHD_API gain_fcns_t{
00035     boost::function<gain_range_t(void)> get_range;
00036     boost::function<double(void)>        get_value;
00037     boost::function<void(double)>        set_value;
00038 };
00039 
00040 class UHD_API gain_group : boost::noncopyable{
00041 public:
00042     typedef boost::shared_ptr<gain_group> sptr;
00043 
00051     virtual gain_range_t get_range(const std::string &name = "") = 0;
00052 
00059     virtual double get_value(const std::string &name = "") = 0;
00060 
00069     virtual void set_value(double gain, const std::string &name = "") = 0;
00070 
00076     virtual const std::vector<std::string> get_names(void) = 0;
00077 
00092     virtual void register_fcns(
00093         const std::string &name,
00094         const gain_fcns_t &gain_fcns,
00095         size_t priority = 0
00096     ) = 0;
00097 
00102     static sptr make(void);
00103 };
00104 
00105 } //namespace uhd
00106 
00107 #endif /* INCLUDED_UHD_UTILS_GAIN_GROUP_HPP */
00108 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines