GNU Radio 3.6.4.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:
gr_basic_block gr_msg_accepter gruel::msg_accepter digital_cpmmod_bc fcd_source_c gr::filter::channel_model gr_channel_model gr_top_block digital_gmskmod_bc fcd_source_c_impl gr::filter::channel_model_impl

Public Types

typedef gr_basic_block_sptr opaque_self
 typedef for object returned from self(). More...
 

Public Member Functions

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...
 
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)
 
- Public Member Functions inherited from gr_basic_block
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...
 
- Public Member Functions inherited from gr_msg_accepter
 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...
 
- Public Member Functions inherited from gruel::msg_accepter
 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)
 
- 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. 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

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 More...
 

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

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
bool gr_hier_block2::has_msg_port ( pmt::pmt_t  which_port)
inlinevirtual
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.

bool gr_hier_block2::message_port_is_hier ( pmt::pmt_t  port_id)
inlinevirtual
bool gr_hier_block2::message_port_is_hier_in ( pmt::pmt_t  port_id)
inlinevirtual

Reimplemented from gr_basic_block.

References pmt::pmt_list_has().

bool gr_hier_block2::message_port_is_hier_out ( pmt::pmt_t  port_id)
inlinevirtual

Reimplemented from gr_basic_block.

References pmt::pmt_list_has().

void gr_hier_block2::message_port_register_hier_in ( pmt::pmt_t  port_id)
inline
void gr_hier_block2::message_port_register_hier_out ( pmt::pmt_t  port_id)
inline
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 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

Member Data Documentation

pmt::pmt_t gr_hier_block2::hier_message_ports_in
pmt::pmt_t gr_hier_block2::hier_message_ports_out

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