GNU Radio 3.6.4.1 C++ API
|
Top-level hierarchical block representing a flowgraph. More...
#include <gr_top_block.h>
Public Member Functions | |
~gr_top_block () | |
void | run (int max_noutput_items=100000) |
The simple interface to running a flowgraph. More... | |
void | start (int max_noutput_items=100000) |
void | stop () |
void | wait () |
virtual void | lock () |
virtual void | unlock () |
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... | |
gr_top_block_sptr | to_top_block () |
![]() | |
virtual | ~gr_hier_block2 () |
opaque_self | self () |
Return an object, representing the current block, which can be passed to connect. More... | |
void | connect (gr_basic_block_sptr block) |
Add a stand-alone (possibly hierarchical) block to internal graph. More... | |
void | connect (gr_basic_block_sptr src, int src_port, gr_basic_block_sptr dst, int dst_port) |
Add gr-blocks or hierarchical blocks to internal graph and wire together. More... | |
void | msg_connect (gr_basic_block_sptr src, pmt::pmt_t srcport, gr_basic_block_sptr dst, pmt::pmt_t dstport) |
Add gr-blocks or hierarchical blocks to internal graph and wire together. More... | |
void | msg_connect (gr_basic_block_sptr src, std::string srcport, gr_basic_block_sptr dst, std::string dstport) |
void | msg_disconnect (gr_basic_block_sptr src, pmt::pmt_t srcport, gr_basic_block_sptr dst, pmt::pmt_t dstport) |
void | msg_disconnect (gr_basic_block_sptr src, std::string srcport, gr_basic_block_sptr dst, std::string dstport) |
void | disconnect (gr_basic_block_sptr block) |
Remove a gr-block or hierarchical block from the internal flowgraph. More... | |
void | disconnect (gr_basic_block_sptr src, int src_port, gr_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... | |
gr_flat_flowgraph_sptr | flatten () const |
gr_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) |
![]() | |
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) |
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 () |
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 | 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... | |
![]() | |
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... | |
![]() | |
msg_accepter () | |
virtual | ~msg_accepter () |
Protected Member Functions | |
gr_top_block (const std::string &name) | |
![]() | |
gr_hier_block2 (void) | |
gr_hier_block2 (const std::string &name, gr_io_signature_sptr input_signature, gr_io_signature_sptr output_signature) | |
![]() | |
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 |
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_CORE_API gr_top_block_sptr | gr_make_top_block (const std::string &name) |
Additional Inherited Members | |
![]() | |
typedef gr_basic_block_sptr | opaque_self |
typedef for object returned from self(). More... | |
![]() | |
pmt::pmt_t | hier_message_ports_in |
pmt::pmt_t | hier_message_ports_out |
![]() | |
enum | vcolor { WHITE, GREY, BLACK } |
![]() | |
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 |
msg_queue_map_t | msg_queue |
pmt::pmt_t | message_subscribers |
Top-level hierarchical block representing a flowgraph.
|
protected |
gr_top_block::~gr_top_block | ( | ) |
void gr_top_block::dump | ( | ) |
Displays flattened flowgraph edges and block connectivity
|
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., gr_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.
void gr_top_block::run | ( | int | max_noutput_items = 100000 | ) |
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().
max_noutput_items | the 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::start | ( | int | max_noutput_items = 100000 | ) |
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.
max_noutput_items | the 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.
gr_top_block_sptr gr_top_block::to_top_block | ( | ) |
|
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., gr_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 gr.file_source, or gr.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).
|
friend |