USRP Hardware Driver and USRP Manual  Version: 4.3.0.0-31-g8cb669977
UHD and USRP Manual
convert.hpp
Go to the documentation of this file.
1 //
2 // Copyright 2011-2012,2014 Ettus Research LLC
3 // Copyright 2018 Ettus Research, a National Instruments Company
4 //
5 // SPDX-License-Identifier: GPL-3.0-or-later
6 //
7 
8 #pragma once
9 
10 #include <uhd/config.hpp>
11 #include <uhd/types/ref_vector.hpp>
12 #include <boost/operators.hpp>
13 #include <functional>
14 #include <memory>
15 #include <string>
16 
17 namespace uhd { namespace convert {
18 
20 class converter
21 {
22 public:
23  typedef std::shared_ptr<converter> sptr;
26 
27  virtual ~converter(void) = 0;
28 
30  virtual void set_scalar(const double) = 0;
31 
33  UHD_INLINE void conv(const input_type& in, const output_type& out, const size_t num)
34  {
35  if (num != 0)
36  (*this)(in, out, num);
37  }
38 
39 private:
41  //
42  // This is the guts of the converter. When deriving new converter types,
43  // this is where the actual conversion routines go.
44  //
45  // \param in Pointers to the input buffers
46  // \param out Pointers to the output buffers
47  // \param num Number of items in the input buffers to convert
48  virtual void operator()(
49  const input_type& in, const output_type& out, const size_t num) = 0;
50 };
51 
53 typedef std::function<converter::sptr(void)> function_type;
54 
56 typedef int priority_type;
57 
59 struct UHD_API id_type : boost::equality_comparable<id_type>
60 {
61  std::string input_format;
62  size_t num_inputs;
63  std::string output_format;
64  size_t num_outputs;
65  std::string to_pp_string(void) const;
66  std::string to_string(void) const;
67 };
68 
70 UHD_API bool operator==(const id_type&, const id_type&);
71 
82  const id_type& id, const function_type& fcn, const priority_type prio);
83 
90 UHD_API function_type get_converter(const id_type& id, const priority_type prio = -1);
91 
97 UHD_API void register_bytes_per_item(const std::string& format, const size_t size);
98 
100 UHD_API size_t get_bytes_per_item(const std::string& format);
101 
102 }} // namespace uhd::convert
UHD_API function_type get_converter(const id_type &id, const priority_type prio=-1)
Identify a conversion routine in the registry.
Definition: convert.hpp:59
UHD_API void register_bytes_per_item(const std::string &format, const size_t size)
std::shared_ptr< converter > sptr
Definition: convert.hpp:23
virtual void set_scalar(const double)=0
Set the scale factor (used in floating point conversions)
UHD_API size_t get_bytes_per_item(const std::string &format)
Convert an item format to a size in bytes.
UHD_API bool operator==(const id_type &, const id_type &)
Implement equality_comparable interface.
std::function< converter::sptr(void)> function_type
Conversion factory function typedef.
Definition: convert.hpp:53
A conversion class that implements a conversion from inputs -> outputs.
Definition: convert.hpp:20
std::string output_format
Definition: convert.hpp:63
Definition: build_info.hpp:12
UHD_INLINE void conv(const input_type &in, const output_type &out, const size_t num)
The public conversion method to convert inputs -> outputs.
Definition: convert.hpp:33
Definition: ref_vector.hpp:21
uhd::ref_vector< const void * > input_type
Definition: convert.hpp:25
#define UHD_INLINE
Definition: config.h:65
int priority_type
Priority of conversion routines.
Definition: convert.hpp:56
virtual ~converter(void)=0
#define UHD_API
Definition: config.h:87
size_t num_inputs
Definition: convert.hpp:62
UHD_API void register_converter(const id_type &id, const function_type &fcn, const priority_type prio)
uhd::ref_vector< void * > output_type
Definition: convert.hpp:24
size_t num_outputs
Definition: convert.hpp:64
std::string input_format
Definition: convert.hpp:61