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 | 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 () |
Protected Member Functions | |
| gr_hier_block2 (const std::string &name, gr_io_signature_sptr input_signature, gr_io_signature_sptr output_signature) | |
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 | |
Detailed Description
Hierarchical container class for gr_block's and gr_hier_block2's.
Member Typedef Documentation
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.
Constructor & Destructor Documentation
| gr_hier_block2::gr_hier_block2 | ( | const std::string & | name, |
| gr_io_signature_sptr | input_signature, | ||
| gr_io_signature_sptr | output_signature | ||
| ) | [protected] |
| virtual gr_hier_block2::~gr_hier_block2 | ( | ) | [virtual] |
Member Function Documentation
| 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 |
| virtual void gr_hier_block2::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., gr_block::work method) or deadlock will occur when reconfiguration happens.
Reimplemented in gr_top_block.
| 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 void gr_hier_block2::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., gr_block::work method) or deadlock will occur when reconfiguration happens.
Reimplemented in gr_top_block.
Friends And Related Function Documentation
friend class gr_hier_block2_detail [friend] |
| 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 | ||
| ) | [friend] |
public constructor for gr_hier_block2
The documentation for this class was generated from the following file:
