1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
//
// Copyright 2010 Ettus Research LLC
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
#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/shared_ptr.hpp>
#include <boost/function.hpp>
#include <boost/utility.hpp>
#include <vector>
#include <string>
namespace uhd{
/*!
* A set of function to control a gain element.
*/
struct UHD_API gain_fcns_t{
boost::function<gain_range_t(void)> get_range;
boost::function<float(void)> get_value;
boost::function<void(float)> set_value;
};
class UHD_API gain_group : boost::noncopyable{
public:
typedef boost::shared_ptr<gain_group> sptr;
/*!
* Get the gain range for the gain element specified by name.
* For an empty name, get the overall gain range for this group.
* Overall step is defined as the minimum step size.
* \param name name of the gain element (optional)
* \return a gain range with overall min, max, step
*/
virtual gain_range_t get_range(const std::string &name = "") = 0;
/*!
* Get the gain value for the gain element specified by name.
* For an empty name, get the overall gain value for this group.
* \param name name of the gain element (optional)
* \return a gain value of the element or all elements
*/
virtual float get_value(const std::string &name = "") = 0;
/*!
* Set the gain value for the gain element specified by name.
* For an empty name, set the overall gain value for this group.
* The power will be distributed across individual gain elements.
* The semantics of how to do this are determined by the priority.
* \param gain the gain to set for the lement or across the group
* \param name name of the gain element (optional)
*/
virtual void set_value(float gain, const std::string &name = "") = 0;
/*!
* Get a list of names of registered gain elements.
* The names are in the order that they were registered.
* \return a vector of gain name strings
*/
virtual const std::vector<std::string> get_names(void) = 0;
/*!
* Register a set of gain functions into this group:
*
* The name should be a unique and non-empty name.
* Othwerwise, the implementation will rename it.
*
* Priority determines how power will be distributed
* with higher priorities getting the power first,
* and lower priorities getting the remainder power.
*
* \param name the name of the gain element
* \param gain_fcns the set of gain functions
* \param priority the priority of the gain element
*/
virtual void register_fcns(
const std::string &name,
const gain_fcns_t &gain_fcns,
size_t priority = 0
) = 0;
/*!
* Make a new empty gain group.
* \return a gain group object.
*/
static sptr make(void);
};
} //namespace uhd
#endif /* INCLUDED_UHD_UTILS_GAIN_GROUP_HPP */
|
