Turn received messages into a stream and tag them for UHD to send. More...

#include <gr_message_burst_source.h>

Inheritance diagram for gr_message_burst_source:

Public Member Functions
	~gr_message_burst_source ()

gr_msg_queue_sptr	msgq () const

int	work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
	just like gr_block::general_work, only this arranges to call consume_each for you More...

Public Member Functions inherited from gr_sync_block
void	forecast (int noutput_items, gr_vector_int &ninput_items_required)
	Estimate input requirements given output request. More...

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 More...

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. More...

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. More...

Public Member Functions inherited from gr_block
virtual	~gr_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. More...

virtual bool	start ()
	Called to enable drivers, etc for i/o devices. More...

virtual bool	stop ()
	Called to disable drivers, etc for i/o devices. More...

void	set_output_multiple (int multiple)
	Constrain the noutput_items argument passed to forecast and general_work. More...

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) More...

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. More...

void	consume_each (int how_many_items)
	Tell the scheduler `how_many_items` were consumed on each input stream. More...

void	produce (int which_output, int how_many_items)
	Tell the scheduler `how_many_items` were produced on output stream `which_output`. More...

void	set_relative_rate (double relative_rate)
	Set the approximate output rate / input rate. More...

double	relative_rate () const
	return the approximate output rate / input rate More...

uint64_t	nitems_read (unsigned int which_input)
	Return the number of items read on input stream which_input. More...

uint64_t	nitems_written (unsigned int which_output)
	Return the number of items written on output stream which_output. More...

tag_propagation_policy_t	tag_propagation_policy ()
	Asks for the policy used by the scheduler to moved tags downstream. More...

void	set_tag_propagation_policy (tag_propagation_policy_t p)
	Set the policy by the scheduler to determine how tags are moved downstream. More...

int	max_noutput_items ()
	Return the maximum number of output items this block will handle during a call to work. More...

void	set_max_noutput_items (int m)
	Set the maximum number of ouput items htis block will handle during a call to work. More...

void	unset_max_noutput_items ()
	Clear the switch for using the max_noutput_items value of this block. More...

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. More...

void	expand_minmax_buffer (int port)

long	max_output_buffer (size_t i)
	Returns max buffer size on output port `i`. More...

void	set_max_output_buffer (long max_output_buffer)
	Sets max buffer size on all output ports. More...

void	set_max_output_buffer (int port, long max_output_buffer)
	Sets max buffer size on output port `port`. More...

long	min_output_buffer (size_t i)
	Returns min buffer size on output port `i`. More...

void	set_min_output_buffer (long min_output_buffer)
	Sets min buffer size on all output ports. More...

void	set_min_output_buffer (int port, long min_output_buffer)
	Sets min buffer size on output port `port`. More...

gr_block_detail_sptr	detail () const

void	set_detail (gr_block_detail_sptr detail)

Public Member Functions inherited from gr_basic_block
virtual	~gr_basic_block ()

long	unique_id () const

long	symbolic_id () const

std::string	name () const

std::string	symbol_name () const

gr_io_signature_sptr	input_signature () const

gr_io_signature_sptr	output_signature () const

gr_basic_block_sptr	to_basic_block ()

bool	alias_set ()

std::string	alias ()

pmt::pmt_t	alias_pmt ()

void	set_block_alias (std::string name)

void	message_port_register_in (pmt::pmt_t port_id)

void	message_port_register_out (pmt::pmt_t port_id)

void	message_port_pub (pmt::pmt_t port_id, pmt::pmt_t msg)

void	message_port_sub (pmt::pmt_t port_id, pmt::pmt_t target)

void	message_port_unsub (pmt::pmt_t port_id, pmt::pmt_t target)

virtual bool	message_port_is_hier (pmt::pmt_t port_id)

virtual bool	message_port_is_hier_in (pmt::pmt_t port_id)

virtual bool	message_port_is_hier_out (pmt::pmt_t port_id)

pmt::pmt_t	message_ports_in ()
	Get input message port names. More...

pmt::pmt_t	message_ports_out ()
	Get output message port names. More...

void	_post (pmt::pmt_t which_port, pmt::pmt_t msg)

bool	empty_p (pmt::pmt_t which_port)
	is the queue empty? More...

bool	empty_p ()

void	insert_tail (pmt::pmt_t which_port, pmt::pmt_t msg)

pmt::pmt_t	delete_head_nowait (pmt::pmt_t which_port)

pmt::pmt_t	delete_head_blocking (pmt::pmt_t which_port)

msg_queue_t::iterator	get_iterator (pmt::pmt_t which_port)

void	erase_msg (pmt::pmt_t which_port, msg_queue_t::iterator it)

virtual bool	has_msg_port (pmt::pmt_t which_port)

virtual bool	check_topology (int ninputs, int noutputs)
	Confirm that ninputs and noutputs is an acceptable combination. More...

template<typename T >
void	set_msg_handler (pmt::pmt_t which_port, T msg_handler)
	Set the callback that is fired when messages are available. More...

Public Member Functions inherited from gr_msg_accepter
	gr_msg_accepter ()

	~gr_msg_accepter ()

void	post (pmt::pmt_t which_port, pmt::pmt_t msg)
	send `msg` to `msg_accepter` on port `which_port` More...

Public Member Functions inherited from gruel::msg_accepter
	msg_accepter ()

virtual	~msg_accepter ()

Protected Member Functions
	gr_message_burst_source (size_t itemsize, int msgq_limit)

	gr_message_burst_source (size_t itemsize, gr_msg_queue_sptr msgq)

Protected Member Functions inherited from gr_sync_block
	gr_sync_block (void)

	gr_sync_block (const std::string &name, gr_io_signature_sptr input_signature, gr_io_signature_sptr output_signature)

Protected Member Functions inherited from gr_block
	gr_block (void)

	gr_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. More...

void	add_item_tag (unsigned int which_output, const gr_tag_t &tag)
	Adds a new tag onto the given output buffer. More...

void	get_tags_in_range (std::vector< gr_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. More...

void	get_tags_in_range (std::vector< gr_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. More...

Protected Member Functions inherited from gr_basic_block
	gr_basic_block (void)

	gr_basic_block (const std::string &name, gr_io_signature_sptr input_signature, gr_io_signature_sptr output_signature)
	Protected constructor prevents instantiation by non-derived classes. More...

void	set_input_signature (gr_io_signature_sptr iosig)
	may only be called during constructor More...

void	set_output_signature (gr_io_signature_sptr iosig)
	may only be called during constructor More...

void	set_color (vcolor color)
	Allow the flowgraph to set for sorting and partitioning. More...

vcolor	color () const

Friends
GR_CORE_API gr_message_burst_source_sptr	gr_make_message_burst_source (size_t itemsize, int msgq_limit)

GR_CORE_API gr_message_burst_source_sptr	gr_make_message_burst_source (size_t itemsize, gr_msg_queue_sptr msgq)

Additional Inherited Members
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 }

Protected Types inherited from gr_basic_block
enum	vcolor { WHITE, GREY, BLACK }

Protected Attributes inherited from gr_block
std::vector< long >	d_max_output_buffer

std::vector< long >	d_min_output_buffer

Detailed Description

Turn received messages into a stream and tag them for UHD to send.

Constructor & Destructor Documentation

gr_message_burst_source::gr_message_burst_source	(	size_t	itemsize,
		int	msgq_limit
	)

protected

gr_message_burst_source::gr_message_burst_source	(	size_t	itemsize,
		gr_msg_queue_sptr	msgq
	)

protected

gr_message_burst_source::~gr_message_burst_source ( )

Member Function Documentation

gr_msg_queue_sptr gr_message_burst_source::msgq ( ) const

inline

int gr_message_burst_source::work	(	int	noutput_items,
		gr_vector_const_void_star &	input_items,
		gr_vector_void_star &	output_items
	)

virtual

just like gr_block::general_work, only this arranges to call consume_each for you

The user must override work to define the signal processing code

Implements gr_sync_block.

Friends And Related Function Documentation

GR_CORE_API gr_message_burst_source_sptr gr_make_message_burst_source	(	size_t	itemsize,
		int	msgq_limit
	)

friend

GR_CORE_API gr_message_burst_source_sptr gr_make_message_burst_source	(	size_t	itemsize,
		gr_msg_queue_sptr	msgq
	)

friend

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

gr_message_burst_source.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation