USRP Hardware Driver and USRP Manual  Version: 4.8.0.0
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 <cstddef>
14 #include <functional>
15 #include <memory>
16 #include <string>
17 
18 namespace uhd { namespace convert {
19 
21 class converter
22 {
23 public:
24  typedef std::shared_ptr<converter> sptr;
27 
28  virtual ~converter(void) = 0;
29 
31  virtual void set_scalar(const double) = 0;
32 
34  UHD_INLINE void conv(const input_type& in, const output_type& out, const size_t num)
35  {
36  if (num != 0)
37  (*this)(in, out, num);
38  }
39 
40 private:
42  //
43  // This is the guts of the converter. When deriving new converter types,
44  // this is where the actual conversion routines go.
45  //
46  // \param in Pointers to the input buffers
47  // \param out Pointers to the output buffers
48  // \param num Number of items in the input buffers to convert
49  virtual void operator()(
50  const input_type& in, const output_type& out, const size_t num) = 0;
51 };
52 
54 typedef std::function<converter::sptr(void)> function_type;
55 
57 typedef int priority_type;
58 
60 struct UHD_API id_type : boost::equality_comparable<id_type>
61 {
62  std::string input_format;
63  size_t num_inputs;
64  std::string output_format;
65  size_t num_outputs;
66  std::string to_pp_string(void) const;
67  std::string to_string(void) const;
68 };
69 
71 UHD_API bool operator==(const id_type&, const id_type&);
72 
83  const id_type& id, const function_type& fcn, const priority_type prio);
84 
91 UHD_API function_type get_converter(const id_type& id, const priority_type prio = -1);
92 
98 UHD_API void register_bytes_per_item(const std::string& format, const size_t size);
99 
101 UHD_API size_t get_bytes_per_item(const std::string& format);
102 
103 }} // namespace uhd::convert
uhd::convert::function_type
std::function< converter::sptr(void)> function_type
Conversion factory function typedef.
Definition: convert.hpp:54
uhd::convert::priority_type
int priority_type
Priority of conversion routines.
Definition: convert.hpp:57
uhd::convert::id_type
Identify a conversion routine in the registry.
Definition: convert.hpp:60
config.hpp
uhd::convert::get_converter
UHD_API function_type get_converter(const id_type &id, const priority_type prio=-1)
uhd::convert::register_bytes_per_item
UHD_API void register_bytes_per_item(const std::string &format, const size_t size)
uhd::convert::id_type::input_format
std::string input_format
Definition: convert.hpp:62
uhd::convert::converter::set_scalar
virtual void set_scalar(const double)=0
Set the scale factor (used in floating point conversions)
uhd::convert::id_type::num_inputs
size_t num_inputs
Definition: convert.hpp:63
uhd::convert::converter::output_type
uhd::ref_vector< void * > output_type
Definition: convert.hpp:25
uhd::convert::converter::conv
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:34
UHD_INLINE
#define UHD_INLINE
Definition: config.h:65
UHD_API
#define UHD_API
Definition: config.h:87
uhd::convert::id_type::output_format
std::string output_format
Definition: convert.hpp:64
ref_vector.hpp
uhd::convert::converter::~converter
virtual ~converter(void)=0
uhd
Definition: build_info.hpp:12
uhd::convert::converter
A conversion class that implements a conversion from inputs -> outputs.
Definition: convert.hpp:21
uhd::convert::register_converter
UHD_API void register_converter(const id_type &id, const function_type &fcn, const priority_type prio)
uhd::convert::converter::sptr
std::shared_ptr< converter > sptr
Definition: convert.hpp:24
uhd::convert::operator==
UHD_API bool operator==(const id_type &, const id_type &)
Implement equality_comparable interface.
uhd::convert::id_type::num_outputs
size_t num_outputs
Definition: convert.hpp:65
uhd::convert::converter::input_type
uhd::ref_vector< const void * > input_type
Definition: convert.hpp:26
uhd::ref_vector
Definition: ref_vector.hpp:21
uhd::convert::get_bytes_per_item
UHD_API size_t get_bytes_per_item(const std::string &format)
Convert an item format to a size in bytes.