gr_hier_block2 Class Reference

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	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)
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)
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 gr_basic_block_sptr gr_hier_block2::opaque_self

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

)

[inline, protected]

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

)

[inline, virtual]

Reimplemented from gr_basic_block.

References gr_basic_block::has_msg_port(), and gr_basic_block::message_port_is_hier().

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

)

[inline, virtual]

Reimplemented from gr_basic_block.

References gr_basic_block::message_port_is_hier_in(), and gr_basic_block::message_port_is_hier_out().

bool gr_hier_block2::message_port_is_hier_in

(

pmt::pmt_t

port_id

)

[inline, virtual]

Reimplemented from gr_basic_block.

References pmt::pmt_list_has().

bool gr_hier_block2::message_port_is_hier_out

(

pmt::pmt_t

port_id

)

[inline, virtual]

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]

References pmt::pmt_list_add(), and pmt::pmt_list_has().

void gr_hier_block2::message_port_register_hier_out

(

pmt::pmt_t

port_id

)

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

• gr_hier_block2.h