USRP Hardware Driver and USRP Manual Version: 3.15.0.0-MacPorts-Release
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#ifndef INCLUDED_UHD_TYPES_METADATA_HPP
9#define INCLUDED_UHD_TYPES_METADATA_HPP
10
11#include <uhd/config.hpp>
13#include <stdint.h>
14#include <string>
15
16namespace uhd {
17
24{
27 {
28 reset();
29 }
30
32 void reset()
33 {
34 has_time_spec = false;
36 more_fragments = false;
38 start_of_burst = false;
39 end_of_burst = false;
41 out_of_sequence = false;
42 }
43
46
49
58
65
68
71
110
114
121 std::string to_pp_string(bool compact = true) const;
122
127 std::string strerror(void) const;
128};
129
159
199
200} // namespace uhd
201
202#endif /* INCLUDED_UHD_TYPES_METADATA_HPP */
Definition time_spec.hpp:32
#define UHD_API
Definition config.h:68
Definition build_info.hpp:13
Definition metadata.hpp:164
event_code_t
Definition metadata.hpp:177
@ EVENT_CODE_BURST_ACK
A burst was successfully transmitted.
Definition metadata.hpp:179
@ EVENT_CODE_UNDERFLOW_IN_PACKET
Underflow occurred inside a packet.
Definition metadata.hpp:187
@ EVENT_CODE_SEQ_ERROR
Packet loss between host and device.
Definition metadata.hpp:183
@ EVENT_CODE_UNDERFLOW
An internal send buffer has emptied.
Definition metadata.hpp:181
@ EVENT_CODE_TIME_ERROR
Packet had time that was late.
Definition metadata.hpp:185
@ EVENT_CODE_USER_PAYLOAD
Some kind of custom user payload.
Definition metadata.hpp:191
@ EVENT_CODE_SEQ_ERROR_IN_BURST
Packet loss within a burst.
Definition metadata.hpp:189
bool has_time_spec
Has time specification?
Definition metadata.hpp:169
uint32_t user_payload[4]
Definition metadata.hpp:197
size_t channel
The channel number in a mimo configuration.
Definition metadata.hpp:166
time_spec_t time_spec
When the async event occurred.
Definition metadata.hpp:172
rx_metadata_t()
Default constructor.
Definition metadata.hpp:26
bool more_fragments
Definition metadata.hpp:57
time_spec_t time_spec
Time of the first sample.
Definition metadata.hpp:48
bool out_of_sequence
Definition metadata.hpp:113
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:70
bool has_time_spec
Has time specification?
Definition metadata.hpp:45
std::string to_pp_string(bool compact=true) const
void reset()
Reset values.
Definition metadata.hpp:32
bool start_of_burst
Start of burst will be true for the first packet in the chain.
Definition metadata.hpp:67
enum uhd::rx_metadata_t::error_code_t error_code
error_code_t
Definition metadata.hpp:86
@ ERROR_CODE_LATE_COMMAND
A stream command was issued in the past.
Definition metadata.hpp:92
@ ERROR_CODE_BROKEN_CHAIN
Expected another stream command.
Definition metadata.hpp:94
@ ERROR_CODE_ALIGNMENT
Multi-channel alignment failed.
Definition metadata.hpp:106
@ ERROR_CODE_NONE
No error associated with this metadata.
Definition metadata.hpp:88
@ ERROR_CODE_BAD_PACKET
The packet could not be parsed.
Definition metadata.hpp:108
@ ERROR_CODE_TIMEOUT
No packet received, implementation timed-out.
Definition metadata.hpp:90
@ ERROR_CODE_OVERFLOW
Definition metadata.hpp:104
size_t fragment_offset
Definition metadata.hpp:64
bool end_of_burst
Set end of burst to true for the last packet in the chain.
Definition metadata.hpp:151
bool start_of_burst
Set start of burst to true for the first packet in the chain.
Definition metadata.hpp:148
time_spec_t time_spec
When to send the first sample.
Definition metadata.hpp:145
bool has_time_spec
Definition metadata.hpp:142