GNU Radio 3.6.3.1 C++ API
|
Hierarchical container class for gr_block's and gr_hier_block2's. More...
#include <gr_hier_block2.h>
Public Types | |
typedef gr_basic_block_sptr | opaque_self |
typedef for object returned from self(). |
Public Member Functions | |
virtual | ~gr_hier_block2 () |
opaque_self | self () |
Return an object, representing the current block, which can be passed to connect. | |
void | connect (gr_basic_block_sptr block) |
Add a stand-alone (possibly hierarchical) block to internal graph. | |
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. | |
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. | |
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. | |
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. | |
void | disconnect_all () |
Disconnect all connections in the internal flowgraph. | |
virtual void | lock () |
virtual void | unlock () |
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. | |
pmt::pmt_t | message_ports_out () |
Get output message port names. | |
void | _post (pmt::pmt_t which_port, pmt::pmt_t msg) |
bool | empty_p (pmt::pmt_t which_port) |
is the queue empty? | |
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 | check_topology (int ninputs, int noutputs) |
Confirm that ninputs and noutputs is an acceptable combination. | |
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. | |
![]() | |
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 | |
![]() | |
msg_accepter () | |
virtual | ~msg_accepter () |
Public Attributes | |
pmt::pmt_t | hier_message_ports_in |
pmt::pmt_t | hier_message_ports_out |
Protected Member Functions | |
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. | |
void | set_input_signature (gr_io_signature_sptr iosig) |
may only be called during constructor | |
void | set_output_signature (gr_io_signature_sptr iosig) |
may only be called during constructor | |
void | set_color (vcolor color) |
Allow the flowgraph to set for sorting and partitioning. | |
vcolor | color () const |
Friends | |
class | gr_hier_block2_detail |
GR_CORE_API gr_hier_block2_sptr | gr_make_hier_block2 (const std::string &name, gr_io_signature_sptr input_signature, gr_io_signature_sptr output_signature) |
public constructor for gr_hier_block2 |
Additional Inherited Members | |
![]() | |
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 |
Hierarchical container class for gr_block's and gr_hier_block2's.
typedef for object returned from self().
This type is only guaranteed to be passable to connect and disconnect. No other assumptions should be made about it.
|
inlineprotected |
|
protected |
|
virtual |
void gr_hier_block2::connect | ( | gr_basic_block_sptr | block | ) |
Add a stand-alone (possibly hierarchical) block to internal graph.
This adds a gr-block or hierarchical block to the internal graph without wiring it to anything else.
void gr_hier_block2::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.
This adds (if not done earlier by another connect) a pair of gr-blocks or hierarchical blocks to the internal flowgraph, and wires the specified output port to the specified input port.
void gr_hier_block2::disconnect | ( | gr_basic_block_sptr | block | ) |
Remove a gr-block or hierarchical block from the internal flowgraph.
This removes a gr-block or hierarchical block from the internal flowgraph, disconnecting it from other blocks as needed.
void gr_hier_block2::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.
This disconnects the specified input port from the specified output port of a pair of gr-blocks or hierarchical blocks.
void gr_hier_block2::disconnect_all | ( | ) |
Disconnect all connections in the internal flowgraph.
This call removes all output port to input port connections in the internal flowgraph.
gr_flat_flowgraph_sptr gr_hier_block2::flatten | ( | ) | const |
|
inlinevirtual |
Reimplemented from gr_basic_block.
References gr_basic_block::has_msg_port(), and gr_basic_block::message_port_is_hier().
|
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 in gr_top_block.
|
inlinevirtual |
Reimplemented from gr_basic_block.
References gr_basic_block::message_port_is_hier_in(), and gr_basic_block::message_port_is_hier_out().
|
inlinevirtual |
Reimplemented from gr_basic_block.
References pmt::pmt_list_has().
|
inlinevirtual |
Reimplemented from gr_basic_block.
References pmt::pmt_list_has().
|
inline |
References pmt::pmt_list_add(), and pmt::pmt_list_has().
|
inline |
References pmt::pmt_dict_has_key(), pmt::pmt_list_add(), and pmt::pmt_list_has().
void gr_hier_block2::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.
This adds (if not done earlier by another connect) a pair of gr-blocks or hierarchical blocks to the internal message port subscription
void gr_hier_block2::msg_connect | ( | gr_basic_block_sptr | src, |
std::string | srcport, | ||
gr_basic_block_sptr | dst, | ||
std::string | dstport | ||
) |
void gr_hier_block2::msg_disconnect | ( | gr_basic_block_sptr | src, |
pmt::pmt_t | srcport, | ||
gr_basic_block_sptr | dst, | ||
pmt::pmt_t | dstport | ||
) |
void gr_hier_block2::msg_disconnect | ( | gr_basic_block_sptr | src, |
std::string | srcport, | ||
gr_basic_block_sptr | dst, | ||
std::string | dstport | ||
) |
opaque_self gr_hier_block2::self | ( | ) |
Return an object, representing the current block, which can be passed to connect.
The returned object may only be used as an argument to connect or disconnect. Any other use of self() results in unspecified (erroneous) behavior.
gr_hier_block2_sptr gr_hier_block2::to_hier_block2 | ( | ) |
|
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 in gr_top_block.
|
friend |
|
friend |
public constructor for gr_hier_block2
pmt::pmt_t gr_hier_block2::hier_message_ports_in |
pmt::pmt_t gr_hier_block2::hier_message_ports_out |