USRP Hardware Driver and USRP Manual  Version: 003.008.003-release
UHD and USRP Manual
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
convert.hpp
Go to the documentation of this file.
1 //
2 // Copyright 2011-2012,2014 Ettus Research LLC
3 //
4 // This program is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program. If not, see <http://www.gnu.org/licenses/>.
16 //
17 
18 #ifndef INCLUDED_UHD_CONVERT_HPP
19 #define INCLUDED_UHD_CONVERT_HPP
20 
21 #include <uhd/config.hpp>
22 #include <uhd/types/ref_vector.hpp>
23 #include <boost/shared_ptr.hpp>
24 #include <boost/function.hpp>
25 #include <boost/operators.hpp>
26 #include <string>
27 
28 namespace uhd{ namespace convert{
29 
31  class converter{
32  public:
33  typedef boost::shared_ptr<converter> sptr;
36 
37  virtual ~converter(void) = 0;
38 
40  virtual void set_scalar(const double) = 0;
41 
43  UHD_INLINE void conv(const input_type &in, const output_type &out, const size_t num){
44  if (num != 0) (*this)(in, out, num);
45  }
46 
47  private:
49  //
50  // This is the guts of the converter. When deriving new converter types,
51  // this is where the actual conversion routines go.
52  //
53  // \param in Pointers to the input buffers
54  // \param out Pointers to the output buffers
55  // \param num Number of items in the input buffers to convert
56  virtual void operator()(const input_type& in, const output_type& out, const size_t num) = 0;
57  };
58 
60  typedef boost::function<converter::sptr(void)> function_type;
61 
63  typedef int priority_type;
64 
66  struct id_type : boost::equality_comparable<id_type>{
67  std::string input_format;
68  size_t num_inputs;
69  std::string output_format;
70  size_t num_outputs;
71  std::string to_pp_string(void) const;
72  };
73 
75  UHD_API bool operator==(const id_type &, const id_type &);
76 
87  const id_type &id,
88  const function_type &fcn,
89  const priority_type prio
90  );
91 
99  const id_type &id,
100  const priority_type prio = -1
101  );
102 
109  const std::string &format, const size_t size
110  );
111 
113  UHD_API size_t get_bytes_per_item(const std::string &format);
114 
115 }} //namespace
116 
117 #endif /* INCLUDED_UHD_CONVERT_HPP */