The abstract base class for all signal processing blocks. More...

#include <gnuradio/basic_block.h>

Public Member Functions
pmt::pmt_t	message_subscribers (pmt::pmt_t port)

	~basic_block () override

long	unique_id () const

long	symbolic_id () const

std::string	name () const

std::string	symbol_name () const

std::string	identifier () const

gr::io_signature::sptr	input_signature () const

gr::io_signature::sptr	output_signature () const

basic_block_sptr	to_basic_block ()

bool	alias_set () const

std::string	alias () const

pmt::pmt_t	alias_pmt () const

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)

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)

const msg_queue_map_t &	get_msg_map (void) const

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

virtual void	set_processor_affinity (const std::vector< int > &mask)=0

virtual void	unset_processor_affinity ()=0

virtual std::vector< int >	processor_affinity ()=0

virtual void	set_log_level (const std::string &level)=0

virtual std::string	log_level ()=0

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

	~msg_accepter () override

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

Public Member Functions inherited from gr::messages::msg_accepter
	msg_accepter ()

virtual	~msg_accepter ()

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

Protected Types
enum	vcolor { WHITE , GREY , BLACK }

Protected Member Functions
	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

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

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

template<typename Derived >
std::shared_ptr< Derived >	shared_from_base ()
	This is meant to be called by derived classes (e.g. block) to get a shared pointer internally. This is needed because std::enable_shared_from_this doesn't seem to work with derived classes in an inheritance hierarchy. More...

Protected Attributes
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

gr::logger_ptr	d_logger

gr::logger_ptr	d_debug_logger
	Default logger. More...

msg_queue_map_t	msg_queue
	Verbose logger. More...

std::vector< rpcbasic_sptr >	d_rpc_vars

pmt::pmt_t	d_message_subscribers

Friends
class	flowgraph

class	flat_flowgraph

class	tpb_thread_body

Detailed Description

The abstract base class for all signal processing blocks.

Basic blocks are the bare abstraction of an entity that has a name, a set of inputs and outputs, and a message queue. These are never instantiated directly; rather, this is the abstract parent class of both gr_hier_block, which is a recursive container, and block, which implements actual signal processing functions.

Member Enumeration Documentation

◆ vcolor

enum gr::basic_block::vcolor

protected

Enumerator
WHITE
GREY
BLACK

Constructor & Destructor Documentation

◆ basic_block() [1/2]

gr::basic_block::basic_block ( void )

inlineprotected

◆ basic_block() [2/2]

gr::basic_block::basic_block	(	const std::string &	name,
		gr::io_signature::sptr	input_signature,
		gr::io_signature::sptr	output_signature
	)

protected

Protected constructor prevents instantiation by non-derived classes.

◆ ~basic_block()

gr::basic_block::~basic_block ( )

override

Member Function Documentation

◆ _post()

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

Accept msg, place in queue, arrange for thread to be awakened if it's not already.

◆ alias()

std::string gr::basic_block::alias ( ) const

inline

Returns the block's alias as a string.

◆ alias_pmt()

pmt::pmt_t gr::basic_block::alias_pmt ( ) const

inline

Returns the block's alias as PMT.

References pmt::intern().

◆ alias_set()

bool gr::basic_block::alias_set ( ) const

inline

True if the block has an alias (see set_block_alias).

◆ check_topology()

virtual bool gr::basic_block::check_topology	(	int	ninputs,
		int	noutputs
	)

inlinevirtual

Confirm that ninputs and noutputs is an acceptable combination.

Parameters

ninputs	number of input streams connected
noutputs	number of output streams connected

Returns: true if this is a valid configuration for this block.

This function is called by the runtime system whenever the topology changes. Most classes do not need to override this. This check is in addition to the constraints specified by the input and output gr::io_signatures.

Reimplemented in gr::tagged_stream_block.

◆ color()

vcolor gr::basic_block::color ( ) const

inlineprotected

◆ delete_head_nowait()

pmt::pmt_t gr::basic_block::delete_head_nowait ( pmt::pmt_t which_port )

Returns: returns pmt at head of queue or pmt::pmt_t() if empty.

◆ dispatch_msg()

virtual void gr::basic_block::dispatch_msg	(	pmt::pmt_t	which_port,
		pmt::pmt_t	msg
	)

inlineprotectedvirtual

References gr::msgport_names::msg().

◆ empty_handled_p() [1/2]

bool gr::basic_block::empty_handled_p ( )

inline

◆ empty_handled_p() [2/2]

bool gr::basic_block::empty_handled_p ( pmt::pmt_t which_port )

inline

are all msg ports with handlers empty?

◆ empty_p() [1/2]

bool gr::basic_block::empty_p ( )

inline

◆ empty_p() [2/2]

bool gr::basic_block::empty_p ( pmt::pmt_t which_port )

inline

is the queue empty?

◆ erase_msg()

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

inline

◆ get_iterator()

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

inline

◆ get_msg_map()

const msg_queue_map_t & gr::basic_block::get_msg_map ( void ) const

inline

◆ has_msg_handler()

virtual bool gr::basic_block::has_msg_handler ( pmt::pmt_t which_port )

inlineprotectedvirtual

Tests if there is a handler attached to port which_port.

◆ has_msg_port()

virtual bool gr::basic_block::has_msg_port ( pmt::pmt_t which_port )

inlinevirtual

Reimplemented in gr::hier_block2.

References pmt::dict_has_key().

Referenced by gr::hier_block2::has_msg_port().

◆ identifier()

std::string gr::basic_block::identifier ( ) const

inline

Referenced by gr::operator<<().

◆ input_signature()

gr::io_signature::sptr gr::basic_block::input_signature ( ) const

inline

◆ insert_tail()

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

◆ is_rpc_set()

bool gr::basic_block::is_rpc_set ( )

inline

Ask if this block has been registered to the RPC.

We can only register a block once, so we use this to protect us from calling it multiple times.

◆ log_level()

virtual std::string gr::basic_block::log_level ( )

pure virtual

Implemented in gr::block, and gr::hier_block2.

◆ message_port_is_hier()

virtual bool gr::basic_block::message_port_is_hier ( pmt::pmt_t port_id )

inlinevirtual

Reimplemented in gr::hier_block2.

◆ message_port_is_hier_in()

virtual bool gr::basic_block::message_port_is_hier_in ( pmt::pmt_t port_id )

inlinevirtual

Reimplemented in gr::hier_block2.

◆ message_port_is_hier_out()

virtual bool gr::basic_block::message_port_is_hier_out ( pmt::pmt_t port_id )

inlinevirtual

Reimplemented in gr::hier_block2.

◆ message_port_pub()

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

◆ message_port_register_in()

void gr::basic_block::message_port_register_in ( pmt::pmt_t port_id )

◆ message_port_register_out()

void gr::basic_block::message_port_register_out ( pmt::pmt_t port_id )

◆ message_port_sub()

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

◆ message_port_unsub()

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

◆ message_ports_in()

pmt::pmt_t gr::basic_block::message_ports_in ( )

Get input message port names.

Returns the available input message ports for a block. The return object is a PMT vector that is filled with PMT symbols.

◆ message_ports_out()

pmt::pmt_t gr::basic_block::message_ports_out ( )

Get output message port names.

Returns the available output message ports for a block. The return object is a PMT vector that is filled with PMT symbols.

◆ message_subscribers()

pmt::pmt_t gr::basic_block::message_subscribers ( pmt::pmt_t port )

◆ name()

std::string gr::basic_block::name ( ) const

inline

The name of the block

◆ nmsgs()

size_t gr::basic_block::nmsgs ( pmt::pmt_t which_port )

inline

How many messages in the queue?

◆ output_signature()

gr::io_signature::sptr gr::basic_block::output_signature ( ) const

inline

◆ processor_affinity()

virtual std::vector< int > gr::basic_block::processor_affinity ( )

pure virtual

Implemented in gr::block, and gr::hier_block2.

◆ rpc_set()

void gr::basic_block::rpc_set ( )

inline

When the block is registered with the RPC, set this.

◆ set_block_alias()

void gr::basic_block::set_block_alias ( std::string name )

Set's a new alias for the block; also adds an entry into the block_registry to get the block using either the alias or the original symbol name.

◆ set_color()

void gr::basic_block::set_color ( vcolor color )

inlineprotected

Allow the flowgraph to set for sorting and partitioning.

◆ set_input_signature()

void gr::basic_block::set_input_signature ( gr::io_signature::sptr iosig )

inlineprotected

may only be called during constructor

◆ set_log_level()

virtual void gr::basic_block::set_log_level ( const std::string & level )

pure virtual

Implemented in gr::block, and gr::hier_block2.

◆ set_msg_handler()

template<typename T >

void gr::basic_block::set_msg_handler	(	pmt::pmt_t	which_port,
		T	msg_handler
	)

inline

Set the callback that is fired when messages are available.

msg_handler can be any kind of function pointer or function object that has the signature:

   void msg_handler(pmt::pmt msg);

(You may want to use boost::bind to massage your callable into the correct form. See gr::blocks::nop for an example that sets up a class method as the callback.)

Blocks that desire to handle messages must call this method in their constructors to register the handler that will be invoked when messages are available.

If the block inherits from block, the runtime system will ensure that msg_handler is called in a thread-safe manner, such that work and msg_handler will never be called concurrently. This allows msg_handler to update state variables without having to worry about thread-safety issues with work, general_work or another invocation of msg_handler.

If the block inherits from hier_block2, the runtime system will ensure that no reentrant calls are made to msg_handler.

◆ set_output_signature()

void gr::basic_block::set_output_signature ( gr::io_signature::sptr iosig )

inlineprotected

may only be called during constructor

◆ set_processor_affinity()

virtual void gr::basic_block::set_processor_affinity ( const std::vector< int > & mask )

pure virtual

Implemented in gr::block, and gr::hier_block2.

◆ setup_rpc()

virtual void gr::basic_block::setup_rpc ( )

inlinevirtual

Set up the RPC registered variables.

This must be overloaded by a block that wants to use controlport. This is where rpcbasic_register_{get,set} pointers are created, which then get wrapped as shared pointers (rpcbasic_sptr(...)) and stored using add_rpc_variable.

Reimplemented in gr::top_block.

◆ shared_from_base()

template<typename Derived >

std::shared_ptr< Derived > gr::basic_block::shared_from_base ( )

inlineprotected

This is meant to be called by derived classes (e.g. block) to get a shared pointer internally. This is needed because std::enable_shared_from_this doesn't seem to work with derived classes in an inheritance hierarchy.

◆ symbol_name()

std::string gr::basic_block::symbol_name ( ) const

inline

The sybolic name of the block, which is used in the block_registry. The name is assigned by the block's constructor and never changes during the life of the block.

◆ symbolic_id()

long gr::basic_block::symbolic_id ( ) const

inline

◆ to_basic_block()

basic_block_sptr gr::basic_block::to_basic_block ( )

◆ unique_id()

long gr::basic_block::unique_id ( ) const

inline

◆ unset_processor_affinity()

virtual void gr::basic_block::unset_processor_affinity ( )

pure virtual

Implemented in gr::block, and gr::hier_block2.

Friends And Related Function Documentation

◆ flat_flowgraph

friend class flat_flowgraph

friend

◆ flowgraph

friend class flowgraph

friend

◆ tpb_thread_body

friend class tpb_thread_body

friend

Member Data Documentation

◆ d_color

vcolor gr::basic_block::d_color

protected

◆ d_debug_logger

gr::logger_ptr gr::basic_block::d_debug_logger

protected

Default logger.

◆ d_input_signature

gr::io_signature::sptr gr::basic_block::d_input_signature

protected

◆ d_logger

gr::logger_ptr gr::basic_block::d_logger

protected

Used by blocks to access the logger system.

Referenced by block_gateway::_get_logger().

◆ d_message_subscribers

pmt::pmt_t gr::basic_block::d_message_subscribers

protected

◆ d_name

std::string gr::basic_block::d_name

protected

◆ d_output_signature

gr::io_signature::sptr gr::basic_block::d_output_signature

protected

◆ d_rpc_set

bool gr::basic_block::d_rpc_set

protected

◆ d_rpc_vars

std::vector<rpcbasic_sptr> gr::basic_block::d_rpc_vars

protected

◆ d_symbol_alias

std::string gr::basic_block::d_symbol_alias

protected

◆ d_symbol_name

std::string gr::basic_block::d_symbol_name

protected

◆ d_symbolic_id

long gr::basic_block::d_symbolic_id

protected

◆ d_unique_id

long gr::basic_block::d_unique_id

protected

◆ msg_queue

msg_queue_map_t gr::basic_block::msg_queue

protected

Verbose logger.

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

basic_block.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ vcolor

Constructor & Destructor Documentation

◆ basic_block() [1/2]

◆ basic_block() [2/2]

◆ ~basic_block()

Member Function Documentation

◆ _post()

◆ alias()

◆ alias_pmt()

◆ alias_set()

◆ check_topology()

◆ color()

◆ delete_head_nowait()

◆ dispatch_msg()

◆ empty_handled_p() [1/2]

◆ empty_handled_p() [2/2]

◆ empty_p() [1/2]

◆ empty_p() [2/2]

◆ erase_msg()

◆ get_iterator()

◆ get_msg_map()

◆ has_msg_handler()

◆ has_msg_port()

◆ identifier()

◆ input_signature()

◆ insert_tail()

◆ is_rpc_set()

◆ log_level()

◆ message_port_is_hier()

◆ message_port_is_hier_in()

◆ message_port_is_hier_out()

◆ message_port_pub()

◆ message_port_register_in()

◆ message_port_register_out()

◆ message_port_sub()

◆ message_port_unsub()

◆ message_ports_in()

◆ message_ports_out()

◆ message_subscribers()

◆ name()

◆ nmsgs()

◆ output_signature()

◆ processor_affinity()

◆ rpc_set()

◆ set_block_alias()

◆ set_color()

◆ set_input_signature()

◆ set_log_level()

◆ set_msg_handler()

◆ set_output_signature()

◆ set_processor_affinity()

◆ setup_rpc()

◆ shared_from_base()

◆ symbol_name()

◆ symbolic_id()

◆ to_basic_block()

◆ unique_id()

◆ unset_processor_affinity()

Friends And Related Function Documentation

◆ flat_flowgraph

◆ flowgraph

◆ tpb_thread_body

Member Data Documentation

◆ d_color

◆ d_debug_logger

◆ d_input_signature

◆ d_logger

◆ d_message_subscribers

◆ d_name

◆ d_output_signature

◆ d_rpc_set

◆ d_rpc_vars

◆ d_symbol_alias