GNU Radio 3.6.1 C++ API

Hierarchical container class for gr_block's and gr_hier_block2's. More...

#include <gr_hier_block2.h>

Inheritance diagram for gr_hier_block2:

List of all members.

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 ()
- Public Member Functions inherited from gr_basic_block
virtual ~gr_basic_block ()
long unique_id () const
std::string name () const
gr_io_signature_sptr input_signature () const
gr_io_signature_sptr output_signature () const
gr_basic_block_sptr to_basic_block ()
virtual bool check_topology (int ninputs, int noutputs)
 Confirm that ninputs and noutputs is an acceptable combination.
template<typename T >
void set_msg_handler (T msg_handler)
 Set the callback that is fired when messages are available.
- Public Member Functions inherited from gr_msg_accepter
 gr_msg_accepter ()
 ~gr_msg_accepter ()
void post (pmt::pmt_t msg)
 send msg to msg_accepter
- Public Member Functions inherited from gruel::msg_accepter
 msg_accepter ()
virtual ~msg_accepter ()

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)
- Protected Member Functions inherited from gr_basic_block
 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

- 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
vcolor d_color

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 ( void  )
inlineprotected
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: