USRP Hardware Driver and USRP Manual  Version: 4.1.0.0-201-gb49e4f1eb
UHD and USRP Manual
uhd::rfnoc::chdr::strs_payload Class Reference

#include <uhd/rfnoc/chdr_types.hpp>

Public Member Functions

 strs_payload ()=default
 
 strs_payload (const strs_payload &rhs)=default
 
 strs_payload (strs_payload &&rhs)=default
 
strs_payloadoperator= (const strs_payload &rhs)=default
 
void populate_header (chdr_header &header) const
 Populate the header for this type of packet. More...
 
size_t serialize (uint64_t *buff, size_t max_size_bytes, const std::function< uint64_t(uint64_t)> &conv_byte_order) const
 Serialize the payload to a uint64_t buffer. More...
 
template<endianness_t endianness>
size_t serialize (uint64_t *buff, size_t max_size_bytes) const
 Serialize the payload to a uint64_t buffer (no conversion function) More...
 
void deserialize (const uint64_t *buff, size_t buff_size, const std::function< uint64_t(uint64_t)> &conv_byte_order)
 
template<endianness_t endianness>
void deserialize (const uint64_t *buff, size_t buff_size)
 
size_t get_length () const
 Get the serialized size of this payload in 64 bit words. More...
 
bool operator== (const strs_payload &rhs) const
 Comparison operator (==) More...
 
bool operator!= (const strs_payload &rhs) const
 Comparison operator (!=) More...
 
const std::string to_string () const
 Return a string representation of this object. More...
 

Public Attributes

uint16_t src_epid = 0
 The source EPID for the stream (16 bits) More...
 
strs_status_t status = STRS_OKAY
 The status of the stream (4 bits) More...
 
uint64_t capacity_bytes = 0
 Buffer capacity in bytes (40 bits) More...
 
uint32_t capacity_pkts = 0
 Buffer capacity in packets (24 bits) More...
 
uint64_t xfer_count_bytes = 0
 Transfer count in bytes (64 bits) More...
 
uint64_t xfer_count_pkts = 0
 Transfer count in packets (40 bits) More...
 
uint16_t buff_info = 0
 Buffer info (16 bits) More...
 
uint64_t status_info = 0
 Extended status info (48 bits) More...
 

Constructor & Destructor Documentation

◆ strs_payload() [1/3]

uhd::rfnoc::chdr::strs_payload::strs_payload ( )
default

◆ strs_payload() [2/3]

uhd::rfnoc::chdr::strs_payload::strs_payload ( const strs_payload rhs)
default

◆ strs_payload() [3/3]

uhd::rfnoc::chdr::strs_payload::strs_payload ( strs_payload &&  rhs)
default

Member Function Documentation

◆ deserialize() [1/2]

void uhd::rfnoc::chdr::strs_payload::deserialize ( const uint64_t *  buff,
size_t  buff_size,
const std::function< uint64_t(uint64_t)> &  conv_byte_order 
)

Deserialize the payload from a uint64_t buffer

Parameters
buffBuffer to deserialize the payload from
buff_sizeNumber of elements in the buffer
conv_byte_orderByte order converter function (buffer to host endianness)

◆ deserialize() [2/2]

template<endianness_t endianness>
void uhd::rfnoc::chdr::strs_payload::deserialize ( const uint64_t *  buff,
size_t  buff_size 
)
inline

Deserialize the payload from a uint64_t buffer (no conversion function)

Parameters
buffBuffer to deserialize the payload from
buff_sizeNumber of elements in the buffer

◆ get_length()

size_t uhd::rfnoc::chdr::strs_payload::get_length ( ) const

Get the serialized size of this payload in 64 bit words.

◆ operator!=()

bool uhd::rfnoc::chdr::strs_payload::operator!= ( const strs_payload rhs) const
inline

Comparison operator (!=)

◆ operator=()

strs_payload& uhd::rfnoc::chdr::strs_payload::operator= ( const strs_payload rhs)
default

◆ operator==()

bool uhd::rfnoc::chdr::strs_payload::operator== ( const strs_payload rhs) const

Comparison operator (==)

◆ populate_header()

void uhd::rfnoc::chdr::strs_payload::populate_header ( chdr_header header) const

Populate the header for this type of packet.

◆ serialize() [1/2]

size_t uhd::rfnoc::chdr::strs_payload::serialize ( uint64_t *  buff,
size_t  max_size_bytes,
const std::function< uint64_t(uint64_t)> &  conv_byte_order 
) const

Serialize the payload to a uint64_t buffer.

◆ serialize() [2/2]

template<endianness_t endianness>
size_t uhd::rfnoc::chdr::strs_payload::serialize ( uint64_t *  buff,
size_t  max_size_bytes 
) const
inline

Serialize the payload to a uint64_t buffer (no conversion function)

◆ to_string()

const std::string uhd::rfnoc::chdr::strs_payload::to_string ( ) const

Return a string representation of this object.

Member Data Documentation

◆ buff_info

uint16_t uhd::rfnoc::chdr::strs_payload::buff_info = 0

Buffer info (16 bits)

◆ capacity_bytes

uint64_t uhd::rfnoc::chdr::strs_payload::capacity_bytes = 0

Buffer capacity in bytes (40 bits)

◆ capacity_pkts

uint32_t uhd::rfnoc::chdr::strs_payload::capacity_pkts = 0

Buffer capacity in packets (24 bits)

◆ src_epid

uint16_t uhd::rfnoc::chdr::strs_payload::src_epid = 0

The source EPID for the stream (16 bits)

◆ status

strs_status_t uhd::rfnoc::chdr::strs_payload::status = STRS_OKAY

The status of the stream (4 bits)

◆ status_info

uint64_t uhd::rfnoc::chdr::strs_payload::status_info = 0

Extended status info (48 bits)

◆ xfer_count_bytes

uint64_t uhd::rfnoc::chdr::strs_payload::xfer_count_bytes = 0

Transfer count in bytes (64 bits)

◆ xfer_count_pkts

uint64_t uhd::rfnoc::chdr::strs_payload::xfer_count_pkts = 0

Transfer count in packets (40 bits)


The documentation for this class was generated from the following file: