GNU Radio Manual and C++ API Reference  3.7.10.1
The Free & Open Software Radio Ecosystem
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages

Top-level hierarchical block representing a flowgraph. More...

#include <gnuradio/top_block.h>

Public Member Functions

 ~top_block ()
 
void run (int max_noutput_items=100000000)
 The simple interface to running a flowgraph. More...
 
void start (int max_noutput_items=100000000)
 
void stop ()
 
void wait ()
 
virtual void lock ()
 
virtual void unlock ()
 
std::string edge_list ()
 
std::string msg_edge_list ()
 
void dump ()
 
int max_noutput_items ()
 Get the number of max noutput_items in the flowgraph. More...
 
void set_max_noutput_items (int nmax)
 Set the maximum number of noutput_items in the flowgraph. More...
 
top_block_sptr to_top_block ()
 
void setup_rpc ()
 Set up the RPC registered variables. More...
 
- Public Member Functions inherited from gr::hier_block2
virtual ~hier_block2 ()
 
opaque_self self ()
 Return an object, representing the current block, which can be passed to connect. More...
 
void connect (basic_block_sptr block)
 Add a stand-alone (possibly hierarchical) block to internal graph. More...
 
void connect (basic_block_sptr src, int src_port, basic_block_sptr dst, int dst_port)
 Add gr-blocks or hierarchical blocks to internal graph and wire together. More...
 
void msg_connect (basic_block_sptr src, pmt::pmt_t srcport, basic_block_sptr dst, pmt::pmt_t dstport)
 Add gr-blocks or hierarchical blocks to internal graph and wire together. More...
 
void msg_connect (basic_block_sptr src, std::string srcport, basic_block_sptr dst, std::string dstport)
 
void msg_disconnect (basic_block_sptr src, pmt::pmt_t srcport, basic_block_sptr dst, pmt::pmt_t dstport)
 
void msg_disconnect (basic_block_sptr src, std::string srcport, basic_block_sptr dst, std::string dstport)
 
void disconnect (basic_block_sptr block)
 Remove a gr-block or hierarchical block from the internal flowgraph. More...
 
void disconnect (basic_block_sptr src, int src_port, basic_block_sptr dst, int dst_port)
 Disconnect a pair of gr-blocks or hierarchical blocks in internal flowgraph. More...
 
void disconnect_all ()
 Disconnect all connections in the internal flowgraph. More...
 
int max_output_buffer (size_t port=0)
 Returns max buffer size (itemcount) on output port i. More...
 
void set_max_output_buffer (int max_output_buffer)
 Sets max buffer size (itemcount) on all output ports. More...
 
void set_max_output_buffer (size_t port, int max_output_buffer)
 Sets max buffer size (itemcount) on output port port. More...
 
int min_output_buffer (size_t port=0)
 Returns min buffer size (itemcount) on output port i. More...
 
void set_min_output_buffer (int min_output_buffer)
 Sets min buffer size (itemcount) on all output ports. More...
 
void set_min_output_buffer (size_t port, int min_output_buffer)
 Sets min buffer size (itemcount) on output port port. More...
 
flat_flowgraph_sptr flatten () const
 
hier_block2_sptr to_hier_block2 ()
 
bool has_msg_port (pmt::pmt_t which_port)
 
bool message_port_is_hier (pmt::pmt_t port_id)
 
bool message_port_is_hier_in (pmt::pmt_t port_id)
 
bool message_port_is_hier_out (pmt::pmt_t port_id)
 
void message_port_register_hier_in (pmt::pmt_t port_id)
 
void message_port_register_hier_out (pmt::pmt_t port_id)
 
void set_processor_affinity (const std::vector< int > &mask)
 Set the affinity of all blocks in hier_block2 to processor core n. More...
 
void unset_processor_affinity ()
 Remove processor affinity for all blocks in hier_block2. More...
 
std::vector< int > processor_affinity ()
 Get the current processor affinity. More...
 
bool all_min_output_buffer_p (void)
 Get if all block min buffers should be set. More...
 
bool all_max_output_buffer_p (void)
 Get if all block max buffers should be set. More...
 
- 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)
 
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, unsigned int millisec=0)
 
msg_queue_t::iterator get_iterator (pmt::pmt_t which_port)
 
void erase_msg (pmt::pmt_t which_port, msg_queue_t::iterator it)
 
const msg_queue_map_t & get_msg_map (void) const
 
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 ()
 

Protected Member Functions

 top_block (const std::string &name)
 
- Protected Member Functions inherited from gr::hier_block2
 hier_block2 (void)
 
 hier_block2 (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
 
- 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
 
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)
 

Friends

GR_RUNTIME_API top_block_sptr make_top_block (const std::string &name)
 

Additional Inherited Members

- Public Types inherited from gr::hier_block2
typedef basic_block_sptr opaque_self
 typedef for object returned from self(). More...
 
- Public Attributes inherited from gr::hier_block2
pmt::pmt_t hier_message_ports_in
 
pmt::pmt_t hier_message_ports_out
 
- Protected Types inherited from gr::basic_block
enum  vcolor { WHITE, GREY, BLACK }
 
- 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

Top-level hierarchical block representing a flowgraph.

Constructor & Destructor Documentation

gr::top_block::top_block ( const std::string &  name)
protected
gr::top_block::~top_block ( )

Member Function Documentation

void gr::top_block::dump ( )

Displays flattened flowgraph edges and block connectivity

std::string gr::top_block::edge_list ( )

Returns a string that lists the edge connections in the flattened flowgraph.

virtual void gr::top_block::lock ( )
virtual

Lock a flowgraph in preparation for reconfiguration. When an equal number of calls to lock() and unlock() have occurred, the flowgraph will be reconfigured.

N.B. lock() and unlock() may not be called from a flowgraph thread (E.g., block::work method) or deadlock will occur when reconfiguration happens.

Reimplemented from gr::hier_block2.

int gr::top_block::max_noutput_items ( )

Get the number of max noutput_items in the flowgraph.

std::string gr::top_block::msg_edge_list ( )

Returns a string that lists the msg edge connections in the flattened flowgraph.

void gr::top_block::run ( int  max_noutput_items = 100000000)

The simple interface to running a flowgraph.

Calls start() then wait(). Used to run a flowgraph that will stop on its own, or when another thread will call stop().

Parameters
max_noutput_itemsthe maximum number of output items allowed for any block in the flowgraph. This passes through to the start function; see that function for more details.
void gr::top_block::set_max_noutput_items ( int  nmax)

Set the maximum number of noutput_items in the flowgraph.

void gr::top_block::setup_rpc ( )
virtual

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 from gr::basic_block.

void gr::top_block::start ( int  max_noutput_items = 100000000)

Start the contained flowgraph. Creates one or more threads to execute the flow graph. Returns to the caller once the threads are created. Calling start() on a top_block that is already started IS an error.

Parameters
max_noutput_itemsthe maximum number of output items allowed for any block in the flowgraph; the noutput_items can always be less than this, but this will cap it as a maximum. Use this to adjust the maximum latency a flowgraph can exhibit.
void gr::top_block::stop ( )

Stop the running flowgraph. Notifies each thread created by the scheduler to shutdown, then returns to caller. Calling stop() on a top_block that is already stopped IS NOT an error.

top_block_sptr gr::top_block::to_top_block ( )
virtual void gr::top_block::unlock ( )
virtual

Unlock a flowgraph in preparation for reconfiguration. When an equal number of calls to lock() and unlock() have occurred, the flowgraph will be reconfigured.

N.B. lock() and unlock() may not be called from a flowgraph thread (E.g., block::work method) or deadlock will occur when reconfiguration happens.

Reimplemented from gr::hier_block2.

void gr::top_block::wait ( )

Wait for a flowgraph to complete. Flowgraphs complete when either (1) all blocks indicate that they are done (typically only when using blocks.file_source, or blocks.head, or (2) after stop() has been called to request shutdown. Calling wait on a top_block that is not running IS NOT an error (wait returns w/o blocking).

Friends And Related Function Documentation

GR_RUNTIME_API top_block_sptr make_top_block ( const std::string &  name)
friend

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