#include <uhd/rfnoc/stream_sig.hpp>

Public Member Functions
	stream_sig_t ()

std::string	to_string ()
	Compact string representation. More...

std::string	to_pp_string ()
	Pretty-print string representation. More...

size_t	get_bytes_per_item () const
	Returns the number of bytes necessary to store one item. More...

Static Public Member Functions
static bool	is_compatible (const stream_sig_t &output_sig, const stream_sig_t &input_sig)

Public Attributes
std::string	item_type
	The data type of the individual items (e.g. 'sc16'). If undefined, set. More...

size_t	vlen
	The vector length in multiples of items. If undefined, set to zero. More...

size_t	packet_size
	Packet size in bytes. If undefined, set to zero. More...

bool	is_bursty

Detailed Description

Describes a stream signature for data going to or coming from RFNoC ports.

The stream signature may depend on a block's configuration. Even so, some attributes may be left undefined (e.g., a FIFO block works for any item type, so it doesn't need to set it).

Constructor & Destructor Documentation

◆ stream_sig_t()

uhd::rfnoc::stream_sig_t::stream_sig_t ( )

Member Function Documentation

◆ get_bytes_per_item()

size_t uhd::rfnoc::stream_sig_t::get_bytes_per_item ( ) const

Returns the number of bytes necessary to store one item.

◆ is_compatible()

static bool uhd::rfnoc::stream_sig_t::is_compatible	(	const stream_sig_t &	output_sig,
		const stream_sig_t &	input_sig
	)

static

Check if an output with signature output_sig could stream to an input signature input_sig.

Returns: true if streams are compatible

◆ to_pp_string()

std::string uhd::rfnoc::stream_sig_t::to_pp_string ( )

Pretty-print string representation.

◆ to_string()

std::string uhd::rfnoc::stream_sig_t::to_string ( )

Compact string representation.

Member Data Documentation

◆ is_bursty

bool uhd::rfnoc::stream_sig_t::is_bursty

◆ item_type

std::string uhd::rfnoc::stream_sig_t::item_type

The data type of the individual items (e.g. 'sc16'). If undefined, set.

◆ packet_size

size_t uhd::rfnoc::stream_sig_t::packet_size

Packet size in bytes. If undefined, set to zero.

◆ vlen

size_t uhd::rfnoc::stream_sig_t::vlen

The vector length in multiples of items. If undefined, set to zero.

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

include/uhd/rfnoc/stream_sig.hpp

Public Member Functions

Static Public Member Functions

Public Attributes