Hierarchical container class for gr::block's and gr::hier_block2's. More...

#include <hier_block2.h>

Inheritance diagram for gr::hier_block2:

Public Types
typedef basic_block_sptr	opaque_self
	typedef for object returned from self().
Public Member Functions
virtual	~hier_block2 ()
opaque_self	self ()
	Return an object, representing the current block, which can be passed to connect.
void	connect (basic_block_sptr block)
	Add a stand-alone (possibly hierarchical) block to internal graph.
void	connect (basic_block_sptr src, int src_port, basic_block_sptr dst, int dst_port)
	Add gr-blocks or hierarchical blocks to internal graph and wire together.
void	msg_connect (basic_block_sptr src, pmt::pmt_t srcport, basic_block_sptr dst, pmt::pmt_t dstport)
	Add gr-blocks or hierarchical blocks to internal graph and wire together.
void	msg_connect (basic_block_sptr src, std::string srcport, basic_block_sptr dst, std::string dstport)
void	msg_disconnect (basic_block_sptr src, pmt::pmt_t srcport, basic_block_sptr dst, pmt::pmt_t dstport)
void	msg_disconnect (basic_block_sptr src, std::string srcport, basic_block_sptr dst, std::string dstport)
void	disconnect (basic_block_sptr block)
	Remove a gr-block or hierarchical block from the internal flowgraph.
void	disconnect (basic_block_sptr src, int src_port, 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 ()
flat_flowgraph_sptr	flatten () const
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)
void	set_processor_affinity (const std::vector< int > &mask)
	Set the affinity of all blocks in hier_block2 to processor core `n`.
void	unset_processor_affinity ()
	Remove processor affinity for all blocks in hier_block2.
std::vector< int >	processor_affinity ()
	Get the current processor affinity.
Public Attributes
pmt::pmt_t	hier_message_ports_in
pmt::pmt_t	hier_message_ports_out
Protected Member Functions
	hier_block2 (void)
	hier_block2 (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
Friends
class	hier_block2_detail
GR_RUNTIME_API hier_block2_sptr	make_hier_block2 (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
	public constructor for hier_block2

Detailed Description

Hierarchical container class for gr::block's and gr::hier_block2's.

Member Typedef Documentation

typedef 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::hier_block2 ( void ) [inline, protected]

gr::hier_block2::hier_block2	(	const std::string &	name,
		gr::io_signature::sptr	input_signature,
		gr::io_signature::sptr	output_signature
	)		`[protected]`

virtual gr::hier_block2::~hier_block2 ( ) [virtual]

Member Function Documentation

void gr::hier_block2::connect ( 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	(	basic_block_sptr	src,
		int	src_port,
		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 ( 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	(	basic_block_sptr	src,
		int	src_port,
		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.

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().

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.

bool gr::hier_block2::message_port_is_hier_in ( pmt::pmt_t port_id ) [inline, virtual]

Reimplemented from gr::basic_block.

References 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::list_has().

void gr::hier_block2::message_port_register_hier_in ( pmt::pmt_t port_id ) [inline]

References pmt::list_add(), and pmt::list_has().

void gr::hier_block2::message_port_register_hier_out ( pmt::pmt_t port_id ) [inline]

References pmt::dict_has_key(), pmt::list_add(), and pmt::list_has().

void gr::hier_block2::msg_connect	(	basic_block_sptr	src,
		pmt::pmt_t	srcport,
		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	(	basic_block_sptr	src,
		std::string	srcport,
		basic_block_sptr	dst,
		std::string	dstport
	)

void gr::hier_block2::msg_disconnect	(	basic_block_sptr	src,
		pmt::pmt_t	srcport,
		basic_block_sptr	dst,
		pmt::pmt_t	dstport
	)

void gr::hier_block2::msg_disconnect	(	basic_block_sptr	src,
		std::string	srcport,
		basic_block_sptr	dst,
		std::string	dstport
	)

std::vector<int> gr::hier_block2::processor_affinity ( ) [virtual]

Get the current processor affinity.

This returns the processor affinity value for the first block in the hier_block2's list of blocks with the assumption that they have always only been set through the hier_block2's interface. If any block has been individually set, then this call could be misleading.

Reimplemented from gr::basic_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.

void gr::hier_block2::set_processor_affinity ( const std::vector< int > & mask ) [virtual]

Set the affinity of all blocks in hier_block2 to processor core n.

Parameters:

mask	a vector of ints of the core numbers available to this block.

Reimplemented from gr::basic_block.

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.

void gr::hier_block2::unset_processor_affinity ( ) [virtual]

Remove processor affinity for all blocks in hier_block2.

Reimplemented from gr::basic_block.

Friends And Related Function Documentation

friend class hier_block2_detail [friend]

GR_RUNTIME_API hier_block2_sptr make_hier_block2	(	const std::string &	name,
		gr::io_signature::sptr	input_signature,
		gr::io_signature::sptr	output_signature
	)		`[friend]`

public constructor for 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:

hier_block2.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation