#include <gnuradio/block_gateway.h>

Inheritance diagram for gr::block_gateway:

Public Types
typedef boost::shared_ptr < block_gateway >	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 }

Public Member Functions
virtual block_gw_message_type &	block_message (void)=0
	Provide access to the shared message object. More...

long	block__unique_id (void) const

std::string	block__name (void) const

unsigned	block__history (void) const

void	block__set_history (unsigned history)

void	block__set_fixed_rate (bool fixed_rate)

bool	block__fixed_rate (void) const

void	block__set_output_multiple (int multiple)

int	block__output_multiple (void) const

void	block__consume (int which_input, int how_many_items)

void	block__consume_each (int how_many_items)

void	block__produce (int which_output, int how_many_items)

void	block__set_relative_rate (double relative_rate)

double	block__relative_rate (void) const

uint64_t	block__nitems_read (unsigned int which_input)

uint64_t	block__nitems_written (unsigned int which_output)

block::tag_propagation_policy_t	block__tag_propagation_policy (void)

void	block__set_tag_propagation_policy (block::tag_propagation_policy_t p)

void	block__add_item_tag (unsigned int which_output, const tag_t &tag)

void	block__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)

std::vector< tag_t >	block__get_tags_in_range (unsigned int which_input, uint64_t abs_start, uint64_t abs_end)

std::vector< tag_t >	block__get_tags_in_range (unsigned int which_input, uint64_t abs_start, uint64_t abs_end, const pmt::pmt_t &key)

void	block__message_port_register_in (pmt::pmt_t port_id)

void	block__message_port_register_out (pmt::pmt_t port_id)

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

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

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

pmt::pmt_t	block__message_subscribers (pmt::pmt_t which_port)

pmt::pmt_t	block__message_ports_in ()

pmt::pmt_t	block__message_ports_out ()

void	set_msg_handler_feval (pmt::pmt_t which_port, gr::feval_p *msg_handler)

Public Member Functions inherited from gr::block
virtual	~block ()

unsigned	history () const

void	set_history (unsigned history)

void	declare_sample_delay (int which, unsigned delay)

void	declare_sample_delay (unsigned delay)

unsigned	sample_delay (int which) const

bool	fixed_rate () const
	Return true if this block has a fixed input to output rate. More...

virtual void	forecast (int noutput_items, gr_vector_int &ninput_items_required)
	Estimate input requirements given output request. More...

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

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

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. 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	min_noutput_items () const
	Return the minimum number of output items this block can produce during a call to work. More...

void	set_min_noutput_items (int m)
	Set the minimum number of output items this block can produce during a call to work. 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 output items this 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...

float	pc_noutput_items ()
	Gets instantaneous noutput_items performance counter. More...

float	pc_noutput_items_avg ()
	Gets average noutput_items performance counter. More...

float	pc_noutput_items_var ()
	Gets variance of noutput_items performance counter. More...

float	pc_nproduced ()
	Gets instantaneous num items produced performance counter. More...

float	pc_nproduced_avg ()
	Gets average num items produced performance counter. More...

float	pc_nproduced_var ()
	Gets variance of num items produced performance counter. More...

float	pc_input_buffers_full (int which)
	Gets instantaneous fullness of `which` input buffer. More...

float	pc_input_buffers_full_avg (int which)
	Gets average fullness of `which` input buffer. More...

float	pc_input_buffers_full_var (int which)
	Gets variance of fullness of `which` input buffer. More...

std::vector< float >	pc_input_buffers_full ()
	Gets instantaneous fullness of all input buffers. More...

std::vector< float >	pc_input_buffers_full_avg ()
	Gets average fullness of all input buffers. More...

std::vector< float >	pc_input_buffers_full_var ()
	Gets variance of fullness of all input buffers. More...

float	pc_output_buffers_full (int which)
	Gets instantaneous fullness of `which` input buffer. More...

float	pc_output_buffers_full_avg (int which)
	Gets average fullness of `which` input buffer. More...

float	pc_output_buffers_full_var (int which)
	Gets variance of fullness of `which` input buffer. More...

std::vector< float >	pc_output_buffers_full ()
	Gets instantaneous fullness of all output buffers. More...

std::vector< float >	pc_output_buffers_full_avg ()
	Gets average fullness of all output buffers. More...

std::vector< float >	pc_output_buffers_full_var ()
	Gets variance of fullness of all output buffers. More...

float	pc_work_time ()
	Gets instantaneous clock cycles spent in work. More...

float	pc_work_time_avg ()
	Gets average clock cycles spent in work. More...

float	pc_work_time_var ()
	Gets average clock cycles spent in work. More...

float	pc_work_time_total ()
	Gets total clock cycles spent in work. More...

void	reset_perf_counters ()
	Resets the performance counters. More...

void	setup_pc_rpc ()
	Sets up export of perf. counters to ControlPort. Only called by the scheduler. More...

bool	is_pc_rpc_set ()
	Checks if this block is already exporting perf. counters to ControlPort. More...

void	no_pc_rpc ()
	If the block calls this in its constructor, it's perf. counters will not be exported. More...

void	set_processor_affinity (const std::vector< int > &mask)
	Set the thread's affinity to processor core `n`. More...

void	unset_processor_affinity ()
	Remove processor affinity to a specific core. More...

std::vector< int >	processor_affinity ()
	Get the current processor affinity. More...

int	active_thread_priority ()
	Get the current thread priority in use. More...

int	thread_priority ()
	Get the current thread priority stored. More...

int	set_thread_priority (int priority)
	Set the current thread priority. More...

bool	update_rate () const

block_detail_sptr	detail () const

void	set_detail (block_detail_sptr detail)

Public Member Functions inherited from gr::basic_block
pmt::pmt_t	message_subscribers (pmt::pmt_t port)

virtual	~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

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 ()

bool	empty_handled_p (pmt::pmt_t which_port)
	are all msg ports with handlers empty? More...

bool	empty_handled_p ()

size_t	nmsgs (pmt::pmt_t which_port)
	How many messages in the queue? More...

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 void	setup_rpc ()
	Set up the RPC registered variables. More...

bool	is_rpc_set ()
	Ask if this block has been registered to the RPC. More...

void	rpc_set ()
	When the block is registered with the RPC, set this. More...

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
	msg_accepter ()

	~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 gr::messages::msg_accepter
	msg_accepter ()

Static Public Member Functions
static sptr	make (gr::feval_ll *handler, const std::string &name, gr::io_signature::sptr in_sig, gr::io_signature::sptr out_sig, const block_gw_work_type work_type, const unsigned factor)

Protected Types
typedef std::map< pmt::pmt_t, feval_p *, pmt::comperator >	msg_handlers_feval_t

Protected Types inherited from gr::basic_block
enum	vcolor { WHITE, GREY, BLACK }

Protected Member Functions
bool	has_msg_handler (pmt::pmt_t which_port)
	Tests if there is a handler attached to port `which_port`. More...

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

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

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

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

void	remove_item_tag (unsigned int which_input, const tag_t &tag)
	Removes a tag from the given input buffer. More...

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

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

void	enable_update_rate (bool en)

Protected Member Functions inherited from gr::basic_block
	basic_block (void)

	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

Protected Attributes
msg_handlers_feval_t	d_msg_handlers_feval

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

Protected Attributes inherited from gr::basic_block
std::string	d_name

gr::io_signature::sptr	d_input_signature

gr::io_signature::sptr	d_output_signature

long	d_unique_id

long	d_symbolic_id

std::string	d_symbol_name

std::string	d_symbol_alias

vcolor	d_color

bool	d_rpc_set

msg_queue_map_t	msg_queue

std::vector< boost::any >	d_rpc_vars

pmt::pmt_t	d_message_subscribers

Detailed Description

The gateway block which performs all the magic.

The gateway provides access to all the gr::block routines. The methods prefixed with gr::block__ are renamed to class methods without the prefix in python.

Member Typedef Documentation

typedef std::map<pmt::pmt_t, feval_p *, pmt::comperator> gr::block_gateway::msg_handlers_feval_t

protected

typedef boost::shared_ptr<block_gateway> gr::block_gateway::sptr

Member Function Documentation

void gr::block_gateway::block__add_item_tag	(	unsigned int	which_output,
		const tag_t &	tag
	)

inline

References gr::block::add_item_tag().

void gr::block_gateway::block__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`
	)

inline

References gr::block::add_item_tag().

void gr::block_gateway::block__consume	(	int	which_input,
		int	how_many_items
	)

inline

References gr::block::consume().

void gr::block_gateway::block__consume_each ( int how_many_items )

inline

References gr::block::consume_each().

bool gr::block_gateway::block__fixed_rate ( void ) const

inline

References gr::block::fixed_rate().

std::vector<tag_t> gr::block_gateway::block__get_tags_in_range	(	unsigned int	which_input,
		uint64_t	abs_start,
		uint64_t	abs_end
	)

inline

References gr::block::get_tags_in_range().

std::vector<tag_t> gr::block_gateway::block__get_tags_in_range	(	unsigned int	which_input,
		uint64_t	abs_start,
		uint64_t	abs_end,
		const pmt::pmt_t &	key
	)

inline

References gr::block::get_tags_in_range().

unsigned gr::block_gateway::block__history ( void ) const

inline

References gr::block::history().

void gr::block_gateway::block__message_port_pub	(	pmt::pmt_t	port_id,
		pmt::pmt_t	msg
	)

inline

References gr::basic_block::message_port_pub().

void gr::block_gateway::block__message_port_register_in ( pmt::pmt_t port_id )

inline

References gr::basic_block::message_port_register_in().

void gr::block_gateway::block__message_port_register_out ( pmt::pmt_t port_id )

inline

References gr::basic_block::message_port_register_out().

void gr::block_gateway::block__message_port_sub	(	pmt::pmt_t	port_id,
		pmt::pmt_t	target
	)

inline

References gr::basic_block::message_port_sub().

void gr::block_gateway::block__message_port_unsub	(	pmt::pmt_t	port_id,
		pmt::pmt_t	target
	)

inline

References gr::basic_block::message_port_unsub().

pmt::pmt_t gr::block_gateway::block__message_ports_in ( )

inline

References gr::basic_block::message_ports_in().

pmt::pmt_t gr::block_gateway::block__message_ports_out ( )

inline

References gr::basic_block::message_ports_out().

pmt::pmt_t gr::block_gateway::block__message_subscribers ( pmt::pmt_t which_port )

inline

References gr::basic_block::message_subscribers().

std::string gr::block_gateway::block__name ( void ) const

inline

References gr::basic_block::name().

uint64_t gr::block_gateway::block__nitems_read ( unsigned int which_input )

inline

References gr::block::nitems_read().

uint64_t gr::block_gateway::block__nitems_written ( unsigned int which_output )

inline

References gr::block::nitems_written().

int gr::block_gateway::block__output_multiple ( void ) const

inline

References gr::block::output_multiple().

void gr::block_gateway::block__produce	(	int	which_output,
		int	how_many_items
	)

inline

References gr::block::produce().

double gr::block_gateway::block__relative_rate ( void ) const

inline

References gr::block::relative_rate().

void gr::block_gateway::block__set_fixed_rate ( bool fixed_rate )

inline

References gr::block::set_fixed_rate().

void gr::block_gateway::block__set_history ( unsigned history )

inline

References gr::block::set_history().

void gr::block_gateway::block__set_output_multiple ( int multiple )

inline

References gr::block::set_output_multiple().

void gr::block_gateway::block__set_relative_rate ( double relative_rate )

inline

References gr::block::set_relative_rate().

void gr::block_gateway::block__set_tag_propagation_policy ( block::tag_propagation_policy_t p )

inline

References gr::block::set_tag_propagation_policy().

block::tag_propagation_policy_t gr::block_gateway::block__tag_propagation_policy ( void )

inline

References gr::block::tag_propagation_policy().

long gr::block_gateway::block__unique_id ( void ) const

inline

References gr::basic_block::unique_id().

virtual block_gw_message_type& gr::block_gateway::block_message ( void )

pure virtual

Provide access to the shared message object.

void gr::block_gateway::dispatch_msg	(	pmt::pmt_t	which_port,
		pmt::pmt_t	msg
	)

inlineprotectedvirtual

Reimplemented from gr::basic_block.

References gr::basic_block::dispatch_msg().

bool gr::block_gateway::has_msg_handler ( pmt::pmt_t which_port )

inlineprotectedvirtual

Tests if there is a handler attached to port which_port.

Reimplemented from gr::basic_block.

static sptr gr::block_gateway::make	(	gr::feval_ll *	handler,
		const std::string &	name,
		gr::io_signature::sptr	in_sig,
		gr::io_signature::sptr	out_sig,
		const block_gw_work_type	work_type,
		const unsigned	factor
	)

static

Make a new gateway block.

Parameters

handler	the swig director object with callback
name	the name of the block (Ex: "Shirley")
in_sig	the input signature for this block
out_sig	the output signature for this block
work_type	the type of block overload to implement
factor	the decimation or interpolation factor

Returns: a new gateway block

void gr::block_gateway::set_msg_handler_feval	(	pmt::pmt_t	which_port,
		gr::feval_p *	msg_handler
	)

inline

Member Data Documentation

msg_handlers_feval_t gr::block_gateway::d_msg_handlers_feval

protected

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

block_gateway.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Function Documentation

Member Data Documentation