USRP Hardware Driver and USRP Manual Version: 20250528.0.gitc354764c.fc42
UHD and USRP Manual
 
Loading...
Searching...
No Matches
metadata.hpp
Go to the documentation of this file.
1//
2// Copyright 2010-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>
12#include <stdint.h>
13#include <string>
14
15namespace uhd {
16
23{
26 {
27 reset();
28 }
29
31 void reset()
32 {
33 has_time_spec = false;
35 more_fragments = false;
37 start_of_burst = false;
38 end_of_burst = false;
39 eov_positions = nullptr;
43 out_of_sequence = false;
44 }
45
48
51
60
67
70
73
92
98
137
141
148 std::string to_pp_string(bool compact = true) const;
149
154 std::string strerror(void) const;
155};
156
163{
170
173
176
179
189 size_t* eov_positions = nullptr;
191
197};
198
238
239} // namespace uhd
Definition time_spec.hpp:31
#define UHD_API
Definition config.h:87
Definition build_info.hpp:12
Definition metadata.hpp:203
event_code_t
Definition metadata.hpp:216
@ EVENT_CODE_BURST_ACK
A burst was successfully transmitted.
Definition metadata.hpp:218
@ EVENT_CODE_UNDERFLOW_IN_PACKET
Underflow occurred inside a packet.
Definition metadata.hpp:226
@ EVENT_CODE_SEQ_ERROR
Packet loss between host and device.
Definition metadata.hpp:222
@ EVENT_CODE_UNDERFLOW
An internal send buffer has emptied.
Definition metadata.hpp:220
@ EVENT_CODE_TIME_ERROR
Packet had time that was late.
Definition metadata.hpp:224
@ EVENT_CODE_USER_PAYLOAD
Some kind of custom user payload.
Definition metadata.hpp:230
@ EVENT_CODE_SEQ_ERROR_IN_BURST
Packet loss within a burst.
Definition metadata.hpp:228
bool has_time_spec
Has time specification?
Definition metadata.hpp:208
uint32_t user_payload[4]
Definition metadata.hpp:236
size_t channel
The channel number in a mimo configuration.
Definition metadata.hpp:205
time_spec_t time_spec
When the async event occurred.
Definition metadata.hpp:211
rx_metadata_t()
Default constructor.
Definition metadata.hpp:25
bool more_fragments
Definition metadata.hpp:59
time_spec_t time_spec
Time of the first sample.
Definition metadata.hpp:50
bool out_of_sequence
Definition metadata.hpp:140
std::string strerror(void) const
bool end_of_burst
End of burst will be true for the last packet in the chain.
Definition metadata.hpp:72
bool has_time_spec
Has time specification?
Definition metadata.hpp:47
std::string to_pp_string(bool compact=true) const
void reset()
Reset values.
Definition metadata.hpp:31
size_t * eov_positions
Definition metadata.hpp:90
bool start_of_burst
Start of burst will be true for the first packet in the chain.
Definition metadata.hpp:69
size_t eov_positions_size
Definition metadata.hpp:91
enum uhd::rx_metadata_t::error_code_t error_code
error_code_t
Definition metadata.hpp:113
@ ERROR_CODE_LATE_COMMAND
A stream command was issued in the past.
Definition metadata.hpp:119
@ ERROR_CODE_BROKEN_CHAIN
Expected another stream command.
Definition metadata.hpp:121
@ ERROR_CODE_ALIGNMENT
Multi-channel alignment failed.
Definition metadata.hpp:133
@ ERROR_CODE_NONE
No error associated with this metadata.
Definition metadata.hpp:115
@ ERROR_CODE_BAD_PACKET
The packet could not be parsed.
Definition metadata.hpp:135
@ ERROR_CODE_TIMEOUT
No packet received, implementation timed-out.
Definition metadata.hpp:117
@ ERROR_CODE_OVERFLOW
Definition metadata.hpp:131
size_t eov_positions_count
Definition metadata.hpp:97
size_t fragment_offset
Definition metadata.hpp:66
bool end_of_burst
Set end of burst to true for the last packet in the chain.
Definition metadata.hpp:178
size_t eov_positions_size
Definition metadata.hpp:190
bool start_of_burst
Set start of burst to true for the first packet in the chain.
Definition metadata.hpp:175
time_spec_t time_spec
When to send the first sample.
Definition metadata.hpp:172
size_t * eov_positions
Definition metadata.hpp:189
bool has_time_spec
Definition metadata.hpp:169