USRP Hardware Driver and USRP Manual  Version: 20250415.0.git50967d13.el9
UHD and USRP Manual
actions.hpp
Go to the documentation of this file.
1 //
2 // Copyright 2019 Ettus Research, a National Instruments Brand
3 //
4 // SPDX-License-Identifier: GPL-3.0-or-later
5 //
6 
7 #pragma once
8 
9 #include <uhd/config.hpp>
11 #include <uhd/types/metadata.hpp>
12 #include <uhd/types/ranges.hpp>
13 #include <uhd/types/stream_cmd.hpp>
14 #include <uhd/types/time_spec.hpp>
17 #include <boost/optional.hpp>
18 #include <cstddef>
19 #include <cstdint>
20 #include <memory>
21 #include <string>
22 #include <vector>
23 
24 namespace uhd { namespace rfnoc {
25 
34 {
35 public:
36  virtual ~action_info() {}
37 
38  using sptr = std::shared_ptr<action_info>;
40  const size_t id;
42  std::string key;
44  // (de-)serialize it.
45  std::vector<uint8_t> payload;
48 
50  static sptr make(const std::string& key = "",
51  const uhd::device_addr_t& args = uhd::device_addr_t(""));
52 
53 protected:
55  const std::string& key, const uhd::device_addr_t& args = uhd::device_addr_t(""));
56 };
57 
59 {
60 public:
61  using sptr = std::shared_ptr<stream_cmd_action_info>;
62 
64 
66  static sptr make(const uhd::stream_cmd_t::stream_mode_t stream_mode);
67 
68 private:
70 };
71 
73 {
74 public:
75  using sptr = std::shared_ptr<rx_event_action_info>;
76 
79 
82 
83 protected:
85 };
86 
88 {
89 public:
90  using sptr = std::shared_ptr<tx_event_action_info>;
91 
94 
96  bool has_tsf;
97 
99  uint64_t tsf;
100 
103  const boost::optional<uint64_t>& tsf);
104 
105 protected:
107  const boost::optional<uint64_t>& tsf);
108 };
109 
112 {
113 public:
114  using sptr = std::shared_ptr<tune_request_action_info>;
115 
123  static sptr make(const uhd::tune_request_t tune_request);
124 
125 private:
126  tune_request_action_info(const uhd::tune_request_t tune_request);
127 };
128 
129 }} /* namespace uhd::rfnoc */
Definition: device_addr.hpp:39
Definition: time_spec.hpp:31
#define UHD_API
Definition: config.h:87
Definition: build_info.hpp:12
event_code_t
Definition: metadata.hpp:216
Definition: ranges.hpp:66
Definition: actions.hpp:34
std::vector< uint8_t > payload
An arbitrary payload. It is up to consumers and producers to.
Definition: actions.hpp:45
std::string key
A string identifier for this action.
Definition: actions.hpp:42
virtual ~action_info()
Definition: actions.hpp:36
const size_t id
A unique counter for this action.
Definition: actions.hpp:40
action_info(const std::string &key, const uhd::device_addr_t &args=uhd::device_addr_t(""))
std::shared_ptr< action_info > sptr
Definition: actions.hpp:38
static sptr make(const std::string &key="", const uhd::device_addr_t &args=uhd::device_addr_t(""))
Factory function.
uhd::device_addr_t args
A dictionary of key-value pairs. May be used as desired.
Definition: actions.hpp:47
Definition: actions.hpp:73
static sptr make(uhd::rx_metadata_t::error_code_t error_code)
Factory function.
rx_event_action_info(uhd::rx_metadata_t::error_code_t error_code)
uhd::rx_metadata_t::error_code_t error_code
The error code that describes the event.
Definition: actions.hpp:78
Definition: actions.hpp:59
static sptr make(const uhd::stream_cmd_t::stream_mode_t stream_mode)
Factory function.
uhd::stream_cmd_t stream_cmd
Definition: actions.hpp:63
Action object for graph-based tuning.
Definition: actions.hpp:112
static sptr make(const uhd::tune_request_t tune_request)
Factory function.
uhd::freq_range_t overall_freq_range
Definition: actions.hpp:121
uhd::tune_request_t tune_request
Definition: actions.hpp:116
uhd::time_spec_t time_spec
Definition: actions.hpp:117
uhd::freq_range_t rf_range
Definition: actions.hpp:120
uhd::tune_result_t tune_result
Definition: actions.hpp:118
uhd::freq_range_t dsp_range
Definition: actions.hpp:119
Definition: actions.hpp:88
uint64_t tsf
When the async event occurred.
Definition: actions.hpp:99
tx_event_action_info(uhd::async_metadata_t::event_code_t event_code, const boost::optional< uint64_t > &tsf)
static sptr make(uhd::async_metadata_t::event_code_t event_code, const boost::optional< uint64_t > &tsf)
Factory function.
bool has_tsf
Has time specification?
Definition: actions.hpp:96
uhd::async_metadata_t::event_code_t event_code
The event code that describes the event.
Definition: actions.hpp:93
error_code_t
Definition: metadata.hpp:113
Definition: stream_cmd.hpp:40
stream_mode_t
Definition: stream_cmd.hpp:41
Definition: tune_request.hpp:25
Definition: tune_result.hpp:19