GNU Radio 3.7.1-34 C++ API
gr::blocks::stream_mux Class Reference

Stream muxing block to multiplex many streams into one with a specified format. More...

#include <stream_mux.h>

Inheritance diagram for gr::blocks::stream_mux:
gr::block gr::basic_block gr::msg_accepter gr::messages::msg_accepter

Public Types

typedef boost::shared_ptr
< stream_mux
sptr
- Public Types inherited from gr::block
enum  { WORK_CALLED_PRODUCE = -2, WORK_DONE = -1 }
 Magic return values from general_work. More...
enum  tag_propagation_policy_t { TPP_DONT = 0, TPP_ALL_TO_ALL = 1, TPP_ONE_TO_ONE = 2 }

Static Public Member Functions

static sptr make (size_t itemsize, const std::vector< int > &lengths)
 Creates a stream muxing block to multiplex many streams into one with a specified format.

Additional Inherited Members

- Public Member Functions inherited from gr::block
virtual ~block ()
unsigned history () const
void set_history (unsigned history)
bool fixed_rate () const
 Return true if this block has a fixed input to output rate.
virtual void forecast (int noutput_items, gr_vector_int &ninput_items_required)
 Estimate input requirements given output request.
virtual int general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
 compute output items from input items
virtual bool start ()
 Called to enable drivers, etc for i/o devices.
virtual bool stop ()
 Called to disable drivers, etc for i/o devices.
void set_output_multiple (int multiple)
 Constrain the noutput_items argument passed to forecast and general_work.
int output_multiple () const
bool output_multiple_set () const
void set_alignment (int multiple)
 Constrains buffers to work on a set item alignment (for SIMD)
int alignment () const
void set_unaligned (int na)
int unaligned () const
void set_is_unaligned (bool u)
bool is_unaligned () const
void consume (int which_input, int how_many_items)
 Tell the scheduler how_many_items of input stream which_input were consumed.
void consume_each (int how_many_items)
 Tell the scheduler how_many_items were consumed on each input stream.
void produce (int which_output, int how_many_items)
 Tell the scheduler how_many_items were produced on output stream which_output.
void set_relative_rate (double relative_rate)
 Set the approximate output rate / input rate.
double relative_rate () const
 return the approximate output rate / input rate
virtual int fixed_rate_ninput_to_noutput (int ninput)
 Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this.
virtual int fixed_rate_noutput_to_ninput (int noutput)
 Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this.
uint64_t nitems_read (unsigned int which_input)
 Return the number of items read on input stream which_input.
uint64_t nitems_written (unsigned int which_output)
 Return the number of items written on output stream which_output.
tag_propagation_policy_t tag_propagation_policy ()
 Asks for the policy used by the scheduler to moved tags downstream.
void set_tag_propagation_policy (tag_propagation_policy_t p)
 Set the policy by the scheduler to determine how tags are moved downstream.
int min_noutput_items () const
 Return the minimum number of output items this block can produce during a call to work.
void set_min_noutput_items (int m)
 Set the minimum number of output items this block can produce during a call to work.
int max_noutput_items ()
 Return the maximum number of output items this block will handle during a call to work.
void set_max_noutput_items (int m)
 Set the maximum number of output items this block will handle during a call to work.
void unset_max_noutput_items ()
 Clear the switch for using the max_noutput_items value of this block.
bool is_set_max_noutput_items ()
 Ask the block if the flag is or is not set to use the internal value of max_noutput_items during a call to work.
void expand_minmax_buffer (int port)
long max_output_buffer (size_t i)
 Returns max buffer size on output port i.
void set_max_output_buffer (long max_output_buffer)
 Sets max buffer size on all output ports.
void set_max_output_buffer (int port, long max_output_buffer)
 Sets max buffer size on output port port.
long min_output_buffer (size_t i)
 Returns min buffer size on output port i.
void set_min_output_buffer (long min_output_buffer)
 Sets min buffer size on all output ports.
void set_min_output_buffer (int port, long min_output_buffer)
 Sets min buffer size on output port port.
float pc_noutput_items ()
 Gets instantaneous noutput_items performance counter.
float pc_noutput_items_avg ()
 Gets average noutput_items performance counter.
float pc_noutput_items_var ()
 Gets variance of noutput_items performance counter.
float pc_nproduced ()
 Gets instantaneous num items produced performance counter.
float pc_nproduced_avg ()
 Gets average num items produced performance counter.
float pc_nproduced_var ()
 Gets variance of num items produced performance counter.
float pc_input_buffers_full (int which)
 Gets instantaneous fullness of which input buffer.
float pc_input_buffers_full_avg (int which)
 Gets average fullness of which input buffer.
float pc_input_buffers_full_var (int which)
 Gets variance of fullness of which input buffer.
std::vector< float > pc_input_buffers_full ()
 Gets instantaneous fullness of all input buffers.
std::vector< float > pc_input_buffers_full_avg ()
 Gets average fullness of all input buffers.
std::vector< float > pc_input_buffers_full_var ()
 Gets variance of fullness of all input buffers.
float pc_output_buffers_full (int which)
 Gets instantaneous fullness of which input buffer.
float pc_output_buffers_full_avg (int which)
 Gets average fullness of which input buffer.
float pc_output_buffers_full_var (int which)
 Gets variance of fullness of which input buffer.
std::vector< float > pc_output_buffers_full ()
 Gets instantaneous fullness of all output buffers.
std::vector< float > pc_output_buffers_full_avg ()
 Gets average fullness of all output buffers.
std::vector< float > pc_output_buffers_full_var ()
 Gets variance of fullness of all output buffers.
float pc_work_time ()
 Gets instantaneous clock cycles spent in work.
float pc_work_time_avg ()
 Gets average clock cycles spent in work.
float pc_work_time_var ()
 Gets average clock cycles spent in work.
void reset_perf_counters ()
 Resets the performance counters.
void setup_pc_rpc ()
 Sets up export of perf. counters to ControlPort. Only called by the scheduler.
bool is_pc_rpc_set ()
 Checks if this block is already exporting perf. counters to ControlPort.
void no_pc_rpc ()
 If the block calls this in its constructor, it's perf. counters will not be exported.
void set_processor_affinity (const std::vector< int > &mask)
 Set the thread's affinity to processor core n.
void unset_processor_affinity ()
 Remove processor affinity to a specific core.
std::vector< int > processor_affinity ()
 Get the current processor affinity.
int active_thread_priority ()
 Get the current thread priority in use.
int thread_priority ()
 Get the current thread priority stored.
int set_thread_priority (int priority)
 Set the current thread priority.
block_detail_sptr detail () const
void set_detail (block_detail_sptr detail)
- Protected Types inherited from gr::basic_block
enum  vcolor { WHITE, GREY, BLACK }
- Protected Member Functions inherited from gr::block
 block (void)
 block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
void set_fixed_rate (bool fixed_rate)
void add_item_tag (unsigned int which_output, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F)
 Adds a new tag onto the given output buffer.
void add_item_tag (unsigned int which_output, const tag_t &tag)
 Adds a new tag onto the given output buffer.
void remove_item_tag (unsigned int which_input, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F)
 Removes a tag from the given input buffer.
void remove_item_tag (unsigned int which_input, const tag_t &tag)
 Removes a tag from the given input buffer.
void get_tags_in_range (std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end)
 Given a [start,end), returns a vector of all tags in the range.
void get_tags_in_range (std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end, const pmt::pmt_t &key)
 Given a [start,end), returns a vector of all tags in the range with a given key.
- Protected Attributes inherited from gr::block
std::vector< long > d_max_output_buffer
std::vector< long > d_min_output_buffer
gr::thread::mutex d_setlock
gr::logger_ptr d_logger
gr::logger_ptr d_debug_logger

Detailed Description

Stream muxing block to multiplex many streams into one with a specified format.

Muxes N streams together producing an output stream that contains N0 items from the first stream, N1 items from the second, etc. and repeats:

[N0, N1, N2, ..., Nm, N0, N1, ...]

Member Typedef Documentation

Member Function Documentation

static sptr gr::blocks::stream_mux::make ( size_t  itemsize,
const std::vector< int > &  lengths 
)
static

Creates a stream muxing block to multiplex many streams into one with a specified format.

Parameters
itemsizethe item size of the stream
lengthsa vector (list/tuple) specifying the number of items from each stream the mux together. Warning: this requires that at least as many items per stream are available or the system will wait indefinitely for the items.

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